ControlTower / Client / get_landing_zone_operation
get_landing_zone_operation#
- ControlTower.Client.get_landing_zone_operation(**kwargs)#
Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
See also: AWS API Documentation
Request Syntax
response = client.get_landing_zone_operation( operationIdentifier='string' )
- Parameters:
operationIdentifier (string) –
[REQUIRED]
A unique identifier assigned to a landing zone operation.
- Return type:
dict
- Returns:
Response Syntax
{ 'operationDetails': { 'endTime': datetime(2015, 1, 1), 'operationIdentifier': 'string', 'operationType': 'DELETE'|'CREATE'|'UPDATE'|'RESET', 'startTime': datetime(2015, 1, 1), 'status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS', 'statusMessage': 'string' } }
Response Structure
(dict) –
operationDetails (dict) –
Details about a landing zone operation.
endTime (datetime) –
The landing zone operation end time.
operationIdentifier (string) –
The
operationIdentifier
of the landing zone operation.operationType (string) –
The landing zone operation type.
Valid values:
DELETE
: TheDeleteLandingZone
operation.CREATE
: TheCreateLandingZone
operation.UPDATE
: TheUpdateLandingZone
operation.RESET
: TheResetLandingZone
operation.
startTime (datetime) –
The landing zone operation start time.
status (string) –
Valid values:
SUCCEEDED
: The landing zone operation succeeded.IN_PROGRESS
: The landing zone operation is in progress.FAILED
: The landing zone operation failed.
statusMessage (string) –
If the operation result is FAILED, this string contains a message explaining why the operation failed.
Exceptions
ControlTower.Client.exceptions.ValidationException
ControlTower.Client.exceptions.InternalServerException
ControlTower.Client.exceptions.AccessDeniedException
ControlTower.Client.exceptions.ThrottlingException
ControlTower.Client.exceptions.ResourceNotFoundException