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

StartCapacityTask

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

Request Syntax


POST /outposts/OutpostId/capacity HTTP/1.1
Content-type: application/json

{
   "DryRun": boolean,
   "InstancePools": [ 
      { 
         "Count": number,
         "InstanceType": "string"
      }
   ],
   "InstancesToExclude": { 
      "AccountIds": [ "string" ],
      "Instances": [ "string" ],
      "Services": [ "string" ]
   },
   "OrderId": "string",
   "TaskActionOnBlockingInstances": "string"
}

URI Request Parameters

The request uses the following URI parameters.

OutpostId

The ID or ARN of the Outposts 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 accepts the following data in JSON format.

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: Boolean

Required: No

InstancePools

The instance pools specified in the capacity task.

Type: Array of InstanceTypeCapacity objects

Required: Yes

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.

Type: InstancesToExclude object

Required: No

OrderId

The 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}$

Required: No

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.

Type: String

Valid Values: WAIT_FOR_EVACUATION | FAIL_TASK

Required: No

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 that you want to start.

Type: String

Length Constraints: Fixed length of 21.

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

CapacityTaskStatus

Status of the specified capacity task.

Type: String

CompletionDate

Date that the specified capacity task ran successfully.

Type: Timestamp

CreationDate

Date that the specified capacity task was created.

Type: Timestamp

DryRun

Results of the dry run showing if the specified capacity task is above or below the available instance capacity.

Type: Boolean

Failed

Reason that the specified capacity task failed.

Type: CapacityTaskFailure object

InstancesToExclude

User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.

Type: InstancesToExclude object

LastModifiedDate

Date that the specified capacity task was last modified.

Type: Timestamp

OrderId

ID of the AWS Outposts order of the host associated with the 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 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 the instance pools requested in the specified capacity task.

Type: Array of InstanceTypeCapacity objects

TaskActionOnBlockingInstances

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.

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

ConflictException

Updating or deleting this resource can cause an inconsistent state.

HTTP Status Code: 409

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