ARCZonalShift / Client / start_practice_run

start_practice_run

ARCZonalShift.Client.start_practice_run(**kwargs)

Start an on-demand practice run zonal shift in Amazon Application Recovery Controller. With zonal autoshift enabled, you can start an on-demand practice run to verify preparedness at any time. Amazon Web Services also runs automated practice runs about weekly when you have enabled zonal autoshift.

For more information, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.start_practice_run(
    resourceIdentifier='string',
    awayFrom='string',
    comment='string'
)
Parameters:

  • resourceIdentifier (string) –

    [REQUIRED]

    The identifier for the resource that you want to start a practice run zonal shift for. The identifier is the Amazon Resource Name (ARN) for the resource.

  • awayFrom (string) –

    [REQUIRED]

    The Availability Zone (for example, use1-az1) that traffic is shifted away from for the resource that you specify for the practice run.

  • comment (string) –

    [REQUIRED]

    The initial comment that you enter about the practice run. Be aware that this comment can be overwritten by Amazon Web Services if the automatic check for balanced capacity fails. For more information, see Capacity checks for practice runs in the Amazon Application Recovery Controller Developer Guide.

Return type:

dict

Returns:

Response Syntax

{
    'zonalShiftId': 'string',
    'resourceIdentifier': 'string',
    'awayFrom': 'string',
    'expiryTime': datetime(2015, 1, 1),
    'startTime': datetime(2015, 1, 1),
    'status': 'ACTIVE'|'EXPIRED'|'CANCELED',
    'comment': 'string'
}

Response Structure

  • (dict) –

    • zonalShiftId (string) –

      The identifier of a practice run zonal shift.

    • resourceIdentifier (string) –

      The identifier for the resource that you want to shift traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

    • awayFrom (string) –

      The Availability Zone (for example, use1-az1) that traffic is shifted away from for the resource that you specify for the practice run.

    • expiryTime (datetime) –

      The expiry time (expiration time) for an on-demand practice run zonal shift is 30 minutes from the time when you start the practice run, unless you cancel it before that time. However, be aware that the expiryTime field for practice run zonal shifts always has a value of 1 minute.

    • startTime (datetime) –

      The time (UTC) when the zonal shift starts.

    • status (string) –

      A status for the practice run (expected status is ACTIVE).

    • comment (string) –

      The initial comment that you enter about the practice run. Be aware that this comment can be overwritten by Amazon Web Services if the automatic check for balanced capacity fails. For more information, see Capacity checks for practice runs in the Amazon Application Recovery Controller Developer Guide.

Exceptions