DescribeWorkspaceImagePermissions - Amazon WorkSpaces Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeWorkspaceImagePermissions

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

Request Syntax

{ "ImageId": "string", "MaxResults": number, "NextToken": "string" }

Request Parameters

The request accepts the following data in JSON format.

ImageId

The identifier of the image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

Required: Yes

MaxResults

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ImageId

The identifier of the image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

ImagePermissions

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

Type: Array of ImagePermission objects

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: