ListCatalogItems - AWS Outposts

ListCatalogItems

Lists the items in the catalog. Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family.

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

Request Syntax

GET /catalog/items?EC2FamilyFilter=EC2FamilyFilter&ItemClassFilter=ItemClassFilter&MaxResults=MaxResults&NextToken=NextToken&SupportedStorageFilter=SupportedStorageFilter HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EC2FamilyFilter

A filter for EC2 family options for items in the catalog.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

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

Pattern: [a-z0-9]+

ItemClassFilter

A filter for the class of items in the catalog.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

Valid Values: RACK | SERVER

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

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

SupportedStorageFilter

A filter for the storage options of items in the catalog.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

Valid Values: EBS | S3

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CatalogItems": [ { "CatalogItemId": "string", "EC2Capacities": [ { "Family": "string", "MaxSize": "string", "Quantity": "string" } ], "ItemStatus": "string", "PowerKva": number, "SupportedStorage": [ "string" ], "SupportedUplinkGbps": [ number ], "WeightLbs": 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.

CatalogItems

Information about the catalog items.

Type: Array of CatalogItem objects

NextToken

The pagination token.

Type: String

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

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

Errors

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

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

See Also

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