profile_shares

Creates, updates, deletes, gets or lists a profile_shares resource.

Overview

Name	profile_shares
Type	Resource
Id	aws.wellarchitected.profile_shares

Fields

The following fields are returned by SELECT queries:

list_profile_shares

Name	Datatype	Description
next_token	string	The token to use to retrieve the next set of results. (pattern: <code>[A-Za-z0-9+/=_-]+</code>)
profile_share_summaries	array	Profile share summaries.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_profile_shares	select	profile_arn, region	SharedWithPrefix, NextToken, MaxResults, Status	List profile shares.
create_profile_share	insert	profile_arn, region, SharedWith, ClientRequestToken		Create a profile share.
delete_profile_share	delete	share_id, profile_arn, ClientRequestToken, region		Delete a profile share.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ClientRequestToken	string
profile_arn	string	The profile ARN.
region	string	AWS region (default: us-east-1)
share_id	string
MaxResults	integer	The maximum number of results to return for this request.
NextToken	string
SharedWithPrefix	string	The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.
Status	string

SELECT examples

list_profile_shares

List profile shares.

SELECT
next_token,
profile_share_summaries
FROM aws.wellarchitected.profile_shares
WHERE profile_arn = '{{ profile_arn }}' -- required
AND region = '{{ region }}' -- required
AND SharedWithPrefix = '{{ SharedWithPrefix }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND Status = '{{ Status }}'
;

INSERT examples

create_profile_share

Create a profile share.

INSERT INTO aws.wellarchitected.profile_shares (
SharedWith,
ClientRequestToken,
profile_arn,
region
)
SELECT 
'{{ SharedWith }}' /* required */,
'{{ ClientRequestToken }}' /* required */,
'{{ profile_arn }}',
'{{ region }}'
RETURNING
profile_arn,
share_id
;

Manifest

# Description fields are for documentation purposes
- name: profile_shares
props:
  - name: profile_arn
    value: "{{ profile_arn }}"
    description: Required parameter for the profile_shares resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the profile_shares resource.
  - name: SharedWith
    value: "{{ SharedWith }}"
    description: |
      The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
    description: |
      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. 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.

DELETE examples

delete_profile_share

Delete a profile share.

DELETE FROM aws.wellarchitected.profile_shares
WHERE share_id = '{{ share_id }}' --required
AND profile_arn = '{{ profile_arn }}' --required
AND ClientRequestToken = '{{ ClientRequestToken }}' --required
AND region = '{{ region }}' --required
;