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

ListBlockingInstancesForCapacityTask

A list of Amazon EC2 instances running on the Outpost and belonging to the account that initiated the capacity task. Use this list to specify the instances you cannot stop to free up capacity to run the capacity task.

Request Syntax


GET /outposts/OutpostId/capacity/CapacityTaskId/blockingInstances?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CapacityTaskId

The ID of the capacity task.

Length Constraints: Fixed length of 21.

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

Required: Yes

MaxResults

The maximum page size.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

The pagination token.

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

Pattern: ^(\d+)##(\S+)$

OutpostId

The 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

{
   "BlockingInstances": [ 
      { 
         "AccountId": "string",
         "AwsServiceName": "string",
         "InstanceId": "string"
      }
   ],
   "NextToken": "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.

BlockingInstances

A list of all running Amazon EC2 instances on the Outpost. Stopping one or more of these instances can free up the capacity needed to run the capacity task.

Type: Array of BlockingInstance objects

NextToken

The pagination token.

Type: String

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

Pattern: ^(\d+)##(\S+)$

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