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 an order.

Request Syntax


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

{
   "DryRun": boolean,
   "InstancePools": [ 
      { 
         "Count": number,
         "InstanceType": "string"
      }
   ],
   "OrderId": "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

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

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"
   },
   "LastModifiedDate": number,
   "OrderId": "string",
   "OutpostId": "string",
   "RequestedInstancePools": [ 
      { 
         "Count": number,
         "InstanceType": "string"
      }
   ]
}