AWS API Changes

2025/03/31 - AWS Outposts - 4 updated api methods

Changes Enabling Asset Level Capacity Management feature, which allows customers to create a Capacity Task for a single Asset on their active Outpost.

GetCapacityTask (updated)

Link ¶
Changes (response)

{'AssetId': 'string'}

Gets details of the specified capacity task.

See also: AWS API Documentation

Request Syntax

client.get_capacity_task(
    CapacityTaskId='string',
    OutpostIdentifier='string'
)

type CapacityTaskId:

string

param CapacityTaskId:

[REQUIRED]

ID of the capacity task.

type OutpostIdentifier:

string

param OutpostIdentifier:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'CapacityTaskId': 'string',
    'OutpostId': 'string',
    'OrderId': 'string',
    'AssetId': 'string',
    'RequestedInstancePools': [
        {
            'InstanceType': 'string',
            'Count': 123
        },
    ],
    'InstancesToExclude': {
        'Instances': [
            'string',
        ],
        'AccountIds': [
            'string',
        ],
        'Services': [
            'AWS'|'EC2'|'ELASTICACHE'|'ELB'|'RDS'|'ROUTE53',
        ]
    },
    'DryRun': True|False,
    'CapacityTaskStatus': 'REQUESTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'WAITING_FOR_EVACUATION'|'CANCELLATION_IN_PROGRESS'|'CANCELLED',
    'Failed': {
        'Reason': 'string',
        'Type': 'UNSUPPORTED_CAPACITY_CONFIGURATION'|'UNEXPECTED_ASSET_STATE'|'BLOCKING_INSTANCES_NOT_EVACUATED'|'INTERNAL_SERVER_ERROR'|'RESOURCE_NOT_FOUND'
    },
    'CreationDate': datetime(2015, 1, 1),
    'CompletionDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'TaskActionOnBlockingInstances': 'WAIT_FOR_EVACUATION'|'FAIL_TASK'
}

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.
- AssetId (string) --
  
  The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
- 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.
- InstancesToExclude (dict) --
  
  Instances that the user specified they cannot stop in order to free up the capacity needed to run the capacity task.
  - Instances (list) --
    
    List of user-specified instances that must not be stopped.
    - (string) --
  - AccountIds (list) --
    
    IDs of the accounts that own each instance that must not be stopped.
    - (string) --
      
      The ID of the Amazon Web Services account.
  - Services (list) --
    
    Names of the services that own each instance that must not be stopped in order to free up the capacity needed to run the capacity task.
    - (string) --
- 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.
  - FAILED - The capacity task could not be completed.
  - COMPLETED - The capacity task has completed successfully.
  - 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.
  - CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.
  - CANCELLED - The capacity task is cancelled.
- 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.
- TaskActionOnBlockingInstances (string) --
  
  User-specified option in case an instance is blocking the capacity task from running. Shows one of the following options:
  - WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.
  - FAIL_TASK - The capacity task fails.

GetOutpostSupportedInstanceTypes (updated)

Link ¶
Changes (request)

{'AssetId': 'string'}

Gets the instance types that an Outpost can support in InstanceTypeCapacity. This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.

See also: AWS API Documentation

Request Syntax

client.get_outpost_supported_instance_types(
    OutpostIdentifier='string',
    OrderId='string',
    AssetId='string',
    MaxResults=123,
    NextToken='string'
)

type OutpostIdentifier:

string

param OutpostIdentifier:

[REQUIRED]

The ID or ARN of the Outpost.

type OrderId:

string

param OrderId:

The ID for the Amazon Web Services Outposts order.

type AssetId:

string

param AssetId:

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

type MaxResults:

integer

param MaxResults:

The maximum page size.

type NextToken:

string

param NextToken:

The pagination token.

rtype:

dict

returns:

Response Syntax

