ControlCatalog / Client / list_controls

list_controls

ControlCatalog.Client.list_controls(**kwargs)

Returns a paginated list of all available controls in the Amazon Web Services Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type controlSummary. The ARN is returned in the global controlcatalog format, as shown in the examples.

See also: AWS API Documentation

Request Syntax

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

  • NextToken (string) – The pagination token that’s used to fetch the next set of results.

  • MaxResults (integer) – The maximum number of results on a page or for an API request call.

Return type:

dict

Returns:

Response Syntax

{
    'Controls': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Behavior': 'PREVENTIVE'|'PROACTIVE'|'DETECTIVE',
            'Severity': 'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
            'Implementation': {
                'Type': 'string',
                'Identifier': 'string'
            },
            'CreateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Controls (list) –

      Returns a list of controls, given as structures of type controlSummary.

      • (dict) –

        Overview of information about a control.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the control.

        • Name (string) –

          The display name of the control.

        • Description (string) –

          A description of the control, as it may appear in the console. Describes the functionality of the control.

        • Behavior (string) –

          An enumerated type, with the following possible values:

        • Severity (string) –

          An enumerated type, with the following possible values:

        • Implementation (dict) –

          An object of type ImplementationSummary that describes how the control is implemented.

          • Type (string) –

            A string that represents the Amazon Web Services service that implements this control. For example, a value of AWS::Config::ConfigRule indicates that the control is implemented by Amazon Web Services Config, and AWS::SecurityHub::SecurityControl indicates implementation by Amazon Web Services Security Hub.

          • Identifier (string) –

            The identifier originally assigned by the Amazon Web Services service that implements the control. For example, CODEPIPELINE_DEPLOYMENT_COUNT_CHECK.

        • CreateTime (datetime) –

          A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.

    • NextToken (string) –

      The pagination token that’s used to fetch the next set of results.

Exceptions