AWS SDK for PHP 3.x

Client: Aws\MedicalImaging\MedicalImagingClient

Service ID: medical-imaging

Version: 2023-07-19

This page describes the parameters and results for the operations of the AWS Health Imaging (2023-07-19), and shows how to use the Aws\MedicalImaging\MedicalImagingClient object to call the described operations. This documentation is specific to the 2023-07-19 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CopyImageSet ( array $params = [] ): Copy an image set.
CreateDatastore ( array $params = [] ): Create a data store.
DeleteDatastore ( array $params = [] ): Delete a data store.
DeleteImageSet ( array $params = [] ): Delete an image set.
GetDICOMImportJob ( array $params = [] ): Get the import job properties to learn more about the job or job progress.
GetDatastore ( array $params = [] ): Get data store properties.
GetImageFrame ( array $params = [] ): Get an image frame (pixel data) for an image set.
GetImageSet ( array $params = [] ): Get image set properties.
GetImageSetMetadata ( array $params = [] ): Get metadata attributes for an image set.
ListDICOMImportJobs ( array $params = [] ): List import jobs created for a specific data store.
ListDatastores ( array $params = [] ): List data stores.
ListImageSetVersions ( array $params = [] ): List image set versions.
ListTagsForResource ( array $params = [] ): Lists all tags associated with a medical imaging resource.
SearchImageSets ( array $params = [] ): Search image sets based on defined input attributes.
StartDICOMImportJob ( array $params = [] ): Start importing bulk data into an ACTIVE data store.
TagResource ( array $params = [] ): Adds a user-specifed key and value tag to a medical imaging resource.
UntagResource ( array $params = [] ): Removes tags from a medical imaging resource.
UpdateImageSetMetadata ( array $params = [] ): Update image set metadata attributes.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListDICOMImportJobs
ListDatastores
ListImageSetVersions
SearchImageSets

Operations

CopyImageSet

$result = $client->copyImageSet([/* ... */]);
$promise = $client->copyImageSetAsync([/* ... */]);

Copy an image set.

Parameter Syntax

$result = $client->copyImageSet([
    'copyImageSetInformation' => [ // REQUIRED
        'destinationImageSet' => [
            'imageSetId' => '<string>', // REQUIRED
            'latestVersionId' => '<string>', // REQUIRED
        ],
        'sourceImageSet' => [ // REQUIRED
            'latestVersionId' => '<string>', // REQUIRED
        ],
    ],
    'datastoreId' => '<string>', // REQUIRED
    'sourceImageSetId' => '<string>', // REQUIRED
]);

Parameter Details

Members

copyImageSetInformation

: Required: Yes
: Type: CopyImageSetInformation structure

Copy image set information.

datastoreId

: Required: Yes
: Type: string

The data store identifier.

sourceImageSetId

: Required: Yes
: Type: string

The source image set identifier.

Result Syntax

[
    'datastoreId' => '<string>',
    'destinationImageSetProperties' => [
        'createdAt' => <DateTime>,
        'imageSetArn' => '<string>',
        'imageSetId' => '<string>',
        'imageSetState' => 'ACTIVE|LOCKED|DELETED',
        'imageSetWorkflowStatus' => 'CREATED|COPIED|COPYING|COPYING_WITH_READ_ONLY_ACCESS|COPY_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETED',
        'latestVersionId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
    'sourceImageSetProperties' => [
        'createdAt' => <DateTime>,
        'imageSetArn' => '<string>',
        'imageSetId' => '<string>',
        'imageSetState' => 'ACTIVE|LOCKED|DELETED',
        'imageSetWorkflowStatus' => 'CREATED|COPIED|COPYING|COPYING_WITH_READ_ONLY_ACCESS|COPY_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETED',
        'latestVersionId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

destinationImageSetProperties

: Required: Yes
: Type: CopyDestinationImageSetProperties structure

The properties of the destination image set.

sourceImageSetProperties

: Required: Yes
: Type: CopySourceImageSetProperties structure

The properties of the source image set.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.
ServiceQuotaExceededException:: The request caused a service quota to be exceeded.

CreateDatastore

$result = $client->createDatastore([/* ... */]);
$promise = $client->createDatastoreAsync([/* ... */]);

Create a data store.

Parameter Syntax

$result = $client->createDatastore([
    'clientToken' => '<string>', // REQUIRED
    'datastoreName' => '<string>',
    'kmsKeyArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

clientToken

: Required: Yes
: Type: string

A unique identifier for API idempotency.

datastoreName

: Type: string

The data store name.

kmsKeyArn

: Type: string

The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags provided when creating a data store.

Result Syntax

[
    'datastoreId' => '<string>',
    'datastoreStatus' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETED',
]

Result Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

datastoreStatus

: Required: Yes
: Type: string

The data store status.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ServiceQuotaExceededException:: The request caused a service quota to be exceeded.

DeleteDatastore

$result = $client->deleteDatastore([/* ... */]);
$promise = $client->deleteDatastoreAsync([/* ... */]);

Delete a data store.

Before a data store can be deleted, you must first delete all image sets within it.

Parameter Syntax

$result = $client->deleteDatastore([
    'datastoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

Result Syntax

[
    'datastoreId' => '<string>',
    'datastoreStatus' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETED',
]

Result Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

datastoreStatus

: Required: Yes
: Type: string

The data store status.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

DeleteImageSet

$result = $client->deleteImageSet([/* ... */]);
$promise = $client->deleteImageSetAsync([/* ... */]);

Delete an image set.

Parameter Syntax

$result = $client->deleteImageSet([
    'datastoreId' => '<string>', // REQUIRED
    'imageSetId' => '<string>', // REQUIRED
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

imageSetId

: Required: Yes
: Type: string

The image set identifier.

Result Syntax

[
    'datastoreId' => '<string>',
    'imageSetId' => '<string>',
    'imageSetState' => 'ACTIVE|LOCKED|DELETED',
    'imageSetWorkflowStatus' => 'CREATED|COPIED|COPYING|COPYING_WITH_READ_ONLY_ACCESS|COPY_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETED',
]

Result Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

imageSetId

: Required: Yes
: Type: string

The image set identifier.

imageSetState

: Required: Yes
: Type: string

The image set state.

imageSetWorkflowStatus

: Required: Yes
: Type: string

The image set workflow status.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

GetDICOMImportJob

$result = $client->getDICOMImportJob([/* ... */]);
$promise = $client->getDICOMImportJobAsync([/* ... */]);

Get the import job properties to learn more about the job or job progress.

The jobStatus refers to the execution of the import job. Therefore, an import job can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.

Parameter Syntax

$result = $client->getDICOMImportJob([
    'datastoreId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

jobId

: Required: Yes
: Type: string

The import job identifier.

Result Syntax

[
    'jobProperties' => [
        'dataAccessRoleArn' => '<string>',
        'datastoreId' => '<string>',
        'endedAt' => <DateTime>,
        'inputS3Uri' => '<string>',
        'jobId' => '<string>',
        'jobName' => '<string>',
        'jobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED',
        'message' => '<string>',
        'outputS3Uri' => '<string>',
        'submittedAt' => <DateTime>,
    ],
]

Result Details

Members

jobProperties

: Required: Yes
: Type: DICOMImportJobProperties structure

The properties of the import job.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

GetDatastore

$result = $client->getDatastore([/* ... */]);
$promise = $client->getDatastoreAsync([/* ... */]);

Get data store properties.

Parameter Syntax

$result = $client->getDatastore([
    'datastoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

Result Syntax

[
    'datastoreProperties' => [
        'createdAt' => <DateTime>,
        'datastoreArn' => '<string>',
        'datastoreId' => '<string>',
        'datastoreName' => '<string>',
        'datastoreStatus' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETED',
        'kmsKeyArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members

datastoreProperties

: Required: Yes
: Type: DatastoreProperties structure

The data store properties.

Errors

ThrottlingException:: The request was denied due to throttling.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

GetImageFrame

$result = $client->getImageFrame([/* ... */]);
$promise = $client->getImageFrameAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getImageFrame([
    'datastoreId' => '<string>', // REQUIRED
    'imageFrameInformation' => [ // REQUIRED
        'imageFrameId' => '<string>', // REQUIRED
    ],
    'imageSetId' => '<string>', // REQUIRED
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

imageFrameInformation

: Required: Yes
: Type: ImageFrameInformation structure

Information about the image frame (pixel data) identifier.

imageSetId

: Required: Yes
: Type: string

The image set identifier.

Result Syntax

[
    'contentType' => '<string>',
    'imageFrameBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

contentType

: Type: string

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

imageFrameBlob

: Required: Yes
: Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The blob containing the aggregated image frame information.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

GetImageSet

$result = $client->getImageSet([/* ... */]);
$promise = $client->getImageSetAsync([/* ... */]);

Get image set properties.

Parameter Syntax

$result = $client->getImageSet([
    'datastoreId' => '<string>', // REQUIRED
    'imageSetId' => '<string>', // REQUIRED
    'versionId' => '<string>',
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

imageSetId

: Required: Yes
: Type: string

The image set identifier.

versionId

: Type: string

The image set version identifier.

Result Syntax

[
    'createdAt' => <DateTime>,
    'datastoreId' => '<string>',
    'deletedAt' => <DateTime>,
    'imageSetArn' => '<string>',
    'imageSetId' => '<string>',
    'imageSetState' => 'ACTIVE|LOCKED|DELETED',
    'imageSetWorkflowStatus' => 'CREATED|COPIED|COPYING|COPYING_WITH_READ_ONLY_ACCESS|COPY_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETED',
    'message' => '<string>',
    'updatedAt' => <DateTime>,
    'versionId' => '<string>',
]

Result Details

Members

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when image set properties were created.

datastoreId

: Required: Yes
: Type: string

The data store identifier.

deletedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the image set properties were deleted.

imageSetArn

: Type: string

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

imageSetId

: Required: Yes
: Type: string

The image set identifier.

imageSetState

: Required: Yes
: Type: string

The image set state.

imageSetWorkflowStatus

: Type: string

The image set workflow status.

message

: Type: string

The error message thrown if an image set action fails.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when image set properties were updated.

versionId

: Required: Yes
: Type: string

The image set version identifier.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

GetImageSetMetadata

$result = $client->getImageSetMetadata([/* ... */]);
$promise = $client->getImageSetMetadataAsync([/* ... */]);

Get metadata attributes for an image set.

Parameter Syntax

$result = $client->getImageSetMetadata([
    'datastoreId' => '<string>', // REQUIRED
    'imageSetId' => '<string>', // REQUIRED
    'versionId' => '<string>',
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

imageSetId

: Required: Yes
: Type: string

The image set identifier.

versionId

: Type: string

The image set version identifier.

Result Syntax

[
    'contentEncoding' => '<string>',
    'contentType' => '<string>',
    'imageSetMetadataBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

contentEncoding

: Type: string

The compression format in which image set metadata attributes are returned.

contentType

: Type: string

The format in which the study metadata is returned to the customer. Default is text/plain.

imageSetMetadataBlob

: Required: Yes
: Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The blob containing the aggregated metadata information for the image set.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

ListDICOMImportJobs

$result = $client->listDICOMImportJobs([/* ... */]);
$promise = $client->listDICOMImportJobsAsync([/* ... */]);

List import jobs created for a specific data store.

Parameter Syntax

$result = $client->listDICOMImportJobs([
    'datastoreId' => '<string>', // REQUIRED
    'jobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

jobStatus

: Type: string

The filters for listing import jobs based on status.

maxResults

: Type: int

The max results count. The upper bound is determined by load testing.

nextToken

: Type: string

The pagination token used to request the list of import jobs on the next page.

Result Syntax

[
    'jobSummaries' => [
        [
            'dataAccessRoleArn' => '<string>',
            'datastoreId' => '<string>',
            'endedAt' => <DateTime>,
            'jobId' => '<string>',
            'jobName' => '<string>',
            'jobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED',
            'message' => '<string>',
            'submittedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

jobSummaries

: Required: Yes
: Type: Array of DICOMImportJobSummary structures

A list of job summaries.

nextToken

: Type: string

The pagination token used to retrieve the list of import jobs on the next page.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

ListDatastores

$result = $client->listDatastores([/* ... */]);
$promise = $client->listDatastoresAsync([/* ... */]);

List data stores.

Parameter Syntax

$result = $client->listDatastores([
    'datastoreStatus' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETED',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

datastoreStatus

: Type: string

The data store status.

maxResults

: Type: int

Valid Range: Minimum value of 1. Maximum value of 50.

nextToken

: Type: string

The pagination token used to request the list of data stores on the next page.

Result Syntax

[
    'datastoreSummaries' => [
        [
            'createdAt' => <DateTime>,
            'datastoreArn' => '<string>',
            'datastoreId' => '<string>',
            'datastoreName' => '<string>',
            'datastoreStatus' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

datastoreSummaries

: Type: Array of DatastoreSummary structures

The list of summaries of data stores.

nextToken

: Type: string

The pagination token used to retrieve the list of data stores on the next page.

Errors

ThrottlingException:: The request was denied due to throttling.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.

ListImageSetVersions

$result = $client->listImageSetVersions([/* ... */]);
$promise = $client->listImageSetVersionsAsync([/* ... */]);

List image set versions.

Parameter Syntax

$result = $client->listImageSetVersions([
    'datastoreId' => '<string>', // REQUIRED
    'imageSetId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

imageSetId

: Required: Yes
: Type: string

The image set identifier.

maxResults

: Type: int

The max results count.

nextToken

: Type: string

The pagination token used to request the list of image set versions on the next page.

Result Syntax

[
    'imageSetPropertiesList' => [
        [
            'ImageSetWorkflowStatus' => 'CREATED|COPIED|COPYING|COPYING_WITH_READ_ONLY_ACCESS|COPY_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETED',
            'createdAt' => <DateTime>,
            'deletedAt' => <DateTime>,
            'imageSetId' => '<string>',
            'imageSetState' => 'ACTIVE|LOCKED|DELETED',
            'message' => '<string>',
            'updatedAt' => <DateTime>,
            'versionId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

imageSetPropertiesList

: Required: Yes
: Type: Array of ImageSetProperties structures

Lists all properties associated with an image set.

nextToken

: Type: string

The pagination token used to retrieve the list of image set versions on the next page.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags associated with a medical imaging resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the medical imaging resource to list tags for.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

A list of all tags associated with a medical imaging resource.

Errors

ThrottlingException:: The request was denied due to throttling.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

SearchImageSets

$result = $client->searchImageSets([/* ... */]);
$promise = $client->searchImageSetsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->searchImageSets([
    'datastoreId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'searchCriteria' => [
        'filters' => [
            [
                'operator' => 'EQUAL|BETWEEN', // REQUIRED
                'values' => [ // REQUIRED
                    [
                        'DICOMAccessionNumber' => '<string>',
                        'DICOMPatientId' => '<string>',
                        'DICOMSeriesInstanceUID' => '<string>',
                        'DICOMStudyDateAndTime' => [
                            'DICOMStudyDate' => '<string>', // REQUIRED
                            'DICOMStudyTime' => '<string>',
                        ],
                        'DICOMStudyId' => '<string>',
                        'DICOMStudyInstanceUID' => '<string>',
                        'createdAt' => <integer || string || DateTime>,
                        'updatedAt' => <integer || string || DateTime>,
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'sort' => [
            'sortField' => 'updatedAt|createdAt|DICOMStudyDateAndTime', // REQUIRED
            'sortOrder' => 'ASC|DESC', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The identifier of the data store where the image sets reside.

maxResults

: Type: int

The maximum number of results that can be returned in a search.

nextToken

: Type: 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.

searchCriteria

: Type: SearchCriteria structure

The search criteria that filters by applying a maximum of 1 item to SearchByAttribute.

Result Syntax

[
    'imageSetsMetadataSummaries' => [
        [
            'DICOMTags' => [
                'DICOMAccessionNumber' => '<string>',
                'DICOMNumberOfStudyRelatedInstances' => <integer>,
                'DICOMNumberOfStudyRelatedSeries' => <integer>,
                'DICOMPatientBirthDate' => '<string>',
                'DICOMPatientId' => '<string>',
                'DICOMPatientName' => '<string>',
                'DICOMPatientSex' => '<string>',
                'DICOMSeriesBodyPart' => '<string>',
                'DICOMSeriesInstanceUID' => '<string>',
                'DICOMSeriesModality' => '<string>',
                'DICOMSeriesNumber' => <integer>,
                'DICOMStudyDate' => '<string>',
                'DICOMStudyDescription' => '<string>',
                'DICOMStudyId' => '<string>',
                'DICOMStudyInstanceUID' => '<string>',
                'DICOMStudyTime' => '<string>',
            ],
            'createdAt' => <DateTime>,
            'imageSetId' => '<string>',
            'updatedAt' => <DateTime>,
            'version' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'sort' => [
        'sortField' => 'updatedAt|createdAt|DICOMStudyDateAndTime',
        'sortOrder' => 'ASC|DESC',
    ],
]

Result Details

Members

imageSetsMetadataSummaries

: Required: Yes
: Type: Array of ImageSetsMetadataSummary structures

The model containing the image set results.

nextToken

: Type: string

The token for pagination results.

sort

: Type: Sort structure

The sort order for image set search results.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

StartDICOMImportJob

$result = $client->startDICOMImportJob([/* ... */]);
$promise = $client->startDICOMImportJobAsync([/* ... */]);

Start importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files found in the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the file specified by the outputS3Uri parameter.

Parameter Syntax

$result = $client->startDICOMImportJob([
    'clientToken' => '<string>', // REQUIRED
    'dataAccessRoleArn' => '<string>', // REQUIRED
    'datastoreId' => '<string>', // REQUIRED
    'inputOwnerAccountId' => '<string>',
    'inputS3Uri' => '<string>', // REQUIRED
    'jobName' => '<string>',
    'outputS3Uri' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

: Required: Yes
: Type: string

A unique identifier for API idempotency.

dataAccessRoleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources.

datastoreId

: Required: Yes
: Type: string

The data store identifier.

inputOwnerAccountId

: Type: string

The account ID of the source S3 bucket owner.

inputS3Uri

: Required: Yes
: Type: string

The input prefix path for the S3 bucket that contains the DICOM files to be imported.

jobName

: Type: string

The import job name.

outputS3Uri

: Required: Yes
: Type: string

The output prefix of the S3 bucket to upload the results of the DICOM import job.

Result Syntax

[
    'datastoreId' => '<string>',
    'jobId' => '<string>',
    'jobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED',
    'submittedAt' => <DateTime>,
]

Result Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

jobId

: Required: Yes
: Type: string

The import job identifier.

jobStatus

: Required: Yes
: Type: string

The import job status.

submittedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the import job was submitted.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.
ServiceQuotaExceededException:: The request caused a service quota to be exceeded.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds a user-specifed key and value tag to a medical imaging resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the medical imaging resource that tags are being added to.

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

The user-specified key and value tag pairs added to a medical imaging resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to throttling.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a medical imaging resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the medical imaging resource that tags are being removed from.

tagKeys

: Required: Yes
: Type: Array of strings

The keys for the tags to be removed from the medical imaging resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to throttling.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.

UpdateImageSetMetadata

$result = $client->updateImageSetMetadata([/* ... */]);
$promise = $client->updateImageSetMetadataAsync([/* ... */]);

Update image set metadata attributes.

Parameter Syntax

$result = $client->updateImageSetMetadata([
    'datastoreId' => '<string>', // REQUIRED
    'imageSetId' => '<string>', // REQUIRED
    'latestVersionId' => '<string>', // REQUIRED
    'updateImageSetMetadataUpdates' => [ // REQUIRED
        'DICOMUpdates' => [
            'removableAttributes' => <string || resource || Psr\Http\Message\StreamInterface>,
            'updatableAttributes' => <string || resource || Psr\Http\Message\StreamInterface>,
        ],
    ],
]);

Parameter Details

Members

datastoreId

: Required: Yes
: Type: string

The data store identifier.

imageSetId

: Required: Yes
: Type: string

The image set identifier.

latestVersionId

: Required: Yes
: Type: string

The latest image set version identifier.

updateImageSetMetadataUpdates

: Required: Yes
: Type: MetadataUpdates structure

Update image set metadata updates.

Result Syntax

[
    'createdAt' => <DateTime>,
    'datastoreId' => '<string>',
    'imageSetId' => '<string>',
    'imageSetState' => 'ACTIVE|LOCKED|DELETED',
    'imageSetWorkflowStatus' => 'CREATED|COPIED|COPYING|COPYING_WITH_READ_ONLY_ACCESS|COPY_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETED',
    'latestVersionId' => '<string>',
    'message' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Members

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when image set metadata was created.

datastoreId

: Required: Yes
: Type: string

The data store identifier.

imageSetId

: Required: Yes
: Type: string

The image set identifier.

imageSetState

: Required: Yes
: Type: string

The image set state.

imageSetWorkflowStatus

: Type: string

The image set workflow status.

latestVersionId

: Required: Yes
: Type: string

The latest image set version identifier.

message

: Type: string

The error message thrown if an update image set metadata action fails.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when image set metadata was updated.

Errors

ThrottlingException:: The request was denied due to throttling.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
AccessDeniedException:: The user does not have sufficient access to perform this action.
ValidationException:: The input fails to satisfy the constraints set by the service.
InternalServerException:: An unexpected error occurred during processing of the request.
ResourceNotFoundException:: The request references a resource which does not exist.
ServiceQuotaExceededException:: The request caused a service quota to be exceeded.

Shapes

AccessDeniedException

Description

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

Members

message

: Required: Yes
: Type: string

ConflictException

Description

Updating or deleting a resource can cause an inconsistent state.

Members

message

: Required: Yes
: Type: string

CopyDestinationImageSet

Description

Copy the destination image set.

Members

imageSetId

: Required: Yes
: Type: string

The image set identifier for the destination image set.

latestVersionId

: Required: Yes
: Type: string

The latest version identifier for the destination image set.

CopyDestinationImageSetProperties

Description

Copy the image set properties of the destination image set.

Members

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the destination image set properties were created.

imageSetArn

: Type: string

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

imageSetId

: Required: Yes
: Type: string

The image set identifier of the copied image set properties.

imageSetState

: Type: string

The image set state of the destination image set properties.

imageSetWorkflowStatus

: Type: string

The image set workflow status of the destination image set properties.

latestVersionId

: Required: Yes
: Type: string

The latest version identifier for the destination image set properties.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the destination image set properties were last updated.

CopyImageSetInformation

Description

Copy image set information.

Members

destinationImageSet

: Type: CopyDestinationImageSet structure

The destination image set.

sourceImageSet

: Required: Yes
: Type: CopySourceImageSetInformation structure

The source image set.

CopySourceImageSetInformation

Description

Copy source image set information.

Members

latestVersionId

: Required: Yes
: Type: string

The latest version identifier for the source image set.

CopySourceImageSetProperties

Description

Copy source image set properties.

Members

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the source image set properties were created.

imageSetArn

: Type: string

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

imageSetId

: Required: Yes
: Type: string

The image set identifier for the copied source image set.

imageSetState

: Type: string

The image set state of the copied source image set.

imageSetWorkflowStatus

: Type: string

The workflow status of the copied source image set.

latestVersionId

: Required: Yes
: Type: string

The latest version identifier for the copied source image set.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the source image set properties were updated.

DICOMImportJobProperties

Description

Properties of the import job.

Members

dataAccessRoleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.

datastoreId

: Required: Yes
: Type: string

The data store identifier.

endedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the import job was ended.

inputS3Uri

: Required: Yes
: Type: string

The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported.

jobId

: Required: Yes
: Type: string

The import job identifier.

jobName

: Required: Yes
: Type: string

The import job name.

jobStatus

: Required: Yes
: Type: string

The filters for listing import jobs based on status.

message

: Type: string

The error message thrown if an import job fails.

outputS3Uri

: Required: Yes
: Type: string

The output prefix of the S3 bucket to upload the results of the DICOM import job.

submittedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the import job was submitted.

DICOMImportJobSummary

Description

Summary of import job.

Members

dataAccessRoleArn

: Type: string

The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.

datastoreId

: Required: Yes
: Type: string

The data store identifier.

endedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when an import job ended.

jobId

: Required: Yes
: Type: string

The import job identifier.

jobName

: Required: Yes
: Type: string

The import job name.

jobStatus

: Required: Yes
: Type: string

The filters for listing import jobs based on status.

message

: Type: string

The error message thrown if an import job fails.

submittedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when an import job was submitted.

DICOMStudyDateAndTime

Description

The aggregated structure to store DICOM study date and study time for search capabilities.

Members

DICOMStudyDate

: Required: Yes
: Type: string

The DICOM study date provided in yyMMdd format.

DICOMStudyTime

: Type: string

The DICOM study time provided in HHmmss.FFFFFF format.

DICOMTags

Description

The DICOM attributes returned as a part of a response. Each image set has these properties as part of a search result.

Members

DICOMAccessionNumber

: Type: string

The accession number for the DICOM study.

DICOMNumberOfStudyRelatedInstances

: Type: int

The total number of instances in the DICOM study.

DICOMNumberOfStudyRelatedSeries

: Type: int

The total number of series in the DICOM study.

DICOMPatientBirthDate

: Type: string

The patient birth date.

DICOMPatientId

: Type: string

The unique identifier for a patient in a DICOM Study.

DICOMPatientName

: Type: string

The patient name.

DICOMPatientSex

: Type: string

The patient sex.

DICOMSeriesBodyPart

: Type: string

The DICOM provided identifier for the series Body Part Examined.

DICOMSeriesInstanceUID

: Type: string

The DICOM provided identifier for the Series Instance UID.

DICOMSeriesModality

: Type: string

The DICOM provided identifier for the series Modality.

DICOMSeriesNumber

: Type: int

The DICOM provided identifier for the Series Number.

DICOMStudyDate

: Type: string

The study date.

DICOMStudyDescription

: Type: string

The DICOM provided Study Description.

DICOMStudyId

: Type: string

The DICOM provided identifier for the Study ID.

DICOMStudyInstanceUID

: Type: string

The DICOM provided identifier for the Study Instance UID.

DICOMStudyTime

: Type: string

The study time.

DICOMUpdates

Description

The object containing removableAttributes and updatableAttributes.

Members

removableAttributes

: Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The DICOM tags to be removed from ImageSetMetadata.

updatableAttributes

: Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The DICOM tags that need to be updated in ImageSetMetadata.

DatastoreProperties

Description

The properties associated with the data store.

Members

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the data store was created.

datastoreArn

: Type: string

The Amazon Resource Name (ARN) for the data store.

datastoreId

: Required: Yes
: Type: string

The data store identifier.

datastoreName

: Required: Yes
: Type: string

The data store name.

datastoreStatus

: Required: Yes
: Type: string

The data store status.

kmsKeyArn

: Type: string

The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the data store was last updated.

DatastoreSummary

Description

List of summaries of data stores.

Members

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the data store was created.

datastoreArn

: Type: string

The Amazon Resource Name (ARN) for the data store.

datastoreId

: Required: Yes
: Type: string

The data store identifier.

datastoreName

: Required: Yes
: Type: string

The data store name.

datastoreStatus

: Required: Yes
: Type: string

The data store status.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the data store was last updated.

ImageFrameInformation

Description

Information about the image frame (pixel data) identifier.

Members

imageFrameId

: Required: Yes
: Type: string

The image frame (pixel data) identifier.

ImageSetProperties

Description

The image set properties.

Members

ImageSetWorkflowStatus

: Type: string

The image set workflow status.

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the image set properties were created.

deletedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the image set properties were deleted.

imageSetId

: Required: Yes
: Type: string

The image set identifier.

imageSetState

: Required: Yes
: Type: string

The image set state.

message

: Type: string

The error message thrown if an image set action fails.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the image set properties were updated.

versionId

: Required: Yes
: Type: string

The image set version identifier.

ImageSetsMetadataSummary

Description

Summary of the image set metadata.

Members

DICOMTags

: Type: DICOMTags structure

The DICOM tags associated with the image set.

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time an image set is created. Sample creation date is provided in 1985-04-12T23:20:50.52Z format.

imageSetId

: Required: Yes
: Type: string

The image set identifier.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time an image set was last updated.

version

: Type: int

The image set version.

InternalServerException

Description

An unexpected error occurred during processing of the request.

Members

message

: Required: Yes
: Type: string

MetadataUpdates

Description

Contains DICOMUpdates.

Members

DICOMUpdates

: Type: DICOMUpdates structure

The object containing removableAttributes and updatableAttributes.

ResourceNotFoundException

Description

The request references a resource which does not exist.

Members

message

: Required: Yes
: Type: string

SearchByAttributeValue

Description

The search input attribute value.

Members

DICOMAccessionNumber

: Type: string

The DICOM accession number for search.

DICOMPatientId

: Type: string

The patient ID input for search.

DICOMSeriesInstanceUID

: Type: string

The Series Instance UID input for search.

DICOMStudyDateAndTime

: Type: DICOMStudyDateAndTime structure

The aggregated structure containing DICOM study date and study time for search.

DICOMStudyId

: Type: string

The DICOM study ID for search.

DICOMStudyInstanceUID

: Type: string

The DICOM study instance UID for search.

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The created at time of the image set provided for search.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp input for search.

SearchCriteria

Description

The search criteria.

Members

filters

: Type: Array of SearchFilter structures

The filters for the search criteria.

sort

: Type: Sort structure

The sort input for search criteria.

Description

The search filter.

Members

operator

: Required: Yes
: Type: string

The search filter operator for imageSetDateTime.

values

: Required: Yes
: Type: Array of SearchByAttributeValue structures

The search filter values.

ServiceQuotaExceededException

Description

The request caused a service quota to be exceeded.

Members

message

: Required: Yes
: Type: string

Sort

Description

Sort search results.

Members

sortField

: Required: Yes
: Type: string

The sort field for search criteria.

sortOrder

: Required: Yes
: Type: string

The sort order for search criteria.

ThrottlingException

Description

The request was denied due to throttling.

Members

message

: Required: Yes
: Type: string

ValidationException

Description

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

Members

message

: Required: Yes
: Type: string

AWS Health Imaging 2023-07-19

Operation Summary

Paginators

Operations

CopyImageSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDatastore

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteDatastore

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteImageSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetDICOMImportJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetDatastore

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetImageFrame

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetImageSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetImageSetMetadata

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListDICOMImportJobs

Parameter Syntax

Parameter Details

Members