[ aws . outposts ]

list-catalog-items

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-catalog-items
[--next-token <value>]
[--max-results <value>]
[--item-class-filter <value>]
[--supported-storage-filter <value>]
[--ec2-family-filter <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

The pagination token.

--max-results (integer)

The maximum page size.

--item-class-filter (list)

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.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  RACK
  SERVER

--supported-storage-filter (list)

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.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  EBS
  S3

--ec2-family-filter (list)

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.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

CatalogItems -> (list)

Information about the catalog items.

(structure)

Information about a catalog item.

CatalogItemId -> (string)

The ID of the catalog item.

ItemStatus -> (string)

The status of a catalog item.

EC2Capacities -> (list)

Information about the EC2 capacity of an item.

(structure)

Information about EC2 capacity.

Family -> (string)

The family of the EC2 capacity.

MaxSize -> (string)

The maximum size of the EC2 capacity.

Quantity -> (string)

The quantity of the EC2 capacity.

PowerKva -> (float)

Information about the power draw of an item.

WeightLbs -> (integer)

The weight of the item in pounds.

SupportedUplinkGbps -> (list)

The uplink speed this catalog item requires for the connection to the Region.

(integer)

SupportedStorage -> (list)

The supported storage options for the catalog item.

(string)

NextToken -> (string)

The pagination token.