AuditManager / Client / list_assessment_frameworks

list_assessment_frameworks#

AuditManager.Client.list_assessment_frameworks(**kwargs)#

Returns a list of the frameworks that are available in the Audit Manager framework library.

See also: AWS API Documentation

Request Syntax

response = client.list_assessment_frameworks(
    frameworkType='Standard'|'Custom',
    nextToken='string',
    maxResults=123
)
Parameters:

  • frameworkType (string) –

    [REQUIRED]

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

  • 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

{
    'frameworkMetadataList': [
        {
            'arn': 'string',
            'id': 'string',
            'type': 'Standard'|'Custom',
            'name': 'string',
            'description': 'string',
            'logo': 'string',
            'complianceType': 'string',
            'controlsCount': 123,
            'controlSetsCount': 123,
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • frameworkMetadataList (list) –

      A list of metadata that the ListAssessmentFrameworks API returns for each framework.

      • (dict) –

        The metadata that’s associated with a standard framework or a custom framework.

        • arn (string) –

          The Amazon Resource Name (ARN) of the framework.

        • id (string) –

          The unique identifier for the framework.

        • type (string) –

          The framework type, such as a standard framework or a custom framework.

        • name (string) –

          The name of the framework.

        • description (string) –

          The description of the framework.

        • logo (string) –

          The logo that’s associated with the framework.

        • complianceType (string) –

          The compliance type that the new custom framework supports, such as CIS or HIPAA.

        • controlsCount (integer) –

          The number of controls that are associated with the framework.

        • controlSetsCount (integer) –

          The number of control sets that are associated with the framework.

        • createdAt (datetime) –

          The time when the framework was created.

        • lastUpdatedAt (datetime) –

          The time when the framework was most recently updated.

    • nextToken (string) –

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

Exceptions

  • AuditManager.Client.exceptions.ValidationException

  • AuditManager.Client.exceptions.AccessDeniedException

  • AuditManager.Client.exceptions.InternalServerException