SupplyChain / Paginator / ListInstances

ListInstances

class SupplyChain.Paginator.ListInstances

paginator = client.get_paginator('list_instances')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SupplyChain.Client.list_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    instanceNameFilter=[
        'string',
    ],
    instanceStateFilter=[
        'Initializing'|'Active'|'CreateFailed'|'DeleteFailed'|'Deleting'|'Deleted',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• instanceNameFilter (list) –

  The filter to ListInstances based on their names.

  • (string) –

• instanceStateFilter (list) –

  The filter to ListInstances based on their 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

{
    'instances': [
        {
            'instanceId': 'string',
            'awsAccountId': 'string',
            'state': 'Initializing'|'Active'|'CreateFailed'|'DeleteFailed'|'Deleting'|'Deleted',
            'errorMessage': 'string',
            'webAppDnsDomain': 'string',
            'createdTime': datetime(2015, 1, 1),
            'lastModifiedTime': datetime(2015, 1, 1),
            'instanceName': 'string',
            'instanceDescription': 'string',
            'kmsKeyArn': 'string',
            'versionNumber': 123.0
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The response parameters for ListInstances.

  • instances (list) –

    The list of instances resource data details.

    • (dict) –

      The details of the instance.

      • instanceId (string) –

        The Amazon Web Services Supply Chain instance identifier.

      • awsAccountId (string) –

        The Amazon Web Services account ID that owns the instance.

      • state (string) –

        The state of the instance.

      • errorMessage (string) –

        The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

      • webAppDnsDomain (string) –

        The WebApp DNS domain name of the instance.

      • createdTime (datetime) –

        The instance creation timestamp.

      • lastModifiedTime (datetime) –

        The instance last modified timestamp.

      • instanceName (string) –

        The Amazon Web Services Supply Chain instance name.

      • instanceDescription (string) –

        The Amazon Web Services Supply Chain instance description.

      • kmsKeyArn (string) –

        The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

      • versionNumber (float) –

        The version number of the instance.

  • NextToken (string) –

    A token to resume pagination.