Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . controlcatalog ]

list-objectives¶

Description¶

Returns a paginated list of objectives from the 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.

Synopsis¶

  list-objectives
[--objective-filter <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options¶

--objective-filter (structure)

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

(structure)

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

Arn -> (string)

The Amazon Resource Name (ARN) of the domain.

Shorthand Syntax:

Domains=[{Arn=string},{Arn=string}]

JSON Syntax:

{
  "Domains": [
    {
      "Arn": "string"
    }
    ...
  ]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Example 1: To display a list of objectives from the Control Catalog

The following list-objectives example displays a list of control objectives in the Control Catalog.

aws controlcatalog list-objectives

Output:

{
    "Objectives": [
        {
            "Arn": "arn:aws:controlcatalog:::objective/ad11p1961s8erra9m1EXAMPLE",
            "Name": "Asset inventory management",
            "Description": "This control objective focuses on maintaining an accurate and up-to-date inventory of assets, including hardware, software, and data, to protect organization investments from harm or loss.",
            "Domain": {
                "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlvEXAMPLE",
                "Name": "Asset management"
            },
            "CreateTime": "2024-03-12T19:00:00-05:00",
            "LastUpdateTime": "2024-03-12T19:00:00-05:00"
        },
        {
            "Arn": "arn:aws:controlcatalog:::objective/90gifwthorhxhxq7m0EXAMPLE",
            "Name": "Asset classification",
            "Description": "This control objective focuses on classifying assets based on their value, sensitivity, and criticality to the organization to manage investment risk and unauthorized access to assets and information.",
            "Domain": {
                "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlvEXAMPLE",
                "Name": "Asset management"
            },
            "CreateTime": "2024-03-12T19:00:00-05:00",
            "LastUpdateTime": "2024-03-12T19:00:00-05:00"
        }
    ]
}

For more information, see Control catalog: control objectives in the AWS Control Catalog User Guide.

Example 2: To display a list of specific objectives filtered by domain

The following list-objectives example displays a list of specific control objectives filtered by domain.

aws controlcatalog list-objectives \
    --objective-filter '{"Domains": [{"Arn": "arn:aws:controlcatalog:::domain/33mjpzadrlwo1by3c1EXAMPLE"}]}'

Output:

{
    "Objectives": [
        {
            "Arn": "arn:aws:controlcatalog:::objective/9l3arklghxiyc6ehikEXAMPLE",
            "Name": "Business continuity",
            "Description": "This control objective focuses on developing and maintaining plans, procedures, and protocols that support an organization's ability to recover critical business functions in the event of a disruption, including backup and recovery and business impact analysis.",
            "Domain": {
                "Arn": "arn:aws:controlcatalog:::domain/33mjpzadrlwo1by3c1EXAMPLE",
                "Name": "Business continuity and recovery"
            },
            "CreateTime": "2024-03-12T19:00:00-05:00",
            "LastUpdateTime": "2024-03-12T19:00:00-05:00"
        },
        {
            "Arn": "arn:aws:controlcatalog:::objective/8fub2rjbldjmrseky5EXAMPLE",
            "Name": "Disaster recovery",
            "Description": "This control objective focuses on the steps and technologies necessary to recover critical information resources in the event of a natural disaster, security event and/or incident, and/or system outage and ensure critical business functions can continue.",
            "Domain": {
                "Arn": "arn:aws:controlcatalog:::domain/33mjpzadrlwo1by3c1EXAMPLE",
                "Name": "Business continuity and recovery"
            },
            "CreateTime": "2024-03-12T19:00:00-05:00",
            "LastUpdateTime": "2024-03-12T19:00:00-05:00"
        }
    ]
}

For more information, see Control catalog: control objectives in the AWS Control Catalog User Guide.

Output¶

Objectives -> (list)

The list of objectives that the ListObjectives API returns.

(structure)

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 -> (structure)

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 -> (timestamp)

The time when the objective was created.

LastUpdateTime -> (timestamp)

The time when the objective was most recently updated.

NextToken -> (string)

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

Table of Contents

Feedback

User Guide