{
    'InstanceTypes': [
        {
            'InstanceType': 'string',
            'VCPUs': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- InstanceTypes (list) --
  
  Information about the instance types.
  - (dict) --
    
    Information about an instance type.
    - InstanceType (string) --
      
      The instance type.
    - VCPUs (integer) --
      
      The number of default VCPUs in an instance type.
- NextToken (string) --
  
  The pagination token.

ListCapacityTasks (updated)

Link ¶
Changes (response)

{'CapacityTasks': {'AssetId': 'string'}}

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

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

type OutpostIdentifierFilter:

string

param OutpostIdentifierFilter:

Filters the results by an Outpost ID or an Outpost ARN.

type MaxResults:

integer

param MaxResults:

The maximum page size.

type NextToken:

string

param NextToken:

The pagination token.

type CapacityTaskStatusFilter:

list

param CapacityTaskStatusFilter:

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

(string) --

rtype:

dict

returns:

Response Syntax

{
    'CapacityTasks': [
        {
            'CapacityTaskId': 'string',
            'OutpostId': 'string',
            'OrderId': 'string',
            'AssetId': '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.
    - AssetId (string) --
      
      The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
    - 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.

StartCapacityTask (updated)

Link ¶
Changes (both)

{'AssetId': 'string'}

Starts the specified capacity task. You can have one active capacity task for each order and each Outpost.

See also: AWS API Documentation

Request Syntax

client.start_capacity_task(
    OutpostIdentifier='string',
    OrderId='string',
    AssetId='string',
    InstancePools=[
        {
            'InstanceType': 'string',
            'Count': 123
        },
    ],
    InstancesToExclude={
        'Instances': [
            'string',
        ],
        'AccountIds': [
            'string',
        ],
        'Services': [
            'AWS'|'EC2'|'ELASTICACHE'|'ELB'|'RDS'|'ROUTE53',
        ]
    },
    DryRun=True|False,
    TaskActionOnBlockingInstances='WAIT_FOR_EVACUATION'|'FAIL_TASK'
)

type OutpostIdentifier:

string

param OutpostIdentifier:

[REQUIRED]

The ID or ARN of the Outposts associated with the specified capacity task.

type OrderId:

string

param OrderId:

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

type AssetId:

string

param AssetId:

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

type InstancePools:

list

param InstancePools:

[REQUIRED]

The instance pools specified in the capacity task.

(dict) --

The instance type that you specify determines the combination of CPU, memory, storage, and networking capacity.
- InstanceType (string) -- [REQUIRED]
  
  The instance type of the hosts.
- Count (integer) -- [REQUIRED]
  
  The number of instances for the specified instance type.

type InstancesToExclude:

dict

param InstancesToExclude:

List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.

Instances (list) --

List of user-specified instances that must not be stopped.
- (string) --
AccountIds (list) --

IDs of the accounts that own each instance that must not be stopped.
- (string) --
  
  The ID of the Amazon Web Services account.
Services (list) --

Names of the services that own each instance that must not be stopped in order to free up the capacity needed to run the capacity task.
- (string) --

type DryRun:

boolean

param DryRun:

You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.

type TaskActionOnBlockingInstances:

string

param TaskActionOnBlockingInstances:

Specify one of the following options in case an instance is blocking the capacity task from running.

WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.
FAIL_TASK - The capacity task fails.

rtype:

dict

returns:

Response Syntax

{
    'CapacityTaskId': 'string',
    'OutpostId': 'string',
    'OrderId': 'string',
    'AssetId': 'string',
    'RequestedInstancePools': [
        {
            'InstanceType': 'string',
            'Count': 123
        },
    ],
    'InstancesToExclude': {
        'Instances': [
            'string',
        ],
        'AccountIds': [
            'string',
        ],
        'Services': [
            'AWS'|'EC2'|'ELASTICACHE'|'ELB'|'RDS'|'ROUTE53',
        ]
    },
    'DryRun': True|False,
    'CapacityTaskStatus': 'REQUESTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'WAITING_FOR_EVACUATION'|'CANCELLATION_IN_PROGRESS'|'CANCELLED',
    'Failed': {
        'Reason': 'string',
        'Type': 'UNSUPPORTED_CAPACITY_CONFIGURATION'|'UNEXPECTED_ASSET_STATE'|'BLOCKING_INSTANCES_NOT_EVACUATED'|'INTERNAL_SERVER_ERROR'|'RESOURCE_NOT_FOUND'
    },
    'CreationDate': datetime(2015, 1, 1),
    'CompletionDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'TaskActionOnBlockingInstances': 'WAIT_FOR_EVACUATION'|'FAIL_TASK'
}

Response Structure

(dict) --
- CapacityTaskId (string) --
  
  ID of the capacity task that you want to start.
- OutpostId (string) --
  
  ID of the Outpost associated with the capacity task.
- OrderId (string) --
  
  ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
- AssetId (string) --
  
  The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
- RequestedInstancePools (list) --
  
  List of the instance pools requested in the specified 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.
- InstancesToExclude (dict) --
  
  User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.
  - Instances (list) --
    
    List of user-specified instances that must not be stopped.
    - (string) --
  - AccountIds (list) --
    
    IDs of the accounts that own each instance that must not be stopped.
    - (string) --
      
      The ID of the Amazon Web Services account.
  - Services (list) --
    
    Names of the services that own each instance that must not be stopped in order to free up the capacity needed to run the capacity task.
    - (string) --
- DryRun (boolean) --
  
  Results of the dry run showing if the specified capacity task is above or below the available instance capacity.
- CapacityTaskStatus (string) --
  
  Status of the specified capacity task.
- Failed (dict) --
  
  Reason that the specified capacity task failed.
  - Reason (string) --
    
    The reason that the specified capacity task failed.
  - Type (string) --
    
    The type of failure.
- CreationDate (datetime) --
  
  Date that the specified capacity task was created.
- CompletionDate (datetime) --
  
  Date that the specified capacity task ran successfully.
- LastModifiedDate (datetime) --
  
  Date that the specified capacity task was last modified.
- TaskActionOnBlockingInstances (string) --
  
  User-specified option in case an instance is blocking the capacity task from running.
  - WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.
  - FAIL_TASK - The capacity task fails.