Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartAssessmentFrameworkShare

Creates a share request for a custom framework in AWS 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.

When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) AWS Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) AWS Region.

Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs:

The sender revokes the share request.
The recipient declines the share request.
The recipient encounters an error and doesn't successfully accept the share request.
The share request expires before the recipient responds to the request.

When a sender resends a share request, the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework.

When a recipient accepts a share request, the snapshot is replicated into their AWS account under the AWS Region that was specified in the share request.

Important

When you invoke the StartAssessmentFrameworkShare API, you are about to share a custom framework with another AWS account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by AWS, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see Framework sharing eligibility in the AWS Audit Manager User Guide.

Request Syntax


POST /assessmentFrameworks/frameworkId/shareRequests HTTP/1.1
Content-type: application/json

{
   "comment": "string",
   "destinationAccount": "string",
   "destinationRegion": "string"
}

URI Request Parameters

The request uses the following URI parameters.

frameworkId

The unique identifier for the custom framework to be shared.

Length Constraints: Fixed length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

comment

An optional comment from the sender about the share request.

Type: String

Length Constraints: Maximum length of 500.

Pattern: ^[\w\W\s\S]*$

Required: No

destinationAccount

The AWS account of the recipient.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

destinationRegion

The AWS Region of the recipient.

Type: String

Pattern: ^[a-z]{2}-[a-z]+-[0-9]{1}$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "assessmentFrameworkShareRequest": { 
      "comment": "string",
      "complianceType": "string",
      "creationTime": number,
      "customControlsCount": number,
      "destinationAccount": "string",
      "destinationRegion": "string",
      "expirationTime": number,
      "frameworkDescription": "string",
      "frameworkId": "string",
      "frameworkName": "string",
      "id": "string",
      "lastUpdated": number,
      "sourceAccount": "string",
      "standardControlsCount": number,
      "status": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

assessmentFrameworkShareRequest

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

Type: AssessmentFrameworkShareRequest object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.

HTTP Status Code: 403

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource that's specified in the request can't be found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400