Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . securityhub ]

batch-update-standards-control-associations¶

Description¶

For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.

Synopsis¶

  batch-update-standards-control-associations
--standards-control-association-updates <value>
[--cli-input-json <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>]

Options¶

--standards-control-association-updates (list)

Updates the enablement status of a security control in a specified standard.

(structure)

An array of requested updates to the enablement status of controls in specified standards. The objects in the array include a security control ID, the Amazon Resource Name (ARN) of the standard, the requested enablement status, and the reason for updating the enablement status.

StandardsArn -> (string)

The Amazon Resource Name (ARN) of the standard in which you want to update the control's enablement status.

SecurityControlId -> (string)

The unique identifier for the security control whose enablement status you want to update.

AssociationStatus -> (string)

The desired enablement status of the control in the standard.

UpdatedReason -> (string)

The reason for updating the control's enablement status in the standard.

Shorthand Syntax:

StandardsArn=string,SecurityControlId=string,AssociationStatus=string,UpdatedReason=string ...

JSON Syntax:

[
  {
    "StandardsArn": "string",
    "SecurityControlId": "string",
    "AssociationStatus": "ENABLED"|"DISABLED",
    "UpdatedReason": "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.

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

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

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 .

To update the enablement status of a control in enabled standards

The following batch-update-standards-control-associations example disables CloudTrail.1 in the specified standards.

aws securityhub batch-update-standards-control-associations \
    --standards-control-association-updates '[{"SecurityControlId": "CloudTrail.1", "StandardsArn": "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0", "AssociationStatus": "DISABLED", "UpdatedReason": "Not applicable to environment"}, {"SecurityControlId": "CloudTrail.1", "StandardsArn": "arn:aws:securityhub:::standards/cis-aws-foundations-benchmark/v/1.4.0", "AssociationStatus": "DISABLED", "UpdatedReason": "Not applicable to environment"}]'

This command produces no output when successful.

For more information, see Enabling and disabling controls in specific standards and Enabling and disabling controls in all standards in the AWS Security Hub User Guide.

Output¶

UnprocessedAssociationUpdates -> (list)

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

(structure)

Provides details about which control's enablement status could not be updated in a specified standard when calling the BatchUpdateStandardsControlAssociations API. This parameter also provides details about why the request was unprocessed.

StandardsControlAssociationUpdate -> (structure)

An array of control and standard associations for which an update failed when calling BatchUpdateStandardsControlAssociations .

StandardsArn -> (string)

The Amazon Resource Name (ARN) of the standard in which you want to update the control's enablement status.

SecurityControlId -> (string)

The unique identifier for the security control whose enablement status you want to update.

AssociationStatus -> (string)

The desired enablement status of the control in the standard.

UpdatedReason -> (string)

The reason for updating the control's enablement status in the standard.

ErrorCode -> (string)

The error code for the unprocessed update of the control's enablement status in the specified standard.

ErrorReason -> (string)

The reason why a control's enablement status in the specified standard couldn't be updated.

Table Of Contents

Feedback

User Guide