DescribeWorkspaceImagePermissions

Describes the permissions that the owner of an image has granted to other AWS accounts for an image.

Request Syntax


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

The request accepts the following data in JSON format.

The identifier of the image.

Type: String

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

Required: Yes

The maximum number of items to return.

Type: Integer

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

Required: No

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


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

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

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

The identifier of the image.

Type: String

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

The identifiers of the AWS accounts that the image has been shared with.

Type: Array of ImagePermission objects

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.

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