Outposts / Paginator / ListAssetInstances

ListAssetInstances

class Outposts.Paginator.ListAssetInstances

paginator = client.get_paginator('list_asset_instances')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OutpostIdentifier='string',
    AssetIdFilter=[
        'string',
    ],
    InstanceTypeFilter=[
        'string',
    ],
    AccountIdFilter=[
        'string',
    ],
    AwsServiceFilter=[
        'AWS'|'EC2'|'ELASTICACHE'|'ELB'|'RDS'|'ROUTE53',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OutpostIdentifier (string) –

  [REQUIRED]

  The ID of the Outpost.

• AssetIdFilter (list) –

  Filters the results by asset ID.

  • (string) –

• InstanceTypeFilter (list) –

  Filters the results by instance ID.

  • (string) –

• AccountIdFilter (list) –

  Filters the results by account ID.

  • (string) –

    The ID of the Amazon Web Services account.

• AwsServiceFilter (list) –

  Filters the results by Amazon Web Services service.

  • (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

{
    'AssetInstances': [
        {
            'InstanceId': 'string',
            'InstanceType': 'string',
            'AssetId': 'string',
            'AccountId': 'string',
            'AwsServiceName': 'AWS'|'EC2'|'ELASTICACHE'|'ELB'|'RDS'|'ROUTE53'
        },
    ],

}

Response Structure

• (dict) –

  • AssetInstances (list) –

    List of instances owned by all accounts on the Outpost. Does not include Amazon EBS or Amazon S3 instances.

    • (dict) –

      An Amazon EC2 instance.

      • InstanceId (string) –

        The ID of the instance.

      • InstanceType (string) –

        The type of instance.

      • AssetId (string) –

        The ID of the asset.

      • AccountId (string) –

        The ID of the Amazon Web Services account.

      • AwsServiceName (string) –

        The Amazon Web Services service name of the instance.