Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListObjectives

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

Request Syntax


POST /objectives?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Content-type: application/json

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

URI Request Parameters

The request uses the following URI parameters.

MaxResults

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

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

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

Length Constraints: Minimum length of 0. Maximum length of 1024.

Request Body

The request accepts the following data in JSON format.

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.

Type: ObjectiveFilter object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Objectives": [ 
      { 
         "Arn": "string",
         "CreateTime": number,
         "Description": "string",
         "Domain": { 
            "Arn": "string",
            "Name": "string"
         },
         "LastUpdateTime": number,
         "Name": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Objectives

The list of objectives that the ListObjectives API returns.

Type: Array of ObjectiveSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

Filtering objectives by domain

You can use the ListObjectives operation to return a filtered list of objectives. For example, you can see all of the objectives that fall under a specific domain such as Asset management.

To filter results by domain

Use the ListDomains operation to see the domains that you can use as filters.
Find the domain that you want to use as a filter, and take note of its ARN.
Use the ListObjectives operation and include the Domains parameter. For the ARN attribute value, specify the domain ARN from step 2.

Note
Keep in mind that you can only filter by one domain at a time. Specifying multiple domain ARNs isn’t currently supported.
If you want to filter by more than one ARN, we recommend that you run the ListObjectives operation separately for each ARN.

The sample request below uses the following domain ARN as a filter: arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq. This ARN represents the Asset management domain.

The sample response shows the result that the ListObjectives operation might return if five objectives matched the filter criteria of Asset management.

Sample Request


{
    "ObjectiveFilter": {
        "Domains": [{
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq"
        }]
    }
}

Sample Response


{
    "Objectives": [{
        "Arn": "arn:aws:controlcatalog:::objective/ad11p1961s8erra9m185wa1nn",
        "CreateTime": 1.710288E9,
        "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/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Asset inventory management"
    }, {
        "Arn": "arn:aws:controlcatalog:::objective/90gifwthorhxhxq7m0rtss98u",
        "CreateTime": 1.710288E9,
        "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/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Asset classification"
    }, {
        "Arn": "arn:aws:controlcatalog:::objective/3frxxgl64u9kzttiuheywykf7",
        "CreateTime": 1.710288E9,
        "Description": "This control objective focuses on maintaining the availability and integrity of assets, including performance management, regular maintenance, and repairs to protect and extract the maximum value of the organization's IT investments.",
        "Domain": {
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Asset maintenance"
    }, {
        "Arn": "arn:aws:controlcatalog:::objective/5ve4jodybrg8wnky75fp50sbf",
        "CreateTime": 1.710288E9,
        "Description": "This control objective focuses on managing assets throughout their entire lifecycle, including acquisition, deployment, use, and retirement. This helps manage risks associated with asset costs by ensuring optimum asset productivity, performance, efficiency, and profitability.",
        "Domain": {
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Asset lifecycle management"
    }, {
        "Arn": "arn:aws:controlcatalog:::objective/ags5wgkyvwriix77zegtwhyo9",
        "CreateTime": 1.710288E9,
        "Description": "This control objective focuses on preventing asset loss, and responding to and recovering lost, stolen, or damaged assets to contribute to the organization's profitability by reducing losses.",
        "Domain": {
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Asset loss prevention, response, and recovery"
    }]
}