Outposts / Client / get_capacity_task

get_capacity_task#

Outposts.Client.get_capacity_task(**kwargs)#

Gets details of the specified capacity task.

See also: AWS API Documentation

Request Syntax

response = client.get_capacity_task(
    CapacityTaskId='string',
    OutpostIdentifier='string'
)
Parameters:

  • CapacityTaskId (string) –

    [REQUIRED]

    ID of the capacity task.

  • OutpostIdentifier (string) –

    [REQUIRED]

    ID or ARN of the Outpost associated with the specified capacity task.

Return type:

dict

Returns:

Response Syntax

{
    'CapacityTaskId': 'string',
    'OutpostId': 'string',
    'OrderId': 'string',
    'RequestedInstancePools': [
        {
            'InstanceType': 'string',
            'Count': 123
        },
    ],
    'DryRun': True|False,
    'CapacityTaskStatus': 'REQUESTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'CANCELLED',
    'Failed': {
        'Reason': 'string',
        'Type': 'UNSUPPORTED_CAPACITY_CONFIGURATION'
    },
    'CreationDate': datetime(2015, 1, 1),
    'CompletionDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • CapacityTaskId (string) –

      ID of the capacity task.

    • OutpostId (string) –

      ID of the Outpost associated with the specified capacity task.

    • OrderId (string) –

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

    • RequestedInstancePools (list) –

      List of instance pools requested in the capacity task.

      • (dict) –

        The instance type that you specify determines the combination of CPU, memory, storage, and networking capacity.

        • InstanceType (string) –

          The instance type of the hosts.

        • Count (integer) –

          The number of instances for the specified instance type.

    • DryRun (boolean) –

      Performs a dry run to determine if you are above or below instance capacity.

    • CapacityTaskStatus (string) –

      Status of the capacity task.

      A capacity task can have one of the following statuses:

      • REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.

      • IN_PROGRESS - The capacity task is running and cannot be cancelled.

      • WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.

    • Failed (dict) –

      Reason why the capacity task failed.

      • Reason (string) –

        The reason that the specified capacity task failed.

      • Type (string) –

        The type of failure.

    • CreationDate (datetime) –

      The date the capacity task was created.

    • CompletionDate (datetime) –

      The date the capacity task ran successfully.

    • LastModifiedDate (datetime) –

      The date the capacity task was last modified.

Exceptions