# Managing data stores with AWS HealthImaging
With AWS HealthImaging, you create and manage [data stores](getting-started-concepts.md#concept-data-store) for medical image resources. The following topics describe how to use HealthImaging cloud native actions to create, describe, list, and delete data stores using the AWS Management Console, AWS CLI, and AWS SDKs.
**Note**
The last topic in this chapter is about [cost optimization](cost-optimization.md). After you import your medical imaging data into a HealthImaging data store, it automatically moves between two storage tiers based on time and usage. The storage tiers have different pricing levels, so it's important to understand the tier movement process and the HealthImaging resources that are recognized for billing purposes.
**Topics**
+ [Creating a data store](create-data-store.md)
+ [Getting data store properties](get-data-store.md)
+ [Listing data stores](list-data-stores.md)
+ [Deleting a data store](delete-data-store.md)
# Creating a data store
Use the `CreateDatastore` action to create an AWS HealthImaging [data store](getting-started-concepts.md#concept-data-store) for importing DICOM P10 files. The following menus provide a procedure for the AWS Management Console and code examples for the AWS CLI and AWS SDKs. For more information, see [https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CreateDatastore.html](https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CreateDatastore.html) in the *AWS HealthImaging API Reference*. When you create a data store, you can select the default transfer syntax that AWS HealthImaging used to transcode and store lossless image frames. This configuration cannot be changed after the data store is created.
**High Throughput JPEG 2000 (HTJ2K)**
HTJ2K (High Throughput JPEG 2000) is the default storage format for HealthImaging datastores. It is an extension of the JPEG 2000 standard that offers significantly improved encoding and decoding performance. When you create a datastore without specifying a `—lossless-storage-format`, HealthImaging automatically uses HTJ2K. See the *AWS CLI and SDKs* section below for creating a data store using HTJ2K.
**JPEG 2000 Lossless**
JPEG 2000 Lossless encoding allows creation of datastores that persist and retrieve lossless image frames in JPEG 2000 format without transcoding, enabling lower latency retrieval for applications that require JPEG 2000 Lossless (DICOM Transfer Syntax UID 1.2.840.10008.1.2.4.90) see [Supported transfer syntaxes](supported-transfer-syntaxes.md) for more details. See the *AWS CLI and SDKs* section below for creating a data store using JPEG 2000 lossless format.
**Important**
Do not name data stores with protected health information (PHI), personally identifiable information (PII), or other confidential or sensitive information.
The AWS Console supports creation of data stores with default settings. Use the AWS CLI or AWS SDK to create a data store with an optional `—lossless-storage-format` specified.
**To create a data store**
Choose a menu based on your access preference to AWS HealthImaging.
## AWS Console
1. Open the HealthImaging console [Create data store page](https://console.aws.amazon.com/medical-imaging/home#/dataStores/create).
1. Under **Details**, for **Data store name**, enter a name for your data store.
1. Under **Data encryption**, choose an AWS KMS key for encrypting your resources. For more information, see [Data protection in AWS HealthImaging](data-protection.md).
1. Under **Tags - *optional***, you can add tags to your data store when you create it. For more information, see [Tagging a resource](tag-resource.md).
1. Choose **Create data store**.
## AWS CLI and SDKs
------
#### [ Bash ]
**AWS CLI with Bash script**
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function imaging_create_datastore
#
# This function creates an AWS HealthImaging data store for importing DICOM P10 files.
#
# Parameters:
# -n data_store_name - The name of the data store.
#
# Returns:
# The datastore ID.
# And:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function imaging_create_datastore() {
local datastore_name response
local option OPTARG # Required to use getopts command in a function.
# bashsupport disable=BP5008
function usage() {
echo "function imaging_create_datastore"
echo "Creates an AWS HealthImaging data store for importing DICOM P10 files."
echo " -n data_store_name - The name of the data store."
echo ""
}
# Retrieve the calling parameters.
while getopts "n:h" option; do
case "${option}" in
n) datastore_name="${OPTARG}" ;;
h)
usage
return 0
;;
\?)
echo "Invalid parameter"
usage
return 1
;;
esac
done
export OPTIND=1
if [[ -z "$datastore_name" ]]; then
errecho "ERROR: You must provide a data store name with the -n parameter."
usage
return 1
fi
response=$(aws medical-imaging create-datastore \
--datastore-name "$datastore_name" \
--output text \
--query 'datastoreId')
local error_code=${?}
if [[ $error_code -ne 0 ]]; then
aws_cli_error_log $error_code
errecho "ERROR: AWS reports medical-imaging create-datastore operation failed.$response"
return 1
fi
echo "$response"
return 0
}
```
+ For API details, see [CreateDatastore](https://docs.aws.amazon.com/goto/aws-cli/medical-imaging-2023-07-19/CreateDatastore) in *AWS CLI Command Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/medical-imaging#code-examples).
------
#### [ CLI ]
**AWS CLI**
**Example 1: To create a data store**
The following `create-datastore` code example creates a data store with the name `my-datastore`. When you create a datastore without specifying a `--lossless-storage-format`, AWS HealthImaging defaults to HTJ2K (High Throughput JPEG 2000).
```
aws medical-imaging create-datastore \
--datastore-name "my-datastore"
```
Output:
```
{
"datastoreId": "12345678901234567890123456789012",
"datastoreStatus": "CREATING"
}
```
**Example 2: To create a data store with JPEG 2000 Lossless storage format**
A data store configured with JPEG 2000 Lossless storage format will transcode and persist lossless image frames in JPEG 2000 format. Image frames can then be retrieved in JPEG 2000 Lossless without transcoding. The following `create-datastore` code example creates a data store configured for JPEG 2000 Lossless storage format with the name `my-datastore`.
```
aws medical-imaging create-datastore \
--datastore-name "my-datastore" \
--lossless-storage-format JPEG_2000_LOSSLESS
```
Output:
```
{
"datastoreId": "12345678901234567890123456789012",
"datastoreStatus": "CREATING"
}
```
+ For API details, see [CreateDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/create-datastore.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
```
public static String createMedicalImageDatastore(MedicalImagingClient medicalImagingClient,
String datastoreName) {
try {
CreateDatastoreRequest datastoreRequest = CreateDatastoreRequest.builder()
.datastoreName(datastoreName)
.build();
CreateDatastoreResponse response = medicalImagingClient.createDatastore(datastoreRequest);
return response.datastoreId();
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
```
+ For API details, see [CreateDatastore](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/CreateDatastore) in *AWS SDK for Java 2.x API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
```
import { CreateDatastoreCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreName - The name of the data store to create.
*/
export const createDatastore = async (datastoreName = "DATASTORE_NAME") => {
const response = await medicalImagingClient.send(
new CreateDatastoreCommand({ datastoreName: datastoreName }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'a71cd65f-2382-49bf-b682-f9209d8d399b',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// datastoreId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
// datastoreStatus: 'CREATING'
// }
return response;
};
```
+ For API details, see [CreateDatastore](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/CreateDatastoreCommand) in *AWS SDK for JavaScript API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK for Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def create_datastore(self, name):
"""
Create a data store.
:param name: The name of the data store to create.
:return: The data store ID.
"""
try:
data_store = self.health_imaging_client.create_datastore(datastoreName=name)
except ClientError as err:
logger.error(
"Couldn't create data store %s. Here's why: %s: %s",
name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return data_store["datastoreId"]
```
The following code instantiates the MedicalImagingWrapper object.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ For API details, see [CreateDatastore](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/CreateDatastore) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
```
TRY.
" iv_datastore_name = 'my-datastore-name'
oo_result = lo_mig->createdatastore( iv_datastorename = iv_datastore_name ).
DATA(lv_datastore_id) = oo_result->get_datastoreid( ).
MESSAGE 'Data store created.' TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict. Data store may already exist.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migservicequotaexcdex.
MESSAGE 'Service quota exceeded.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [CreateDatastore](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.
# Getting data store properties
Use the `GetDatastore` action to retrieve AWS HealthImaging [data store](getting-started-concepts.md#concept-data-store) properties. The following menus provide a procedure for the AWS Management Console and code examples for the AWS CLI and AWS SDKs. For more information, see [https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDatastore.html](https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDatastore.html) in the [https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDatastore.html](https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDatastore.html).
**To get data store properties**
Choose a menu based on your access preference to AWS HealthImaging.
## AWS Console
1. Open the HealthImaging console [Data stores page](https://console.aws.amazon.com/medical-imaging/home#/dataStores).
1. Choose a data store.
The **Data store details** page opens. Under the **Details** section, all data store properties are available. To view associated image sets, imports, and tags, choose the applicable tab.
## AWS CLI and SDKs
------
#### [ Bash ]
**AWS CLI with Bash script**
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function imaging_get_datastore
#
# Get a data store's properties.
#
# Parameters:
# -i data_store_id - The ID of the data store.
#
# Returns:
# [datastore_name, datastore_id, datastore_status, datastore_arn, created_at, updated_at]
# And:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function imaging_get_datastore() {
local datastore_id option OPTARG # Required to use getopts command in a function.
local error_code
# bashsupport disable=BP5008
function usage() {
echo "function imaging_get_datastore"
echo "Gets a data store's properties."
echo " -i datastore_id - The ID of the data store."
echo ""
}
# Retrieve the calling parameters.
while getopts "i:h" option; do
case "${option}" in
i) datastore_id="${OPTARG}" ;;
h)
usage
return 0
;;
\?)
echo "Invalid parameter"
usage
return 1
;;
esac
done
export OPTIND=1
if [[ -z "$datastore_id" ]]; then
errecho "ERROR: You must provide a data store ID with the -i parameter."
usage
return 1
fi
local response
response=$(
aws medical-imaging get-datastore \
--datastore-id "$datastore_id" \
--output text \
--query "[ datastoreProperties.datastoreName, datastoreProperties.datastoreId, datastoreProperties.datastoreStatus, datastoreProperties.datastoreArn, datastoreProperties.createdAt, datastoreProperties.updatedAt]"
)
error_code=${?}
if [[ $error_code -ne 0 ]]; then
aws_cli_error_log $error_code
errecho "ERROR: AWS reports list-datastores operation failed.$response"
return 1
fi
echo "$response"
return 0
}
```
+ For API details, see [GetDatastore](https://docs.aws.amazon.com/goto/aws-cli/medical-imaging-2023-07-19/GetDatastore) in *AWS CLI Command Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/medical-imaging#code-examples).
------
#### [ CLI ]
**AWS CLI**
**Example 1: To get a data store's properties**
The following `get-datastore` code example gets a data store's properties.
```
aws medical-imaging get-datastore \
--datastore-id 12345678901234567890123456789012
```
Output:
```
{
"datastoreProperties": {
"datastoreId": "12345678901234567890123456789012",
"datastoreName": "TestDatastore123",
"datastoreStatus": "ACTIVE",
"losslessStorageFormat": "HTJ2K"
"datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012",
"createdAt": "2022-11-15T23:33:09.643000+00:00",
"updatedAt": "2022-11-15T23:33:09.643000+00:00"
}
}
```
**Example 2: To get data store's properties configured for JPEG2000**
The following `get-datastore` code example gets a data store's properties for a data store configured for JPEG 2000 Lossless storage format.
```
aws medical-imaging get-datastore \
--datastore-id 12345678901234567890123456789012
```
Output:
```
{
"datastoreProperties": {
"datastoreId": "12345678901234567890123456789012",
"datastoreName": "TestDatastore123",
"datastoreStatus": "ACTIVE",
"losslessStorageFormat": "JPEG_2000_LOSSLESS",
"datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012",
"createdAt": "2022-11-15T23:33:09.643000+00:00",
"updatedAt": "2022-11-15T23:33:09.643000+00:00"
}
}
```
+ For API details, see [GetDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-datastore.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
```
public static DatastoreProperties getMedicalImageDatastore(MedicalImagingClient medicalImagingClient,
String datastoreID) {
try {
GetDatastoreRequest datastoreRequest = GetDatastoreRequest.builder()
.datastoreId(datastoreID)
.build();
GetDatastoreResponse response = medicalImagingClient.getDatastore(datastoreRequest);
return response.datastoreProperties();
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return null;
}
```
+ For API details, see [GetDatastore](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/GetDatastore) in *AWS SDK for Java 2.x API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
```
import { GetDatastoreCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreID - The ID of the data store.
*/
export const getDatastore = async (datastoreID = "DATASTORE_ID") => {
const response = await medicalImagingClient.send(
new GetDatastoreCommand({ datastoreId: datastoreID }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '55ea7d2e-222c-4a6a-871e-4f591f40cadb',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// datastoreProperties: {
// createdAt: 2023-08-04T18:50:36.239Z,
// datastoreArn: 'arn:aws:medical-imaging:us-east-1:xxxxxxxxx:datastore/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
// datastoreId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
// datastoreName: 'my_datastore',
// datastoreStatus: 'ACTIVE',
// updatedAt: 2023-08-04T18:50:36.239Z
// }
// }
return response.datastoreProperties;
};
```
+ For API details, see [GetDatastore](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/GetDatastoreCommand) in *AWS SDK for JavaScript API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK for Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def get_datastore_properties(self, datastore_id):
"""
Get the properties of a data store.
:param datastore_id: The ID of the data store.
:return: The data store properties.
"""
try:
data_store = self.health_imaging_client.get_datastore(
datastoreId=datastore_id
)
except ClientError as err:
logger.error(
"Couldn't get data store %s. Here's why: %s: %s",
id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return data_store["datastoreProperties"]
```
The following code instantiates the MedicalImagingWrapper object.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ For API details, see [GetDatastore](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/GetDatastore) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
oo_result = lo_mig->getdatastore( iv_datastoreid = iv_datastore_id ).
DATA(lo_properties) = oo_result->get_datastoreproperties( ).
DATA(lv_name) = lo_properties->get_datastorename( ).
DATA(lv_status) = lo_properties->get_datastorestatus( ).
MESSAGE 'Data store properties retrieved.' TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Data store not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [GetDatastore](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.
# Listing data stores
Use the `ListDatastores` action to list available [data stores](getting-started-concepts.md#concept-data-store) in AWS HealthImaging. The following menus provide a procedure for the AWS Management Console and code examples for the AWS CLI and AWS SDKs. For more information, see [https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDatastores.html](https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDatastores.html) in the *AWS HealthImaging API Reference*.
**To list data stores**
Choose a menu based on your access preference to AWS HealthImaging.
## AWS Console
+ Open the HealthImaging console [Data stores page](https://console.aws.amazon.com/medical-imaging/home#/dataStores).
All data stores are listed under the **Data stores** section.
## AWS CLI and SDKs
------
#### [ Bash ]
**AWS CLI with Bash script**
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function imaging_list_datastores
#
# List the HealthImaging data stores in the account.
#
# Returns:
# [[datastore_name, datastore_id, datastore_status]]
# And:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function imaging_list_datastores() {
local option OPTARG # Required to use getopts command in a function.
local error_code
# bashsupport disable=BP5008
function usage() {
echo "function imaging_list_datastores"
echo "Lists the AWS HealthImaging data stores in the account."
echo ""
}
# Retrieve the calling parameters.
while getopts "h" option; do
case "${option}" in
h)
usage
return 0
;;
\?)
echo "Invalid parameter"
usage
return 1
;;
esac
done
export OPTIND=1
local response
response=$(aws medical-imaging list-datastores \
--output text \
--query "datastoreSummaries[*][datastoreName, datastoreId, datastoreStatus]")
error_code=${?}
if [[ $error_code -ne 0 ]]; then
aws_cli_error_log $error_code
errecho "ERROR: AWS reports list-datastores operation failed.$response"
return 1
fi
echo "$response"
return 0
}
```
+ For API details, see [ListDatastores](https://docs.aws.amazon.com/goto/aws-cli/medical-imaging-2023-07-19/ListDatastores) in *AWS CLI Command Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/medical-imaging#code-examples).
------
#### [ CLI ]
**AWS CLI**
**To list data stores**
The following `list-datastores` code example lists available data stores.
```
aws medical-imaging list-datastores
```
Output:
```
{
"datastoreSummaries": [
{
"datastoreId": "12345678901234567890123456789012",
"datastoreName": "TestDatastore123",
"datastoreStatus": "ACTIVE",
"datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012",
"createdAt": "2022-11-15T23:33:09.643000+00:00",
"updatedAt": "2022-11-15T23:33:09.643000+00:00"
}
]
}
```
+ For API details, see [ListDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-datastores.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
```
public static List listMedicalImagingDatastores(MedicalImagingClient medicalImagingClient) {
try {
ListDatastoresRequest datastoreRequest = ListDatastoresRequest.builder()
.build();
ListDatastoresIterable responses = medicalImagingClient.listDatastoresPaginator(datastoreRequest);
List datastoreSummaries = new ArrayList<>();
responses.stream().forEach(response -> datastoreSummaries.addAll(response.datastoreSummaries()));
return datastoreSummaries;
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return null;
}
```
+ For API details, see [ListDatastores](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/ListDatastores) in *AWS SDK for Java 2.x API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
```
import { paginateListDatastores } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
export const listDatastores = async () => {
const paginatorConfig = {
client: medicalImagingClient,
pageSize: 50,
};
const commandParams = {};
const paginator = paginateListDatastores(paginatorConfig, commandParams);
/**
* @type {import("@aws-sdk/client-medical-imaging").DatastoreSummary[]}
*/
const datastoreSummaries = [];
for await (const page of paginator) {
// Each page contains a list of `jobSummaries`. The list is truncated if is larger than `pageSize`.
datastoreSummaries.push(...page.datastoreSummaries);
console.log(page);
}
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '6aa99231-d9c2-4716-a46e-edb830116fa3',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// datastoreSummaries: [
// {
// createdAt: 2023-08-04T18:49:54.429Z,
// datastoreArn: 'arn:aws:medical-imaging:us-east-1:xxxxxxxxx:datastore/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
// datastoreId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
// datastoreName: 'my_datastore',
// datastoreStatus: 'ACTIVE',
// updatedAt: 2023-08-04T18:49:54.429Z
// }
// ...
// ]
// }
return datastoreSummaries;
};
```
+ For API details, see [ListDatastores](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/ListDatastoresCommand) in *AWS SDK for JavaScript API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK for Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def list_datastores(self):
"""
List the data stores.
:return: The list of data stores.
"""
try:
paginator = self.health_imaging_client.get_paginator("list_datastores")
page_iterator = paginator.paginate()
datastore_summaries = []
for page in page_iterator:
datastore_summaries.extend(page["datastoreSummaries"])
except ClientError as err:
logger.error(
"Couldn't list data stores. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return datastore_summaries
```
The following code instantiates the MedicalImagingWrapper object.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ For API details, see [ListDatastores](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/ListDatastores) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
```
TRY.
oo_result = lo_mig->listdatastores( ).
DATA(lt_datastores) = oo_result->get_datastoresummaries( ).
DATA(lv_count) = lines( lt_datastores ).
MESSAGE |Found { lv_count } data stores.| TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [ListDatastores](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.
# Deleting a data store
Use the `DeleteDatastore` action to delete an AWS HealthImaging [data store](getting-started-concepts.md#concept-data-store). The following menus provide a procedure for the AWS Management Console and code examples for the AWS CLI and AWS SDKs. For more information, see [https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteDatastore.html](https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteDatastore.html) in the *AWS HealthImaging API Reference*.
**Note**
Before a data store can be deleted, you must first delete all [image sets](getting-started-concepts.md#concept-image-set) within it. For more information, see [Deleting an image set](delete-image-set.md).
**To delete a data store**
Choose a menu based on your access preference to AWS HealthImaging.
## AWS Console
1. Open the HealthImaging console [Data stores page](https://console.aws.amazon.com/medical-imaging/home#/dataStores).
1. Choose a data store.
1. Choose **Delete**.
The **Delete data store** page opens.
1. To confirm data store deletion, enter the data store name in the text input field.
1. Choose **Delete data store**.
## AWS CLI and SDKs
------
#### [ Bash ]
**AWS CLI with Bash script**
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function imaging_delete_datastore
#
# This function deletes an AWS HealthImaging data store.
#
# Parameters:
# -i datastore_id - The ID of the data store.
#
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function imaging_delete_datastore() {
local datastore_id response
local option OPTARG # Required to use getopts command in a function.
# bashsupport disable=BP5008
function usage() {
echo "function imaging_delete_datastore"
echo "Deletes an AWS HealthImaging data store."
echo " -i datastore_id - The ID of the data store."
echo ""
}
# Retrieve the calling parameters.
while getopts "i:h" option; do
case "${option}" in
i) datastore_id="${OPTARG}" ;;
h)
usage
return 0
;;
\?)
echo "Invalid parameter"
usage
return 1
;;
esac
done
export OPTIND=1
if [[ -z "$datastore_id" ]]; then
errecho "ERROR: You must provide a data store ID with the -i parameter."
usage
return 1
fi
response=$(aws medical-imaging delete-datastore \
--datastore-id "$datastore_id")
local error_code=${?}
if [[ $error_code -ne 0 ]]; then
aws_cli_error_log $error_code
errecho "ERROR: AWS reports medical-imaging delete-datastore operation failed.$response"
return 1
fi
return 0
}
```
+ For API details, see [DeleteDatastore](https://docs.aws.amazon.com/goto/aws-cli/medical-imaging-2023-07-19/DeleteDatastore) in *AWS CLI Command Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/medical-imaging#code-examples).
------
#### [ CLI ]
**AWS CLI**
**To delete a data store**
The following `delete-datastore` code example deletes a data store.
```
aws medical-imaging delete-datastore \
--datastore-id "12345678901234567890123456789012"
```
Output:
```
{
"datastoreId": "12345678901234567890123456789012",
"datastoreStatus": "DELETING"
}
```
+ For API details, see [DeleteDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-datastore.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
```
public static void deleteMedicalImagingDatastore(MedicalImagingClient medicalImagingClient,
String datastoreID) {
try {
DeleteDatastoreRequest datastoreRequest = DeleteDatastoreRequest.builder()
.datastoreId(datastoreID)
.build();
medicalImagingClient.deleteDatastore(datastoreRequest);
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [DeleteDatastore](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/DeleteDatastore) in *AWS SDK for Java 2.x API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
```
import { DeleteDatastoreCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreId - The ID of the data store to delete.
*/
export const deleteDatastore = async (datastoreId = "DATASTORE_ID") => {
const response = await medicalImagingClient.send(
new DeleteDatastoreCommand({ datastoreId }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'f5beb409-678d-48c9-9173-9a001ee1ebb1',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// datastoreId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
// datastoreStatus: 'DELETING'
// }
return response;
};
```
+ For API details, see [DeleteDatastore](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/DeleteDatastoreCommand) in *AWS SDK for JavaScript API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK for Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def delete_datastore(self, datastore_id):
"""
Delete a data store.
:param datastore_id: The ID of the data store.
"""
try:
self.health_imaging_client.delete_datastore(datastoreId=datastore_id)
except ClientError as err:
logger.error(
"Couldn't delete data store %s. Here's why: %s: %s",
datastore_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
The following code instantiates the MedicalImagingWrapper object.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ For API details, see [DeleteDatastore](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/DeleteDatastore) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
oo_result = lo_mig->deletedatastore( iv_datastoreid = iv_datastore_id ).
MESSAGE 'Data store deleted.' TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict. Data store may contain resources.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Data store not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [DeleteDatastore](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.