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

CreateProfileShare

Create a profile share.

Request Syntax


POST /profiles/ProfileArn/shares HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "SharedWith": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ProfileArn

The profile ARN.

Length Constraints: Maximum length of 2084.

Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:profile/[a-z0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

Important

This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

SharedWith

The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 2048.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ProfileArn": "string",
   "ShareId": "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.

ProfileArn

The profile ARN.

Type: String

Length Constraints: Maximum length of 2084.

Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:profile/[a-z0-9]+

ShareId

The ID associated with the share.

Type: String

Pattern: [0-9a-f]{32}

Errors

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

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The resource has already been processed, was deleted, or is too large.

HTTP Status Code: 409

InternalServerException

There is a problem with the AWS Well-Architected Tool API service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The user has reached their resource quota.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The user input is not valid.

HTTP Status Code: 400