View a markdown version of this page

ListCapacityReservations - Amazon SageMaker

ListCapacityReservations

Lists the SageMaker Capacity Reservations in your account.

An empty list is a valid response.

Request Syntax

{ "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

A filter that returns only the reservations that match it. You can specify one filter. If you don't specify a filter, the response includes all reservations in your account.

Type: Array of CapacityReservationFilter objects

Array Members: Fixed number of 1 item.

Required: No

MaxResults

The maximum number of results to return in the response. If more results are available, the response includes a NextToken value.

Type: Integer

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

Required: No

NextToken

If the previous response was truncated, the response includes a NextToken value. To retrieve the next set of results, use that token in your next request.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

Response Syntax

{ "CapacityReservationSummaries": [ { "AvailabilityZone": "string", "AvailabilityZoneId": "string", "CreationTime": number, "EndTime": number, "InstanceType": "string", "Owner": "string", "SMCapacityReservationArn": "string", "SMCapacityReservationId": "string", "StartTime": number, "Status": "string", "TotalInstanceCount": number } ], "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.

CapacityReservationSummaries

Summaries of the SageMaker Capacity Reservations in your account.

Type: Array of CapacityReservationSummary objects

NextToken

If the response is truncated, SageMaker AI returns this token. To retrieve the next set of results, use this token in your next request.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Errors

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: