Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetCapacityTask

Gets details of the specified capacity task.

Request Syntax


GET /outposts/OutpostId/capacity/CapacityTaskId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CapacityTaskId

ID of the capacity task.

Length Constraints: Fixed length of 21.

Pattern: ^cap-[a-f0-9]{17}$

Required: Yes

OutpostId

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

Length Constraints: Minimum length of 1. Maximum length of 180.

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CapacityTaskId": "string",
   "CapacityTaskStatus": "string",
   "CompletionDate": number,
   "CreationDate": number,
   "DryRun": boolean,
   "Failed": { 
      "Reason": "string",
      "Type": "string"
   },
   "InstancesToExclude": { 
      "AccountIds": [ "string" ],
      "Instances": [ "string" ],
      "Services": [ "string" ]
   },
   "LastModifiedDate": number,
   "OrderId": "string",
   "OutpostId": "string",
   "RequestedInstancePools": [ 
      { 
         "Count": number,
         "InstanceType": "string"
      }
   ],
   "TaskActionOnBlockingInstances": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CapacityTaskId

ID of the capacity task.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^cap-[a-f0-9]{17}$

CapacityTaskStatus

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 AWS 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.

Type: String

CompletionDate

The date the capacity task ran successfully.

Type: Timestamp

CreationDate

The date the capacity task was created.

Type: Timestamp

DryRun

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

Type: Boolean

Failed

Reason why the capacity task failed.

Type: CapacityTaskFailure object

InstancesToExclude

Instances that the user specified they cannot stop in order to free up the capacity needed to run the capacity task.

Type: InstancesToExclude object

LastModifiedDate

The date the capacity task was last modified.

Type: Timestamp

OrderId

ID of the AWS Outposts order associated with the specified capacity task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: oo-[a-f0-9]{17}$

OutpostId

ID of the Outpost associated with the specified capacity task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 180.

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$

RequestedInstancePools

List of instance pools requested in the capacity task.

Type: Array of InstanceTypeCapacity objects

TaskActionOnBlockingInstances

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.

Type: String

Valid Values: WAIT_FOR_EVACUATION | FAIL_TASK

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have permission to perform this operation.

HTTP Status Code: 403

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

NotFoundException

The specified request is not valid.

HTTP Status Code: 404

ValidationException

A parameter is not valid.

HTTP Status Code: 400