AuditManager / Client / list_controls

list_controls#

AuditManager.Client.list_controls(**kwargs)#

Returns a list of controls from Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.list_controls(
    controlType='Standard'|'Custom',
    nextToken='string',
    maxResults=123
)
Parameters:
  • controlType (string) –

    [REQUIRED]

    The type of control, such as a standard control or a custom control.

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

  • maxResults (integer) – Represents the maximum number of results on a page or for an API request call.

Return type:

dict

Returns:

Response Syntax

{
    'controlMetadataList': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'controlSources': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • controlMetadataList (list) –

      The list of control metadata objects that the ListControls API returned.

      • (dict) –

        The metadata that’s associated with the standard control or custom control.

        • arn (string) –

          The Amazon Resource Name (ARN) of the control.

        • id (string) –

          The unique identifier for the control.

        • name (string) –

          The name of the control.

        • controlSources (string) –

          The data source that determines where Audit Manager collects evidence from for the control.

        • createdAt (datetime) –

          The time when the control was created.

        • lastUpdatedAt (datetime) –

          The time when the control was most recently updated.

    • nextToken (string) –

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

Exceptions

  • AuditManager.Client.exceptions.AccessDeniedException

  • AuditManager.Client.exceptions.ValidationException

  • AuditManager.Client.exceptions.InternalServerException