ECS / Paginator / ListAttributes

ListAttributes#

class ECS.Paginator.ListAttributes#
paginator = client.get_paginator('list_attributes')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ECS.Client.list_attributes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    cluster='string',
    targetType='container-instance',
    attributeName='string',
    attributeValue='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • cluster (string) – The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

  • targetType (string) –

    [REQUIRED]

    The type of the target to list attributes with.

  • attributeName (string) – The name of the attribute to filter the results with.

  • attributeValue (string) – The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.

  • 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

{
    'attributes': [
        {
            'name': 'string',
            'value': 'string',
            'targetType': 'container-instance',
            'targetId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • attributes (list) –

      A list of attribute objects that meet the criteria of the request.

      • (dict) –

        An attribute is a name-value pair that’s associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

        • name (string) –

          The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).

        • value (string) –

          The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can’t start or end with a space.

        • targetType (string) –

          The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

        • targetId (string) –

          The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

    • NextToken (string) –

      A token to resume pagination.