AWS Control Catalog

2024/04/08 - AWS Control Catalog - 3 new api methods

Changes  This is the initial SDK release for AWS Control Catalog, a central catalog for AWS managed controls. This release includes 3 new APIs - ListDomains, ListObjectives, and ListCommonControls - that vend high-level data to categorize controls across the AWS platform.

ListCommonControls (new) Link ¶

Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.

See also: AWS API Documentation

Request Syntax

client.list_common_controls(
    CommonControlFilter={
        'Objectives': [
            {
                'Arn': 'string'
            },
        ]
    },
    MaxResults=123,
    NextToken='string'
)
type CommonControlFilter

dict

param CommonControlFilter

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.

type MaxResults

integer

param MaxResults

The maximum number of results on a page or for an API request call.

type NextToken

string

param NextToken

The pagination token that's used to fetch the next set of results.

rtype

dict

returns

Response Syntax

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

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.

        • CreateTime (datetime) --

          The time when the common control was created.

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

        • LastUpdateTime (datetime) --

          The time when the common control was most recently updated.

        • Name (string) --

          The name of the common control.

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

    • NextToken (string) --

      The pagination token that's used to fetch the next set of results.

ListObjectives (new) Link ¶

Returns a paginated list of objectives from the Amazon Web Services Control Catalog.

You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.

See also: AWS API Documentation

Request Syntax

client.list_objectives(
    MaxResults=123,
    NextToken='string',
    ObjectiveFilter={
        'Domains': [
            {
                'Arn': 'string'
            },
        ]
    }
)
type MaxResults

integer

param MaxResults

The maximum number of results on a page or for an API request call.

type NextToken

string

param NextToken

The pagination token that's used to fetch the next set of results.

type ObjectiveFilter

dict

param ObjectiveFilter

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.

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • NextToken (string) --

      The pagination token that's used to fetch the next set of results.

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

        • CreateTime (datetime) --

          The time when the objective was created.

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

        • LastUpdateTime (datetime) --

          The time when the objective was most recently updated.

        • Name (string) --

          The name of the objective.

ListDomains (new) Link ¶

Returns a paginated list of domains from the Amazon Web Services Control Catalog.

See also: AWS API Documentation

Request Syntax

client.list_domains(
    MaxResults=123,
    NextToken='string'
)
type MaxResults

integer

param MaxResults

The maximum number of results on a page or for an API request call.

type NextToken

string

param NextToken

The pagination token that's used to fetch the next set of results.

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • Domains (list) --

      The list of domains that the ListDomains API returns.

      • (dict) --

        A summary of metadata for a domain.

        • Arn (string) --

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

        • CreateTime (datetime) --

          The time when the domain was created.

        • Description (string) --

          The description of the domain.

        • LastUpdateTime (datetime) --

          The time when the domain was most recently updated.

        • Name (string) --

          The name of the domain.

    • NextToken (string) --

      The pagination token that's used to fetch the next set of results.