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.

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'
        },
    ],
    '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.
- NextToken (string) –
  
  The pagination token that’s used to fetch the next set of results.

Exceptions

ControlCatalog.Client.exceptions.AccessDeniedException
ControlCatalog.Client.exceptions.InternalServerException
ControlCatalog.Client.exceptions.ValidationException
ControlCatalog.Client.exceptions.ThrottlingException