Outposts / Client / list_capacity_tasks

list_capacity_tasks#

Outposts.Client.list_capacity_tasks(**kwargs)#

Lists the capacity tasks for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

See also: AWS API Documentation

Request Syntax

response = client.list_capacity_tasks(
    OutpostIdentifierFilter='string',
    MaxResults=123,
    NextToken='string',
    CapacityTaskStatusFilter=[
        'REQUESTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'WAITING_FOR_EVACUATION'|'CANCELLATION_IN_PROGRESS'|'CANCELLED',
    ]
)
Parameters:

  • OutpostIdentifierFilter (string) – Filters the results by an Outpost ID or an Outpost ARN.

  • MaxResults (integer) – The maximum page size.

  • NextToken (string) – The pagination token.

  • CapacityTaskStatusFilter (list) –

    A list of statuses. For example, REQUESTED or WAITING_FOR_EVACUATION.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'CapacityTasks': [
        {
            'CapacityTaskId': 'string',
            'OutpostId': 'string',
            'OrderId': 'string',
            'CapacityTaskStatus': 'REQUESTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'WAITING_FOR_EVACUATION'|'CANCELLATION_IN_PROGRESS'|'CANCELLED',
            'CreationDate': datetime(2015, 1, 1),
            'CompletionDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • CapacityTasks (list) –

      Lists all the capacity tasks.

      • (dict) –

        The summary of the capacity task.

        • CapacityTaskId (string) –

          The ID of the specified capacity task.

        • OutpostId (string) –

          The ID of the Outpost associated with the specified capacity task.

        • OrderId (string) –

          The ID of the Amazon Web Services Outposts order of the host associated with the capacity task.

        • CapacityTaskStatus (string) –

          The status of the capacity task.

        • CreationDate (datetime) –

          The date that the specified capacity task was created.

        • CompletionDate (datetime) –

          The date that the specified capacity task successfully ran.

        • LastModifiedDate (datetime) –

          The date that the specified capacity was last modified.

    • NextToken (string) –

      The pagination token.

Exceptions

  • Outposts.Client.exceptions.ValidationException

  • Outposts.Client.exceptions.AccessDeniedException

  • Outposts.Client.exceptions.NotFoundException

  • Outposts.Client.exceptions.InternalServerException