describe_image_permissions

describe_image_permissions(**kwargs)

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

See also: AWS API Documentation

Request Syntax

response = client.describe_image_permissions(
    Name='string',
    MaxResults=123,
    SharedAwsAccountIds=[
        'string',
    ],
    NextToken='string'
)

Parameters

• Name (string) --

  [REQUIRED]

  The name of the private image for which to describe permissions. The image must be one that you own.

• MaxResults (integer) -- The maximum size of each page of results.
• SharedAwsAccountIds (list) --

  The 12-digit identifier of one or more AWS accounts with which the image is shared.

  • (string) --
• NextToken (string) -- The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Return type

dict

Returns

Response Syntax

{
    'Name': 'string',
    'SharedImagePermissionsList': [
        {
            'sharedAccountId': 'string',
            'imagePermissions': {
                'allowFleet': True|False,
                'allowImageBuilder': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Name (string) --

    The name of the private image.

  • SharedImagePermissionsList (list) --

    The permissions for a private image that you own.

    • (dict) --

      Describes the permissions that are available to the specified AWS account for a shared image.

      • sharedAccountId (string) --

        The 12-digit identifier of the AWS account with which the image is shared.

      • imagePermissions (dict) --

        Describes the permissions for a shared image.

        • allowFleet (boolean) --

          Indicates whether the image can be used for a fleet.

        • allowImageBuilder (boolean) --

          Indicates whether the image can be used for an image builder.

  • NextToken (string) --

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Exceptions

• AppStream.Client.exceptions.ResourceNotFoundException