list_assessment_framework_share_requests

AuditManager.Client.list_assessment_framework_share_requests(**kwargs)

Returns a list of sent or received share requests for custom frameworks in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.list_assessment_framework_share_requests(
    requestType='SENT'|'RECEIVED',
    nextToken='string',
    maxResults=123
)

Parameters

• requestType (string) --

  [REQUIRED]

  Specifies whether the share request is a sent request or a received request.

• 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

{
    'assessmentFrameworkShareRequests': [
        {
            'id': 'string',
            'frameworkId': 'string',
            'frameworkName': 'string',
            'frameworkDescription': 'string',
            'status': 'ACTIVE'|'REPLICATING'|'SHARED'|'EXPIRING'|'FAILED'|'EXPIRED'|'DECLINED'|'REVOKED',
            'sourceAccount': 'string',
            'destinationAccount': 'string',
            'destinationRegion': 'string',
            'expirationTime': datetime(2015, 1, 1),
            'creationTime': datetime(2015, 1, 1),
            'lastUpdated': datetime(2015, 1, 1),
            'comment': 'string',
            'standardControlsCount': 123,
            'customControlsCount': 123,
            'complianceType': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • assessmentFrameworkShareRequests (list) --

    The list of share requests that the ListAssessmentFrameworkShareRequests API returned.

    • (dict) --

      Represents a share request for a custom framework in Audit Manager.

      • id (string) --

        The unique identifier for the share request.

      • frameworkId (string) --

        The unique identifier for the shared custom framework.

      • frameworkName (string) --

        The name of the custom framework that the share request is for.

      • frameworkDescription (string) --

        The description of the shared custom framework.

      • status (string) --

        The status of the share request.

      • sourceAccount (string) --

        The Amazon Web Services account of the sender.

      • destinationAccount (string) --

        The Amazon Web Services account of the recipient.

      • destinationRegion (string) --

        The Amazon Web Services Region of the recipient.

      • expirationTime (datetime) --

        The time when the share request expires.

      • creationTime (datetime) --

        The time when the share request was created.

      • lastUpdated (datetime) --

        Specifies when the share request was last updated.

      • comment (string) --

        An optional comment from the sender about the share request.

      • standardControlsCount (integer) --

        The number of standard controls that are part of the shared custom framework.

      • customControlsCount (integer) --

        The number of custom controls that are part of the shared custom framework.

      • complianceType (string) --

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

  • 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