SecurityHub / Paginator / GetEnabledStandards

GetEnabledStandards#

class SecurityHub.Paginator.GetEnabledStandards#
paginator = client.get_paginator('get_enabled_standards')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SecurityHub.Client.get_enabled_standards().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    StandardsSubscriptionArns=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • StandardsSubscriptionArns (list) –

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

    • (string) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous 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'
            }
        },
    ],

}

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.