CreateTemplateShare
Create a review template share.
The owner of a review template can share it with other AWS accounts, users, an organization, and organizational units (OUs) in the same AWS Region.
Shared access to a review template is not removed until the review template share invitation is deleted.
If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.
Note
Disclaimer
By sharing your review template with other AWS accounts, you acknowledge that AWS will make your review template available to those other accounts.
Request Syntax
POST /templates/shares/TemplateArn HTTP/1.1
Content-type: application/json
{
"ClientRequestToken": "string",
"SharedWith": "string"
}URI Request Parameters
The request uses the following URI parameters.
-
The review template ARN.
Length Constraints: Minimum length of 50. Maximum length of 250.
Pattern:
arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32}Required: Yes
Request Body
The request accepts the following data in JSON format.
-
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.
Pattern:
^[\x00-\x7F]*$Required: Yes
-
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
{
"ShareId": "string",
"TemplateArn": "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.
-
The ID associated with the share.
Type: String
Pattern:
[0-9a-f]{32} -
The review template ARN.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 250.
Pattern:
arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
