WorkSpaces / Client / describe_workspace_image_permissions

describe_workspace_image_permissions#

WorkSpaces.Client.describe_workspace_image_permissions(**kwargs)#

Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspace_image_permissions(
    ImageId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ImageId (string) –

    [REQUIRED]

    The identifier of the image.

  • NextToken (string) – If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • MaxResults (integer) – The maximum number of items to return.

Return type:

dict

Returns:

Response Syntax

{
    'ImageId': 'string',
    'ImagePermissions': [
        {
            'SharedAccountId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ImageId (string) –

      The identifier of the image.

    • ImagePermissions (list) –

      The identifiers of the Amazon Web Services accounts that the image has been shared with.

      • (dict) –

        Describes the Amazon Web Services accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.

        • SharedAccountId (string) –

          The identifier of the Amazon Web Services account that an image has been shared with.

    • NextToken (string) –

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions