WellArchitected / Client / create_template_share

create_template_share#

WellArchitected.Client.create_template_share(**kwargs)#

Create a review template share.

The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services 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 Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.

See also: AWS API Documentation

Request Syntax

response = client.create_template_share(
    TemplateArn='string',
    SharedWith='string',
    ClientRequestToken='string'
)
Parameters:

  • TemplateArn (string) –

    [REQUIRED]

    The review template ARN.

  • SharedWith (string) –

    [REQUIRED]

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

  • ClientRequestToken (string) –

    [REQUIRED]

    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.

    Warning

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

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'TemplateArn': 'string',
    'ShareId': 'string'
}

Response Structure

  • (dict) –

    • TemplateArn (string) –

      The review template ARN.

    • ShareId (string) –

      The ID associated with the share.

Exceptions