GetImageFrame
Get an image frame (pixel data) for an image set.
Request Syntax
POST /datastore/datastoreId
/imageSet/imageSetId
/getImageFrame HTTP/1.1
Content-type: application/json
{
"imageFrameId": "string
"
}
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
Request Body
The request accepts the following data in JSON format.
- imageFrameId
-
The image frame (pixel data) identifier.
Type: String
Pattern:
[0-9a-z]{32}
Required: Yes
Response Syntax
HTTP/1.1 200
Content-Type: contentType
imageFrameBlob
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- contentType
-
The format in which the image frame information is returned to the customer. Default is
application/octet-stream
.Note
-
If the stored transfer syntax is
1.2.840.10008.1.2.1
, the returnedcontentType
isapplication/octet-stream
.
-
If the stored transfer syntax is
1.2.840.10008.1.2.4.50
, the returnedcontentType
isimage/jpeg
.
-
If the stored transfer syntax is
1.2.840.10008.1.2.4.91
, the returnedcontentType
isimage/j2c
.
-
If the stored transfer syntax is
1.2.840.10008.1.2.4.202
or if the stored transfer syntax is missing, the returnedcontentType
isimage/jph
.
-
If the stored transfer syntax is
1.2.840.10008.1.2.4.203
, the returned contentType isimage/jphc
.
-
The response returns the following as the HTTP body.
- imageFrameBlob
-
The blob containing the aggregated image frame information.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: