ListCatalogItemsCommand

Suggest an Edit

Lists the items in the catalog.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { OutpostsClient, ListCatalogItemsCommand } from "@aws-sdk/client-outposts"; // ES Modules import
// const { OutpostsClient, ListCatalogItemsCommand } = require("@aws-sdk/client-outposts"); // CommonJS import
const client = new OutpostsClient(config);
const input = { // ListCatalogItemsInput
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  ItemClassFilter: [ // CatalogItemClassList
    "RACK" || "SERVER",
  ],
  SupportedStorageFilter: [ // SupportedStorageList
    "EBS" || "S3",
  ],
  EC2FamilyFilter: [ // EC2FamilyList
    "STRING_VALUE",
  ],
};
const command = new ListCatalogItemsCommand(input);
const response = await client.send(command);
// { // ListCatalogItemsOutput
//   CatalogItems: [ // CatalogItemListDefinition
//     { // CatalogItem
//       CatalogItemId: "STRING_VALUE",
//       ItemStatus: "AVAILABLE" || "DISCONTINUED",
//       EC2Capacities: [ // EC2CapacityListDefinition
//         { // EC2Capacity
//           Family: "STRING_VALUE",
//           MaxSize: "STRING_VALUE",
//           Quantity: "STRING_VALUE",
//         },
//       ],
//       PowerKva: Number("float"),
//       WeightLbs: Number("int"),
//       SupportedUplinkGbps: [ // SupportedUplinkGbpsListDefinition
//         Number("int"),
//       ],
//       SupportedStorage: [ // SupportedStorageList
//         "EBS" || "S3",
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListCatalogItemsCommand Input

See ListCatalogItemsCommandInput for more details

Parameter
Type
Description
EC2FamilyFilter
string[] | undefined

Filters the results by EC2 family (for example, M5).

ItemClassFilter
CatalogItemClass[] | undefined

Filters the results by item class.

MaxResults
number | undefined

The maximum page size.

NextToken
string | undefined

The pagination token.

SupportedStorageFilter
SupportedStorageEnum[] | undefined

Filters the results by storage option.

ListCatalogItemsCommand Output

See ListCatalogItemsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CatalogItems
CatalogItem[] | undefined

Information about the catalog items.

NextToken
string | undefined

The pagination token.

Throws

Name
Fault
Details
InternalServerException
server

An internal error has occurred.

NotFoundException
client

The specified request is not valid.

ValidationException
client

A parameter is not valid.

OutpostsServiceException
Base exception class for all service exceptions from Outposts service.