SecurityHub / Paginator / ListSecurityControlDefinitions

ListSecurityControlDefinitions

class SecurityHub.Paginator.ListSecurityControlDefinitions

paginator = client.get_paginator('list_security_control_definitions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• StandardsArn (string) – The Amazon Resource Name (ARN) of the standard that you want to view controls for.

• 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

{
    'SecurityControlDefinitions': [
        {
            'SecurityControlId': 'string',
            'Title': 'string',
            'Description': 'string',
            'RemediationUrl': 'string',
            'SeverityRating': 'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
            'CurrentRegionAvailability': 'AVAILABLE'|'UNAVAILABLE'
        },
    ],

}

Response Structure

• (dict) –

  • SecurityControlDefinitions (list) –

    An array of controls that apply to the specified standard.

    • (dict) –

      Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in Amazon Web Services Regions, and a link to remediation steps.

      • SecurityControlId (string) –

        The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

      • Title (string) –

        The title of a security control.

      • Description (string) –

        The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn’t reference a specific standard.

      • RemediationUrl (string) –

        A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

      • SeverityRating (string) –

        The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.

      • CurrentRegionAvailability (string) –

        Specifies whether a security control is available in the current Amazon Web Services Region.