ControlCatalog / Paginator / ListObjectives

ListObjectives#

class ControlCatalog.Paginator.ListObjectives#
paginator = client.get_paginator('list_objectives')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ControlCatalog.Client.list_objectives().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ObjectiveFilter={
        'Domains': [
            {
                'Arn': 'string'
            },
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • ObjectiveFilter (dict) –

    An optional filter that narrows the results to a specific domain.

    This filter allows you to specify one domain ARN at a time. Passing multiple ARNs in the ObjectiveFilter isn’t currently supported.

    • Domains (list) –

      The domain that’s used as filter criteria.

      You can use this parameter to specify one domain ARN at a time. Passing multiple ARNs in the ObjectiveFilter isn’t currently supported.

      • (dict) –

        The domain resource that’s being used as a filter.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the domain.

  • 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

{
    'Objectives': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Domain': {
                'Arn': 'string',
                'Name': 'string'
            },
            'CreateTime': datetime(2015, 1, 1),
            'LastUpdateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    • Objectives (list) –

      The list of objectives that the ListObjectives API returns.

      • (dict) –

        A summary of metadata for an objective.

        • Arn (string) –

          The Amazon Resource Name (ARN) that identifies the objective.

        • Name (string) –

          The name of the objective.

        • Description (string) –

          The description of the objective.

        • Domain (dict) –

          The domain that the objective belongs to.

          • Arn (string) –

            The Amazon Resource Name (ARN) of the related domain.

          • Name (string) –

            The name of the related domain.

        • CreateTime (datetime) –

          The time when the objective was created.

        • LastUpdateTime (datetime) –

          The time when the objective was most recently updated.