ARCZonalShift / Client / cancel_practice_run

cancel_practice_run

ARCZonalShift.Client.cancel_practice_run(**kwargs)

Cancel an in-progress practice run zonal shift in Amazon Application Recovery Controller.

See also: AWS API Documentation

Request Syntax

response = client.cancel_practice_run(
    zonalShiftId='string'
)
Parameters:

zonalShiftId (string) –

[REQUIRED]

The identifier of a practice run zonal shift in Amazon Application Recovery Controller that you want to cancel.

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 the practice run zonal shift in Amazon Application Recovery Controller that was canceled.

    • resourceIdentifier (string) –

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

    • awayFrom (string) –

      The Availability Zone (for example, use1-az1) that traffic was moved away from for a resource that you specified 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 that you canceled (expected status is CANCELED).

      The Status for a practice run zonal shift can have one of the following values:

    • comment (string) –

      The initial comment that you entered 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