Outposts / Client / list_assets

list_assets

Outposts.Client.list_assets(**kwargs)

Lists the hardware assets for the specified Outpost.

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_assets(
    OutpostIdentifier='string',
    HostIdFilter=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    StatusFilter=[
        'ACTIVE'|'RETIRING'|'ISOLATED',
    ]
)

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) –

• MaxResults (integer) – The maximum page size.

• NextToken (string) – The pagination token.

• StatusFilter (list) –

  Filters the results by state.

  • (string) –

Return type:

dict

Returns:

Response Syntax

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

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) –

        • InstanceTypeCapacities (list) –

          The instance type capacities configured for this asset. This can be changed through a capacity task.

          • (dict) –

            The capacity for each instance type.

            • InstanceType (string) –

              The type of instance.

            • Count (integer) –

              The number of each instance type.

        • MaxVcpus (integer) –

          The maximum number of vCPUs possible for the specified asset.

      • AssetLocation (dict) –

        The position of an asset in a rack.

        • RackElevation (float) –

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

  • NextToken (string) –

    The pagination token.

Exceptions

• Outposts.Client.exceptions.ValidationException

• Outposts.Client.exceptions.AccessDeniedException

• Outposts.Client.exceptions.NotFoundException

• Outposts.Client.exceptions.InternalServerException