ListCommonControls

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

Request Syntax

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

{
   "CommonControlFilter": { 
      "Objectives": [ 
         { 
            "Arn": "string"
         }
      ]
   }
}

URI Request Parameters

The request uses the following URI parameters.

Request Body

The request accepts the following data in JSON format.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "CommonControls": [ 
      { 
         "Arn": "string",
         "CreateTime": number,
         "Description": "string",
         "Domain": { 
            "Arn": "string",
            "Name": "string"
         },
         "LastUpdateTime": number,
         "Name": "string",
         "Objective": { 
            "Arn": "string",
            "Name": "string"
         }
      }
   ],
   "NextToken": "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.

Errors

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

Examples

Filtering common controls by objective

You can use the ListCommonControls operation to return a filtered list of common controls. For example, you can see a list of all common controls that have the objective of Asset inventory management.

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

The sample response shows the result that the ListCommonControls operation might return if seven common controls matched the filter criteria of Asset inventory management.

Sample Request

{
    "CommonControlFilter": {
        "Objectives": [{
            "Arn": "arn:aws:controlcatalog:::objective/ad11p1961s8erra9m185wa1nn"
        }]
    }
}

Sample Response

{
    "CommonControls": [{
        "Arn": "arn:aws:controlcatalog:::common-control/d4s7ik8fgv8082v3x31hifzcc",
        "CreateTime": 1.710288E9,
        "Description": "Reconcile the organization's asset inventory with other data sources, and conduct asset audits to verify the accuracy of the asset inventory.",
        "Domain": {
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Asset inventory reconciliation and audit",
        "Objective": {
            "Arn": "arn:aws:controlcatalog:::objective/ad11p1961s8erra9m185wa1nn",
            "Name": "Asset inventory management"
        }
    }, {
        "Arn": "arn:aws:controlcatalog:::common-control/1ukpmkewk4i92tjmhsvewi4y7",
        "CreateTime": 1.710288E9,
        "Description": "Maintain an asset inventory of organization authorized and existing hardware, software, and media. Where possible, utilize automated tools to facilitate the discovery and ongoing tracking of such assets.",
        "Domain": {
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Inventory of authorized assets and automated discovery",
        "Objective": {
            "Arn": "arn:aws:controlcatalog:::objective/ad11p1961s8erra9m185wa1nn",
            "Name": "Asset inventory management"
        }
    }, {
        "Arn": "arn:aws:controlcatalog:::common-control/c0qrxhefhmxkbq22tiejp3enn",
        "CreateTime": 1.710288E9,
        "Description": "Take appropriate actions to identify and resolve unauthorized assets within the network environment on a periodic and consistent basis. Appropriate actions include, but are not limited to, removing the asset from the network, quarantining the asset, or denying connectivity to the asset.",
        "Domain": {
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Unauthorized asset management",
        "Objective": {
            "Arn": "arn:aws:controlcatalog:::objective/ad11p1961s8erra9m185wa1nn",
            "Name": "Asset inventory management"
        }
    }, {
        "Arn": "arn:aws:controlcatalog:::common-control/5u2qgwuw3z1y0lrof60yf6264",
        "CreateTime": 1.710288E9,
        "Description": "Track all physical and digital assets to ensure proper use and protection. Monitor status of digital assets like systems, devices, software, applications, and data throughout their lifecycle. Use real-time location tracking for physical assets through technologies like GPS and RFID where possible.",
        "Domain": {
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Asset tracking",
        "Objective": {
            "Arn": "arn:aws:controlcatalog:::objective/ad11p1961s8erra9m185wa1nn",
            "Name": "Asset inventory management"
        }
    }, {
        "Arn": "arn:aws:controlcatalog:::common-control/1tejgq26c0djpzgskw31uscm4",
        "CreateTime": 1.710288E9,
        "Description": "Regularly analyze hardware and software assets to assess criticality, usage, value, and other key metrics. Generate comprehensive reports on the asset inventory.",
        "Domain": {
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Asset inventory analysis and reporting",
        "Objective": {
            "Arn": "arn:aws:controlcatalog:::objective/ad11p1961s8erra9m185wa1nn",
            "Name": "Asset inventory management"
        }
    }, {
        "Arn": "arn:aws:controlcatalog:::common-control/eg1hxxu2e77a7w2wv79quwaxl",
        "CreateTime": 1.710288E9,
        "Description": "Define asset owners, including who has responsibility for managing each asset.",
        "Domain": {
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Asset ownership",
        "Objective": {
            "Arn": "arn:aws:controlcatalog:::objective/ad11p1961s8erra9m185wa1nn",
            "Name": "Asset inventory management"
        }
    }, {
        "Arn": "arn:aws:controlcatalog:::common-control/ec1fxlvgtcxlf2nzremqcca7r",
        "CreateTime": 1.710288E9,
        "Description": "Track and monitor asset status, including whether they are operational, in maintenance, or out of service.",
        "Domain": {
            "Arn": "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq",
            "Name": "Asset management"
        },
        "LastUpdateTime": 1.710288E9,
        "Name": "Asset status tracking",
        "Objective": {
            "Arn": "arn:aws:controlcatalog:::objective/ad11p1961s8erra9m185wa1nn",
            "Name": "Asset inventory management"
        }
    }]
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: