API for AWS Health Imaging¶

ABAP Package	`/AWS1/API_MIG_IMPL`
ABAP SDK "TLA"	`MIG`
ABAP Interface	`/AWS1/IF_MIG`

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for AWS Health Imaging is MIG. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation¶

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the Medical Imaging module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service¶

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA eligible service that empowers healthcare providers, life science organizations, and their software partners to store, analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the AWS HealthImaging Developer Guide .

We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see Tools to build on AWS.

The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the AWS HealthImaging Developer Guide where you can view tested code examples.

Data store actions

CreateDatastore – See Creating a data store.
GetDatastore – See Getting data store properties.
ListDatastores – See Listing data stores.
DeleteDatastore – See Deleting a data store.

Import job actions

StartDICOMImportJob – See Starting an import job.
GetDICOMImportJob – See Getting import job properties.
ListDICOMImportJobs – See Listing import jobs.

Image set access actions

SearchImageSets – See Searching image sets.
GetImageSet – See Getting image set properties.
GetImageSetMetadata – See Getting image set metadata.
GetImageFrame – See Getting image set pixel data.

Image set modification actions

ListImageSetVersions – See Listing image set versions.
UpdateImageSetMetadata – See Updating image set metadata.
CopyImageSet – See Copying an image set.
DeleteImageSet – See Deleting an image set.

Tagging actions

TagResource – See Tagging a resource.
ListTagsForResource – See Listing tags for a resource.
UntagResource – See Untagging a resource.

Using the SDK¶

In your code, create a client using the SDK module for AWS Health Imaging, which is created with factory method /AWS1/CL_MIG_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_mig)       = /aws1/cl_mig_factory=>create( go_session ).

Your variable go_mig is an instance of /AWS1/IF_MIG, and all of the operations in the AWS Health Imaging service are accessed by calling methods in /AWS1/IF_MIG.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS Health Imaging, see the Operation List.

Factory Method¶

`/AWS1/CL_MIG_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_MIG.

IMPORTING¶

Optional arguments:¶

`IV_PROTOCOL` `TYPE /AWS1/RT_PROTOCOL` `/AWS1/RT_PROTOCOL`¶

`IO_SESSION` `TYPE REF TO /AWS1/CL_RT_SESSION_BASE` `/AWS1/CL_RT_SESSION_BASE`¶

`IV_REGION` `TYPE /AWS1/RT_REGION_ID` `/AWS1/RT_REGION_ID`¶

`IV_CUSTOM_ENDPOINT` `TYPE /AWS1/RT_ENDPOINT` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`OO_CLIENT` `TYPE REF TO /AWS1/IF_MIG` `/AWS1/IF_MIG`¶

/AWS1/IF_MIG represents the ABAP client for the Medical Imaging service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically¶

DATA(lo_config) = DATA(go_mig)->get_config( ).

lo_config is a variable of type /AWS1/CL_MIG_CONFIG. See the documentation for /AWS1/CL_MIG_CONFIG for details on the settings that can be configured.

Paginators¶

Paginators for AWS Health Imaging can be created via get_paginator() which returns a paginator object of type /AWS1/IF_MIG_PAGINATOR. The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using has_next() and get_next() methods.

Details about the paginator methods available for service AWS Health Imaging can be found in interface /AWS1/IF_MIG_PAGINATOR.