Outposts / Client / list_catalog_items

list_catalog_items#

Outposts.Client.list_catalog_items(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_catalog_items(
    NextToken='string',
    MaxResults=123,
    ItemClassFilter=[
        'RACK'|'SERVER',
    ],
    SupportedStorageFilter=[
        'EBS'|'S3',
    ],
    EC2FamilyFilter=[
        'string',
    ]
)
Parameters:

  • NextToken (string) – The pagination token.

  • MaxResults (integer) – The maximum page size.

  • ItemClassFilter (list) –

    Filters the results by item class.

    • (string) –

  • SupportedStorageFilter (list) –

    Filters the results by storage option.

    • (string) –

  • EC2FamilyFilter (list) –

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

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'CatalogItems': [
        {
            'CatalogItemId': 'string',
            'ItemStatus': 'AVAILABLE'|'DISCONTINUED',
            'EC2Capacities': [
                {
                    'Family': 'string',
                    'MaxSize': 'string',
                    'Quantity': 'string'
                },
            ],
            'PowerKva': ...,
            'WeightLbs': 123,
            'SupportedUplinkGbps': [
                123,
            ],
            'SupportedStorage': [
                'EBS'|'S3',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • CatalogItems (list) –

      Information about the catalog items.

      • (dict) –

        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.

          • (dict) –

            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.

Exceptions

  • Outposts.Client.exceptions.ValidationException

  • Outposts.Client.exceptions.NotFoundException

  • Outposts.Client.exceptions.InternalServerException