ControlCatalog / Paginator / ListCommonControls

ListCommonControls

class ControlCatalog.Paginator.ListCommonControls

paginator = client.get_paginator('list_common_controls')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CommonControlFilter={
        'Objectives': [
            {
                'Arn': 'string'
            },
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• CommonControlFilter (dict) –

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

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

  • Objectives (list) –

    The objective that’s used as filter criteria.

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

    • (dict) –

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

      • Arn (string) –

        The Amazon Resource Name (ARN) of the objective.

• 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

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

}

Response Structure

• (dict) –

  • CommonControls (list) –

    The list of common controls that the ListCommonControls API returns.

    • (dict) –

      A summary of metadata for a common control.

      • Arn (string) –

        The Amazon Resource Name (ARN) that identifies the common control.

      • Name (string) –

        The name of the common control.

      • Description (string) –

        The description of the common control.

      • Domain (dict) –

        The domain that the common control belongs to.

        • Arn (string) –

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

        • Name (string) –

          The name of the related domain.

      • Objective (dict) –

        The objective that the common control belongs to.

        • Arn (string) –

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

        • Name (string) –

          The name of the related objective.

      • CreateTime (datetime) –

        The time when the common control was created.

      • LastUpdateTime (datetime) –

        The time when the common control was most recently updated.