SecurityHub / Client / describe_standards

describe_standards#

SecurityHub.Client.describe_standards(**kwargs)#

Returns a list of the available standards in Security Hub.

For each standard, the results include the standard ARN, the name, and a description.

See also: AWS API Documentation

Request Syntax

response = client.describe_standards(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) –

    The token that is required for pagination. On your first call to the DescribeStandards 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 standards to return.

Return type:

dict

Returns:

Response Syntax

{
    'Standards': [
        {
            'StandardsArn': 'string',
            'Name': 'string',
            'Description': 'string',
            'EnabledByDefault': True|False,
            'StandardsManagedBy': {
                'Company': 'string',
                'Product': 'string'
            }
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

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

Exceptions