SecurityHub / Paginator / DescribeStandards

DescribeStandards

class SecurityHub.Paginator.DescribeStandards

paginator = client.get_paginator('describe_standards')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'Standards': [
        {
            'StandardsArn': 'string',
            'Name': 'string',
            'Description': 'string',
            'EnabledByDefault': True|False,
            'StandardsManagedBy': {
                'Company': 'string',
                'Product': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • Standards (list) –

    A list of available standards.

    • (dict) –

      Provides information about a specific security standard.

      • StandardsArn (string) –

        The ARN of a standard.

      • Name (string) –

        The name of the standard.

      • Description (string) –

        A description of the standard.

      • EnabledByDefault (boolean) –

        Whether the standard is enabled by default. When Security Hub is enabled from the console, if a standard is enabled by default, the check box for that standard is selected by default.

        When Security Hub is enabled using the EnableSecurityHub API operation, the standard is enabled by default unless EnableDefaultStandards is set to false.

      • StandardsManagedBy (dict) –

        Provides details about the management of a standard.

        • Company (string) –

          An identifier for the company that manages a specific security standard. For existing standards, the value is equal to Amazon Web Services.

        • Product (string) –

          An identifier for the product that manages a specific security standard. For existing standards, the value is equal to the Amazon Web Services service that manages the standard.