ControlCatalog / Client / list_objectives

list_objectives#

ControlCatalog.Client.list_objectives(**kwargs)#

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

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

  • MaxResults (integer) – The maximum number of results on a page or for an API request call.

  • NextToken (string) – The pagination token that’s used to fetch the next set of results.

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

Return type:

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.

Exceptions

  • ControlCatalog.Client.exceptions.AccessDeniedException

  • ControlCatalog.Client.exceptions.InternalServerException

  • ControlCatalog.Client.exceptions.ValidationException

  • ControlCatalog.Client.exceptions.ThrottlingException