AWS Audit Manager

2021/10/25 - AWS Audit Manager - 4 new api methods

Changes  This release introduces a new feature for Audit Manager: Custom framework sharing. You can now share your custom frameworks with another AWS account, or replicate them into another AWS Region under your own account.

UpdateAssessmentFrameworkShare (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_assessment_framework_share(
    requestId='string',
    requestType='SENT'|'RECEIVED',
    action='ACCEPT'|'DECLINE'|'REVOKE'
)
type requestId:

string

param requestId:

[REQUIRED]

The unique identifier for the share request.

type requestType:

string

param requestType:

[REQUIRED]

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

type action:

string

param action:

[REQUIRED]

Specifies the update action for the share request.

rtype:

dict

returns:

Response Syntax

{
    'assessmentFrameworkShareRequest': {
        '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'
    }
}

Response Structure

  • (dict) --

    • assessmentFrameworkShareRequest (dict) --

      The updated share request that's returned by the UpdateAssessmentFrameworkShare operation.

      • 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.

ListAssessmentFrameworkShareRequests (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

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

string

param requestType:

[REQUIRED]

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

type nextToken:

string

param nextToken:

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

type maxResults:

integer

param maxResults:

Represents the maximum number of results on a page or for an API request call.

rtype:

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.

DeleteAssessmentFrameworkShare (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.delete_assessment_framework_share(
    requestId='string',
    requestType='SENT'|'RECEIVED'
)
type requestId:

string

param requestId:

[REQUIRED]

The unique identifier for the share request to be deleted.

type requestType:

string

param requestType:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

StartAssessmentFrameworkShare (new) Link ¶

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

The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.

See also: AWS API Documentation

Request Syntax

client.start_assessment_framework_share(
    frameworkId='string',
    destinationAccount='string',
    destinationRegion='string',
    comment='string'
)
type frameworkId:

string

param frameworkId:

[REQUIRED]

The unique identifier for the custom framework to be shared.

type destinationAccount:

string

param destinationAccount:

[REQUIRED]

The Amazon Web Services account of the recipient.

type destinationRegion:

string

param destinationRegion:

[REQUIRED]

The Amazon Web Services Region of the recipient.

type comment:

string

param comment:

An optional comment from the sender about the share request.

rtype:

dict

returns:

Response Syntax

{
    'assessmentFrameworkShareRequest': {
        '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'
    }
}

Response Structure

  • (dict) --

    • assessmentFrameworkShareRequest (dict) --

      The share request that's created by the StartAssessmentFrameworkShare API.

      • 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.