SecurityHub / Client / get_enabled_standards

get_enabled_standards#

SecurityHub.Client.get_enabled_standards(**kwargs)#

Returns a list of the standards that are currently enabled.

See also: AWS API Documentation

Request Syntax

response = client.get_enabled_standards(
    StandardsSubscriptionArns=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • StandardsSubscriptionArns (list) –

    The list of the standards subscription ARNs for the standards to retrieve.

    • (string) –

  • NextToken (string) –

    The token that is required for pagination. On your first call to the GetEnabledStandards operation, set the value of this parameter to NULL.

    For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

  • MaxResults (integer) – The maximum number of results to return in the response.

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'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • StandardsSubscriptions (list) –

      The list of StandardsSubscriptions objects that include information about the enabled standards.

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

    • NextToken (string) –

      The pagination token to use to request the next page of results.

Exceptions