Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . appstream ]

describe-image-permissions

Description

Retrieves a list that describes the permissions for a private image that you own.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-image-permissions
--name <value>
[--max-results <value>]
[--shared-aws-account-ids <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

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

--max-results (integer)

The maximum size of each results page.

--shared-aws-account-ids (list)

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

Syntax:

"string" "string" ...

--next-token (string)

The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Name -> (string)

The name of the private image.

SharedImagePermissionsList -> (list)

The permissions for a private image that you own.

(structure)

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

sharedAccountId -> (string)

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

imagePermissions -> (structure)

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. If this value is empty, only the first page is retrieved.