image_sets

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

Overview

Name	image_sets
Type	Resource
Id	aws.medical_imaging.image_sets

Fields

The following fields are returned by SELECT queries:

get_image_set

Name	Datatype	Description
created_at	string (date-time)	The timestamp when image set properties were created.
datastore_id	string	The data store identifier. (pattern: <code>[0-9a-z]{32}</code>)
deleted_at	string (date-time)	The timestamp when the image set properties were deleted.
image_set_arn	string	The Amazon Resource Name (ARN) assigned to the image set. (pattern: <code>arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:medical-imaging:[a-z0-9-]+:[0-9]{12}:datastore/[0-9a-z]{32}(/imageset/[0-9a-z]{32})?</code>)
image_set_id	string	The image set identifier. (pattern: <code>[0-9a-z]{32}</code>)
image_set_state	string	The image set state. (ACTIVE, LOCKED, DELETED)
image_set_workflow_status	string	The image set workflow status. (CREATED, COPIED, COPYING, COPYING_WITH_READ_ONLY_ACCESS, COPY_FAILED, UPDATING, UPDATING_FOR_STUDY_CONSISTENCY, UPDATED, UPDATE_FAILED, DELETING, DELETED, IMPORTING, IMPORTED, IMPORT_FAILED)
is_primary	boolean	The flag to determine whether the image set is primary or not.
last_accessed_at	string (date-time)	When the image set was last accessed.
message	string	The error message thrown if an image set action fails. (pattern: <code>[\w -:`]+</code>)
overrides	object	This object contains the details of any overrides used while creating a specific image set version. If an image set was copied or updated using the force flag, this object will contain the forced flag.
storage_tier	string	The storage tier of the image set. (FREQUENT_ACCESS, ARCHIVE_INSTANT_ACCESS)
updated_at	string (date-time)	The timestamp when image set properties were updated.
version_id	string	The image set version identifier. (pattern: <code>\d+</code>)

search_image_sets

Name	Datatype	Description
dicom_tags	object	The DICOM tags associated with the image set.
created_at	string (date-time)	The time an image set is created. Sample creation date is provided in 1985-04-12T23:20:50.52Z format.
image_set_id	string	The image set identifier. (pattern: <code>[0-9a-z]{32}</code>)
is_primary	boolean	The flag to determine whether the image set is primary or not.
last_accessed_at	string (date-time)	When the image set was last accessed.
storage_tier	string	The image set's storage tier. (FREQUENT_ACCESS, ARCHIVE_INSTANT_ACCESS)
updated_at	string (date-time)	The time an image set was last updated.
version	integer	The image set version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_image_set	select	datastore_id, image_set_id, region	version	Get image set properties.
search_image_sets	select	datastore_id, region	maxResults, nextToken	Search image sets based on defined input attributes. SearchImageSets accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All date range queries must be input as (lowerBound, upperBound). By default, SearchImageSets uses the updatedAt field for sorting in descending order from newest to oldest.
delete_image_set	delete	datastore_id, image_set_id, region		Delete an image set.

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
datastore_id	string	The data store identifier.
image_set_id	string	The image set identifier.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that can be returned in a search.
nextToken	string	The token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.
version	string	The image set version identifier.

SELECT examples

get_image_set

Get image set properties.

SELECT
created_at,
datastore_id,
deleted_at,
image_set_arn,
image_set_id,
image_set_state,
image_set_workflow_status,
is_primary,
last_accessed_at,
message,
overrides,
storage_tier,
updated_at,
version_id
FROM aws.medical_imaging.image_sets
WHERE datastore_id = '{{ datastore_id }}' -- required
AND image_set_id = '{{ image_set_id }}' -- required
AND region = '{{ region }}' -- required
AND version = '{{ version }}'
;

search_image_sets

Search image sets based on defined input attributes. SearchImageSets accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All date range queries must be input as (lowerBound, upperBound). By default, SearchImageSets uses the updatedAt field for sorting in descending order from newest to oldest.

SELECT
dicom_tags,
created_at,
image_set_id,
is_primary,
last_accessed_at,
storage_tier,
updated_at,
version
FROM aws.medical_imaging.image_sets
WHERE datastore_id = '{{ datastore_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

DELETE examples

delete_image_set

Delete an image set.

DELETE FROM aws.medical_imaging.image_sets
WHERE datastore_id = '{{ datastore_id }}' --required
AND image_set_id = '{{ image_set_id }}' --required
AND region = '{{ region }}' --required
;