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

ListStandardsControlAssociations

Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.

Request Syntax


GET /associations?MaxResults=MaxResults&NextToken=NextToken&SecurityControlId=SecurityControlId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 standard and control associations. The results also include a NextToken parameter that you can use in a subsequent API call to get the next 25 associations. This repeats until all associations for the specified control are returned. The number of results is limited by the number of supported Security Hub standards that you've enabled in the calling account.

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

NextToken

Optional pagination parameter.

SecurityControlId

The identifier of the control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) that you want to determine the enablement status of in each enabled standard.

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "StandardsControlAssociationSummaries": [ 
      { 
         "AssociationStatus": "string",
         "RelatedRequirements": [ "string" ],
         "SecurityControlArn": "string",
         "SecurityControlId": "string",
         "StandardsArn": "string",
         "StandardsControlDescription": "string",
         "StandardsControlTitle": "string",
         "UpdatedAt": "string",
         "UpdatedReason": "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

A pagination parameter that's included in the response only if it was included in the request.

Type: String

StandardsControlAssociationSummaries

An array that provides the enablement status and other details for each security control that applies to each enabled standard.

Type: Array of StandardsControlAssociationSummary objects

Errors

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

InternalException

Internal server error.

HTTP Status Code: 500

InvalidAccessException

The account doesn't have permission to perform this action.

HTTP Status Code: 401

InvalidInputException

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

HTTP Status Code: 400

LimitExceededException

The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

HTTP Status Code: 429