AWS Well-Architected Tool

Updates whether the Amazon Web Services account is opted into organization sharing features.

See also: AWS API Documentation

Request Syntax

client.update_global_settings(
    OrganizationSharingStatus='ENABLED'|'DISABLED'
)

type OrganizationSharingStatus:

string

param OrganizationSharingStatus:

The status of organization sharing settings.

returns:

None

{'Status': 'ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | '
           'ASSOCIATED | FAILED'}

{'LensShareSummaries': {'Status': {'ASSOCIATED', 'ASSOCIATING', 'FAILED'},
                        'StatusMessage': 'string'}}

List the lens shares associated with the lens.

See also: AWS API Documentation

Request Syntax

client.list_lens_shares(
    LensAlias='string',
    SharedWithPrefix='string',
    NextToken='string',
    MaxResults=123,
    Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED'
)

type LensAlias:

string

param LensAlias:

[REQUIRED]

The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-west-2::lens/serverless.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens.

Each lens is identified by its LensSummary$LensAlias.

type SharedWithPrefix:

string

param SharedWithPrefix:

The Amazon Web Services account ID or IAM role with which the lens is shared.

type NextToken:

string

param NextToken:

The token to use to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return for this request.

type Status:

string

param Status:

The status of a workload share.

rtype:

dict

returns:

Response Syntax

{
    'LensShareSummaries': [
        {
            'ShareId': 'string',
            'SharedWith': 'string',
            'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
            'StatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • LensShareSummaries (list) --

    A list of lens share summaries.

    • (dict) --

      A lens share summary return object.

      • ShareId (string) --

        The ID associated with the workload share.

      • SharedWith (string) --

        The Amazon Web Services account ID or IAM role with which the workload is shared.

      • Status (string) --

        The status of a workload share.

      • StatusMessage (string) --

        Optional message to compliment the Status field.

  • NextToken (string) --

    The token to use to retrieve the next set of results.

{'Status': 'ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | '
           'ASSOCIATED | FAILED'}

{'WorkloadShareSummaries': {'Status': {'ASSOCIATED', 'ASSOCIATING', 'FAILED'},
                            'StatusMessage': 'string'}}

List the workload shares associated with the workload.

See also: AWS API Documentation

Request Syntax

client.list_workload_shares(
    WorkloadId='string',
    SharedWithPrefix='string',
    NextToken='string',
    MaxResults=123,
    Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED'
)

type WorkloadId:

string

param WorkloadId:

[REQUIRED]

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type SharedWithPrefix:

string

param SharedWithPrefix:

The Amazon Web Services account ID or IAM role with which the workload is shared.

type NextToken:

string

param NextToken:

The token to use to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return for this request.

type Status:

string

param Status:

The status of a workload share.

rtype:

dict

returns:

Response Syntax

{
    'WorkloadId': 'string',
    'WorkloadShareSummaries': [
        {
            'ShareId': 'string',
            'SharedWith': 'string',
            'PermissionType': 'READONLY'|'CONTRIBUTOR',
            'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
            'StatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  Input for List Workload Share

  • WorkloadId (string) --

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

  • WorkloadShareSummaries (list) --

    A list of workload share summaries.

    • (dict) --

      A workload share summary return object.

      • ShareId (string) --

        The ID associated with the workload share.

      • SharedWith (string) --

        The Amazon Web Services account ID or IAM role with which the workload is shared.

      • PermissionType (string) --

        Permission granted on a workload share.

      • Status (string) --

        The status of a workload share.

      • StatusMessage (string) --

        Optional message to compliment the Status field.

  • NextToken (string) --

    The token to use to retrieve the next set of results.

{'WorkloadShare': {'Status': {'ASSOCIATED', 'ASSOCIATING', 'FAILED'}}}

Update a workload share.

See also: AWS API Documentation

Request Syntax

client.update_workload_share(
    ShareId='string',
    WorkloadId='string',
    PermissionType='READONLY'|'CONTRIBUTOR'
)

type ShareId:

string

param ShareId:

[REQUIRED]

The ID associated with the workload share.

type WorkloadId:

string

param WorkloadId:

[REQUIRED]

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type PermissionType:

string

param PermissionType:

[REQUIRED]

Permission granted on a workload share.

rtype:

dict

returns:

Response Syntax

{
    'WorkloadId': 'string',
    'WorkloadShare': {
        'ShareId': 'string',
        'SharedBy': 'string',
        'SharedWith': 'string',
        'PermissionType': 'READONLY'|'CONTRIBUTOR',
        'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
        'WorkloadName': 'string',
        'WorkloadId': 'string'
    }
}

Response Structure

• (dict) --

  Input for Update Workload Share

  • WorkloadId (string) --

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

  • WorkloadShare (dict) --

    A workload share return object.

    • ShareId (string) --

      The ID associated with the workload share.

    • SharedBy (string) --

      An Amazon Web Services account ID.

    • SharedWith (string) --

      The Amazon Web Services account ID or IAM role with which the workload is shared.

    • PermissionType (string) --

      Permission granted on a workload share.

    • Status (string) --

      The status of a workload share.

    • WorkloadName (string) --

      The name of the workload.

      The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

    • WorkloadId (string) --

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.