CodeDeploy / Paginator / ListOnPremisesInstances

ListOnPremisesInstances

class CodeDeploy.Paginator.ListOnPremisesInstances

paginator = client.get_paginator('list_on_premises_instances')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeDeploy.Client.list_on_premises_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    registrationStatus='Registered'|'Deregistered',
    tagFilters=[
        {
            'Key': 'string',
            'Value': 'string',
            'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• registrationStatus (string) –

  The registration status of the on-premises instances:

  • Deregistered: Include deregistered on-premises instances in the resulting list.

  • Registered: Include registered on-premises instances in the resulting list.

• tagFilters (list) –

  The on-premises instance tags that are used to restrict the on-premises instance names returned.

  • (dict) –

    Information about an on-premises instance tag filter.

    • Key (string) –

      The on-premises instance tag filter key.

    • Value (string) –

      The on-premises instance tag filter value.

    • Type (string) –

      The on-premises instance tag filter type:

      • KEY_ONLY: Key only.

      • VALUE_ONLY: Value only.

      • KEY_AND_VALUE: Key and value.

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

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'instanceNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents the output of the list on-premises instances operation.

  • instanceNames (list) –

    The list of matching on-premises instance names.

    • (string) –

  • NextToken (string) –

    A token to resume pagination.