Outposts / Paginator / ListAssets

ListAssets

class Outposts.Paginator.ListAssets

paginator = client.get_paginator('list_assets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Outposts.Client.list_assets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OutpostIdentifier='string',
    HostIdFilter=[
        'string',
    ],
    StatusFilter=[
        'ACTIVE'|'RETIRING'|'ISOLATED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OutpostIdentifier (string) –

  [REQUIRED]

  The ID or the Amazon Resource Name (ARN) of the Outpost.

• HostIdFilter (list) –

  Filters the results by the host ID of a Dedicated Host.

  • (string) –

• StatusFilter (list) –

  Filters the results by state.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Assets': [
        {
            'AssetId': 'string',
            'RackId': 'string',
            'AssetType': 'COMPUTE',
            'ComputeAttributes': {
                'HostId': 'string',
                'State': 'ACTIVE'|'ISOLATED'|'RETIRING',
                'InstanceFamilies': [
                    'string',
                ]
            },
            'AssetLocation': {
                'RackElevation': ...
            }
        },
    ],

}

Response Structure

• (dict) –

  • Assets (list) –

    Information about the hardware assets.

    • (dict) –

      Information about hardware assets.

      • AssetId (string) –

        The ID of the asset.

      • RackId (string) –

        The rack ID of the asset.

      • AssetType (string) –

        The type of the asset.

      • ComputeAttributes (dict) –

        Information about compute hardware assets.

        • HostId (string) –

          The host ID of the Dedicated Host on the asset.

        • State (string) –

          The state.

          • ACTIVE - The asset is available and can provide capacity for new compute resources.

          • ISOLATED - The asset is undergoing maintenance and can’t provide capacity for new compute resources. Existing compute resources on the asset are not affected.

          • RETIRING - The underlying hardware for the asset is degraded. Capacity for new compute resources is reduced. Amazon Web Services sends notifications for resources that must be stopped before the asset can be replaced.

        • InstanceFamilies (list) –

          A list of the names of instance families that are currently associated with a given asset.

          • (string) –

      • AssetLocation (dict) –

        The position of an asset in a rack.

        • RackElevation (float) –

          The position of an asset in a rack measured in rack units.