Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetImageSet

Get image set properties.

Request Syntax


POST /datastore/datastoreId/imageSet/imageSetId/getImageSet?version=versionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

datastoreId

The data store identifier.

Pattern: [0-9a-z]{32}

Required: Yes

imageSetId

The image set identifier.

Pattern: [0-9a-z]{32}

Required: Yes

versionId

The image set version identifier.

Pattern: \d+

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "datastoreId": "string",
   "deletedAt": number,
   "imageSetArn": "string",
   "imageSetId": "string",
   "imageSetState": "string",
   "imageSetWorkflowStatus": "string",
   "message": "string",
   "overrides": { 
      "forced": boolean
   },
   "updatedAt": number,
   "versionId": "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.

createdAt

The timestamp when image set properties were created.

Type: Timestamp

datastoreId

The data store identifier.

Type: String

Pattern: [0-9a-z]{32}

deletedAt

The timestamp when the image set properties were deleted.

Type: Timestamp

imageSetArn

The Amazon Resource Name (ARN) assigned to the image set.

Type: String

Pattern: 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})?

imageSetId

The image set identifier.

Type: String

Pattern: [0-9a-z]{32}

imageSetState

The image set state.

Type: String

Valid Values: ACTIVE | LOCKED | DELETED

imageSetWorkflowStatus

The image set workflow status.

Type: String

message

The error message thrown if an image set action fails.

Type: String

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

Pattern: [\w -:]+

overrides

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.

Type: Overrides object

updatedAt

The timestamp when image set properties were updated.

Type: Timestamp

versionId

The image set version identifier.

Type: String

Pattern: \d+

Errors

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

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints set by the service.

HTTP Status Code: 400