ARCZonalShift / Client / update_practice_run_configuration

update_practice_run_configuration#

ARCZonalShift.Client.update_practice_run_configuration(**kwargs)#

Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.

Request Syntax

response = client.update_practice_run_configuration(
    blockedDates=[
        'string',
    ],
    blockedWindows=[
        'string',
    ],
    blockingAlarms=[
        {
            'alarmIdentifier': 'string',
            'type': 'CLOUDWATCH'
        },
    ],
    outcomeAlarms=[
        {
            'alarmIdentifier': 'string',
            'type': 'CLOUDWATCH'
        },
    ],
    resourceIdentifier='string'
)

Parameters:

blockedDates (list) –
Add, change, or remove blocked dates for a practice run in zonal autoshift.

Optionally, you can block practice runs for specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.

For example, if you have an application update scheduled to launch on May 1, 2024, and you don’t want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.
- (string) –
blockedWindows (list) –
Add, change, or remove windows of days and times for when you can, optionally, block Route 53 ARC from starting a practice run for a resource.

The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.

For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
- (string) –
blockingAlarms (list) –
Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs.
- (dict) –
  
  A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting or to interrupt a practice run in progress.
  
  Control condition alarms do not apply for autoshifts.
  
  For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
  - alarmIdentifier (string) – [REQUIRED]
    
    The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
  - type (string) – [REQUIRED]
    
    The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.
outcomeAlarms (list) –
Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs.
- (dict) –
  
  A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting or to interrupt a practice run in progress.
  
  Control condition alarms do not apply for autoshifts.
  
  For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
  - alarmIdentifier (string) – [REQUIRED]
    
    The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
  - type (string) – [REQUIRED]
    
    The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.
resourceIdentifier (string) –
[REQUIRED]

The identifier for the resource that you want to update the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'name': 'string',
    'practiceRunConfiguration': {
        'blockedDates': [
            'string',
        ],
        'blockedWindows': [
            'string',
        ],
        'blockingAlarms': [
            {
                'alarmIdentifier': 'string',
                'type': 'CLOUDWATCH'
            },
        ],
        'outcomeAlarms': [
            {
                'alarmIdentifier': 'string',
                'type': 'CLOUDWATCH'
            },
        ]
    },
    'zonalAutoshiftStatus': 'ENABLED'|'DISABLED'
}

Response Structure

(dict) –
- arn (string) –
  
  The Amazon Resource Name (ARN) of the resource that you updated the practice run for.
- name (string) –
  
  The name of the resource that you updated the practice run for.
- practiceRunConfiguration (dict) –
  
  The practice run configuration that was updated.
  - blockedDates (list) –
    
    An array of one or more dates that you can specify when Amazon Web Services does not start practice runs for a resource.
    
    Specify blocked dates, in UTC, in the format YYYY-MM-DD, separated by spaces.
    - (string) –
  - blockedWindows (list) –
    
    An array of one or more windows of days and times that you can block Route 53 ARC from starting practice runs for a resource.
    
    Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.
    - (string) –
  - blockingAlarms (list) –
    
    The blocking alarm for practice runs is an optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.
    - (dict) –
      
      A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting or to interrupt a practice run in progress.
      
      Control condition alarms do not apply for autoshifts.
      
      For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
      - alarmIdentifier (string) –
        
        The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
      - type (string) –
        
        The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.
  - outcomeAlarms (list) –
    
    The outcome alarm for practice runs is an alarm that you specify that ends a practice run when the alarm is in an ALARM state.
    - (dict) –
      
      A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting or to interrupt a practice run in progress.
      
      Control condition alarms do not apply for autoshifts.
      
      For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
      - alarmIdentifier (string) –
        
        The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
      - type (string) –
        
        The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.
- zonalAutoshiftStatus (string) –
  
  The zonal autoshift status for the resource that you updated the practice run for.

Exceptions

ARCZonalShift.Client.exceptions.InternalServerException
ARCZonalShift.Client.exceptions.ConflictException
ARCZonalShift.Client.exceptions.ResourceNotFoundException
ARCZonalShift.Client.exceptions.ThrottlingException
ARCZonalShift.Client.exceptions.ValidationException
ARCZonalShift.Client.exceptions.AccessDeniedException