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.

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',
            'StandardsStatusReason': {
                'StatusReasonCode': 'NO_AVAILABLE_CONFIGURATION_RECORDER'|'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 a resource that represents your subscription to a supported standard.
    - StandardsArn (string) –
      
      The ARN of a standard.
    - StandardsInput (dict) –
      
      A key-value pair of input for the standard.
      - (string) –
        
        (string) –
    - StandardsStatus (string) –
      
      The status of the standard subscription.
      
      The status values are as follows:
      - PENDING - Standard is in the process of being enabled.
      - READY - Standard is enabled.
      - INCOMPLETE - Standard could not be enabled completely. Some controls may not be available.
      - DELETING - Standard is in the process of being disabled.
      - FAILED - Standard could not be disabled.
    - 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

SecurityHub.Client.exceptions.InternalException
SecurityHub.Client.exceptions.InvalidInputException
SecurityHub.Client.exceptions.InvalidAccessException
SecurityHub.Client.exceptions.LimitExceededException
SecurityHub.Client.exceptions.AccessDeniedException