SecurityHub / Client / batch_enable_standards

batch_enable_standards

SecurityHub.Client.batch_enable_standards(**kwargs)

Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation.

For more information, see the Security Standards section of the Security Hub User Guide.

See also: AWS API Documentation

Request Syntax

response = client.batch_enable_standards(
    StandardsSubscriptionRequests=[
        {
            'StandardsArn': 'string',
            'StandardsInput': {
                'string': 'string'
            }
        },
    ]
)
Parameters:

StandardsSubscriptionRequests (list) –

[REQUIRED]

The list of standards checks to enable.

  • (dict) –

    The standard that you want to enable.

    • StandardsArn (string) – [REQUIRED]

      The ARN of the standard that you want to enable. To view the list of available standards and their ARNs, use the DescribeStandards operation.

    • StandardsInput (dict) –

      A key-value pair of input for the standard.

      • (string) –

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'StandardsSubscriptions': [
        {
            'StandardsSubscriptionArn': 'string',
            'StandardsArn': 'string',
            'StandardsInput': {
                'string': 'string'
            },
            'StandardsStatus': 'PENDING'|'READY'|'FAILED'|'DELETING'|'INCOMPLETE',
            'StandardsControlsUpdatable': 'READY_FOR_UPDATES'|'NOT_READY_FOR_UPDATES',
            'StandardsStatusReason': {
                'StatusReasonCode': 'NO_AVAILABLE_CONFIGURATION_RECORDER'|'MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED'|'INTERNAL_ERROR'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • StandardsSubscriptions (list) –

      The details of the standards subscriptions that were enabled.

      • (dict) –

        A resource that represents your subscription to a supported standard.

        • StandardsSubscriptionArn (string) –

          The ARN of the resource that represents your subscription to the standard.

        • StandardsArn (string) –

          The ARN of the standard.

        • StandardsInput (dict) –

          A key-value pair of input for the standard.

          • (string) –

            • (string) –

        • StandardsStatus (string) –

          The status of your subscription to the standard. Possible values are:

          • PENDING - The standard is in the process of being enabled. Or the standard is already enabled and Security Hub is adding new controls to the standard.

          • READY - The standard is enabled.

          • INCOMPLETE - The standard could not be enabled completely. One or more errors ( StandardsStatusReason) occurred when Security Hub attempted to enable the standard.

          • DELETING - The standard is in the process of being disabled.

          • FAILED - The standard could not be disabled. One or more errors ( StandardsStatusReason) occurred when Security Hub attempted to disable the standard.

        • StandardsControlsUpdatable (string) –

          Specifies whether you can retrieve information about and configure individual controls that apply to the standard. Possible values are:

          • READY_FOR_UPDATES - Controls in the standard can be retrieved and configured.

          • NOT_READY_FOR_UPDATES - Controls in the standard cannot be retrieved or configured.

        • StandardsStatusReason (dict) –

          The reason for the current status.

          • StatusReasonCode (string) –

            The reason code that represents the reason for the current status of a standard subscription.

Exceptions