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