Outposts / Client / list_asset_instances

list_asset_instances

Outposts.Client.list_asset_instances(**kwargs)

A list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost. Does not include Amazon EBS or Amazon S3 instances.

See also: AWS API Documentation

Request Syntax

response = client.list_asset_instances(
    OutpostIdentifier='string',
    AssetIdFilter=[
        'string',
    ],
    InstanceTypeFilter=[
        'string',
    ],
    AccountIdFilter=[
        'string',
    ],
    AwsServiceFilter=[
        'AWS'|'EC2'|'ELASTICACHE'|'ELB'|'RDS'|'ROUTE53',
    ],
    MaxResults=123,
    NextToken='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) –

• MaxResults (integer) – The maximum page size.

• NextToken (string) – The pagination token.

Return type:

dict

Returns:

Response Syntax

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

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. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

      • AccountId (string) –

        The ID of the Amazon Web Services account.

      • AwsServiceName (string) –

        The Amazon Web Services service name of the instance.

  • NextToken (string) –

    The pagination token.

Exceptions

• Outposts.Client.exceptions.ValidationException

• Outposts.Client.exceptions.AccessDeniedException

• Outposts.Client.exceptions.NotFoundException

• Outposts.Client.exceptions.InternalServerException