BatchGetStandardsControlAssociations - AWS Security Hub

BatchGetStandardsControlAssociations

For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.

Request Syntax

POST /associations/batchGet HTTP/1.1 Content-type: application/json { "StandardsControlAssociationIds": [ { "SecurityControlId": "string", "StandardsArn": "string" } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

StandardsControlAssociationIds

An array with one or more objects that includes a security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) and the Amazon Resource Name (ARN) of a standard. This field is used to query the enablement status of a control in a specified standard. The security control ID or ARN is the same across standards.

Type: Array of StandardsControlAssociationId objects

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "StandardsControlAssociationDetails": [ { "AssociationStatus": "string", "RelatedRequirements": [ "string" ], "SecurityControlArn": "string", "SecurityControlId": "string", "StandardsArn": "string", "StandardsControlArns": [ "string" ], "StandardsControlDescription": "string", "StandardsControlTitle": "string", "UpdatedAt": "string", "UpdatedReason": "string" } ], "UnprocessedAssociations": [ { "ErrorCode": "string", "ErrorReason": "string", "StandardsControlAssociationId": { "SecurityControlId": "string", "StandardsArn": "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.

StandardsControlAssociationDetails

Provides the enablement status of a security control in a specified standard and other details for the control in relation to the specified standard.

Type: Array of StandardsControlAssociationDetail objects

UnprocessedAssociations

A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) whose enablement status in a specified standard cannot be returned.

Type: Array of UnprocessedStandardsControlAssociation 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

See Also

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