HealthImaging / Client / get_image_frame

get_image_frame

HealthImaging.Client.get_image_frame(**kwargs)

Get an image frame (pixel data) for an image set.

See also: AWS API Documentation

Request Syntax

response = client.get_image_frame(
    datastoreId='string',
    imageSetId='string',
    imageFrameInformation={
        'imageFrameId': 'string'
    }
)

Parameters:

• datastoreId (string) –

  [REQUIRED]

  The data store identifier.

• imageSetId (string) –

  [REQUIRED]

  The image set identifier.

• imageFrameInformation (dict) –

  [REQUIRED]

  Information about the image frame (pixel data) identifier.

  • imageFrameId (string) – [REQUIRED]

    The image frame (pixel data) identifier.

Return type:

dict

Returns:

Response Syntax

{
    'imageFrameBlob': StreamingBody(),
    'contentType': 'string'
}

Response Structure

• (dict) –

  • imageFrameBlob (StreamingBody) –

    The blob containing the aggregated image frame information.

  • contentType (string) –

    The format in which the image frame information is returned to the customer. Default is application/octet-stream.

Exceptions

• HealthImaging.Client.exceptions.ThrottlingException

• HealthImaging.Client.exceptions.ConflictException

• HealthImaging.Client.exceptions.AccessDeniedException

• HealthImaging.Client.exceptions.ValidationException

• HealthImaging.Client.exceptions.InternalServerException

• HealthImaging.Client.exceptions.ResourceNotFoundException