WellArchitected / Client / update_workload_share

update_workload_share#

WellArchitected.Client.update_workload_share(**kwargs)#

Update a workload share.

See also: AWS API Documentation

Request Syntax

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

  • ShareId (string) –

    [REQUIRED]

    The ID associated with the workload share.

  • WorkloadId (string) –

    [REQUIRED]

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

  • PermissionType (string) –

    [REQUIRED]

    Permission granted on a workload share.

Return type:

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, IAM role, organization ID, or organizational unit (OU) ID 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.

Exceptions

  • WellArchitected.Client.exceptions.ValidationException

  • WellArchitected.Client.exceptions.InternalServerException

  • WellArchitected.Client.exceptions.ResourceNotFoundException

  • WellArchitected.Client.exceptions.ConflictException

  • WellArchitected.Client.exceptions.AccessDeniedException

  • WellArchitected.Client.exceptions.ThrottlingException