image_permissions

Creates, updates, deletes, gets or lists an image_permissions resource.

Overview

Name	image_permissions
Type	Resource
Id	aws.appstream.image_permissions

Fields

The following fields are returned by SELECT queries:

describe_image_permissions

Name	Datatype	Description
name	string	The name of the private image. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$</code>)
next_token	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.
shared_image_permissions_list	array	The permissions for a private image that you own.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_image_permissions	select	region		Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
update_image_permissions	update	region, SharedAccountId, ImagePermissions		Adds or updates permissions for the specified private image.
delete_image_permissions	delete	region		Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_image_permissions

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

SELECT
name,
next_token,
shared_image_permissions_list
FROM aws.appstream.image_permissions
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_image_permissions

Adds or updates permissions for the specified private image.

UPDATE aws.appstream.image_permissions
SET 
Name = '{{ Name }}',
SharedAccountId = '{{ SharedAccountId }}',
ImagePermissions = '{{ ImagePermissions }}'
WHERE 
region = '{{ region }}' --required
AND SharedAccountId = '{{ SharedAccountId }}' --required
AND ImagePermissions = '{{ ImagePermissions }}' --required;

DELETE examples

delete_image_permissions

Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.

DELETE FROM aws.appstream.image_permissions
WHERE region = '{{ region }}' --required
;