AWS Control Tower

Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.

See also: AWS API Documentation

Request Syntax

client.list_landing_zone_operations(
    filter={
        'statuses': [
            'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
        ],
        'types': [
            'DELETE'|'CREATE'|'UPDATE'|'RESET',
        ]
    },
    maxResults=123,
    nextToken='string'
)

type filter

dict

param filter

An input filter for the ListLandingZoneOperations API that lets you select the types of landing zone operations to view.

• statuses (list) --

  The statuses of the set of landing zone operations selected by the filter.

  • (string) --

• types (list) --

  The set of landing zone operation types selected by the filter.

  • (string) --

type maxResults

integer

param maxResults

How many results to return per API call.

type nextToken

string

param nextToken

The token to continue the list from a previous API call with the same parameters.

rtype

dict

returns

Response Syntax

{
    'landingZoneOperations': [
        {
            'operationIdentifier': 'string',
            'operationType': 'DELETE'|'CREATE'|'UPDATE'|'RESET',
            'status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • landingZoneOperations (list) --

    Lists landing zone operations.

    • (dict) --

      Returns a summary of information about a landing zone operation.

      • operationIdentifier (string) --

        The operationIdentifier of the landing zone operation.

      • operationType (string) --

        The type of the landing zone operation.

      • status (string) --

        The status of the landing zone operation.

  • nextToken (string) --

    Retrieves the next page of results. If the string is empty, the response is the end of the results.

{'operationDetails': {'operationIdentifier': 'string'}}

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

client.get_landing_zone_operation(
    operationIdentifier='string'
)

type operationIdentifier

string

param operationIdentifier

[REQUIRED]

A unique identifier assigned to a landing zone operation.

rtype

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 : The DeleteLandingZone operation.

      • CREATE : The CreateLandingZone operation.

      • UPDATE : The UpdateLandingZone operation.

      • RESET : The ResetLandingZone 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.