As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Exemplos básicos de HealthImaging uso AWS SDKs
Os exemplos de código a seguir mostram como usar o básico do AWS HealthImaging with AWS SDKs.
**Contents**
+ [Olá HealthImaging](example_medical-imaging_Hello_section.md)
+ [Ações](service_code_examples_actions.md)
+ [`CopyImageSet`](example_medical-imaging_CopyImageSet_section.md)
+ [`CreateDatastore`](example_medical-imaging_CreateDatastore_section.md)
+ [`DeleteDatastore`](example_medical-imaging_DeleteDatastore_section.md)
+ [`DeleteImageSet`](example_medical-imaging_DeleteImageSet_section.md)
+ [`GetDICOMImportJob`](example_medical-imaging_GetDICOMImportJob_section.md)
+ [`GetDatastore`](example_medical-imaging_GetDatastore_section.md)
+ [`GetImageFrame`](example_medical-imaging_GetImageFrame_section.md)
+ [`GetImageSet`](example_medical-imaging_GetImageSet_section.md)
+ [`GetImageSetMetadata`](example_medical-imaging_GetImageSetMetadata_section.md)
+ [`ListDICOMImportJobs`](example_medical-imaging_ListDICOMImportJobs_section.md)
+ [`ListDatastores`](example_medical-imaging_ListDatastores_section.md)
+ [`ListImageSetVersions`](example_medical-imaging_ListImageSetVersions_section.md)
+ [`ListTagsForResource`](example_medical-imaging_ListTagsForResource_section.md)
+ [`SearchImageSets`](example_medical-imaging_SearchImageSets_section.md)
+ [`StartDICOMImportJob`](example_medical-imaging_StartDICOMImportJob_section.md)
+ [`TagResource`](example_medical-imaging_TagResource_section.md)
+ [`UntagResource`](example_medical-imaging_UntagResource_section.md)
+ [`UpdateImageSetMetadata`](example_medical-imaging_UpdateImageSetMetadata_section.md)
# Olá HealthImaging
O exemplo de código a seguir mostra como começar a usar o HealthImaging.
------
#### [ C\$1\$1 ]
**SDK para C\$1\$1**
Código para o CMake arquivo CMake Lists.txt.
```
# Set the minimum required version of CMake for this project.
cmake_minimum_required(VERSION 3.13)
# Set the AWS service components used by this project.
set(SERVICE_COMPONENTS medical-imaging)
# Set this project's name.
project("hello_health-imaging")
# Set the C++ standard to use to build this target.
# At least C++ 11 is required for the AWS SDK for C++.
set(CMAKE_CXX_STANDARD 11)
# Use the MSVC variable to determine if this is a Windows build.
set(WINDOWS_BUILD ${MSVC})
if (WINDOWS_BUILD) # Set the location where CMake can find the installed libraries for the AWS SDK.
string(REPLACE ";" "/aws-cpp-sdk-all;" SYSTEM_MODULE_PATH "${CMAKE_SYSTEM_PREFIX_PATH}/aws-cpp-sdk-all")
list(APPEND CMAKE_PREFIX_PATH ${SYSTEM_MODULE_PATH})
endif ()
# Find the AWS SDK for C++ package.
find_package(AWSSDK REQUIRED COMPONENTS ${SERVICE_COMPONENTS})
if (WINDOWS_BUILD AND AWSSDK_INSTALL_AS_SHARED_LIBS)
# Copy relevant AWS SDK for C++ libraries into the current binary directory for running and debugging.
# set(BIN_SUB_DIR "/Debug") # If you are building from the command line, you may need to uncomment this
# and set the proper subdirectory to the executable location.
AWSSDK_CPY_DYN_LIBS(SERVICE_COMPONENTS "" ${CMAKE_CURRENT_BINARY_DIR}${BIN_SUB_DIR})
endif ()
add_executable(${PROJECT_NAME}
hello_health_imaging.cpp)
target_link_libraries(${PROJECT_NAME}
${AWSSDK_LINK_LIBRARIES})
```
Código para o arquivo de origem hello\$1health\$1imaging.cpp.
```
#include
#include
#include
#include
/*
* A "Hello HealthImaging" starter application which initializes an AWS HealthImaging (HealthImaging) client
* and lists the HealthImaging data stores in the current account.
*
* main function
*
* Usage: 'hello_health-imaging'
*
*/
#include
#include
int main(int argc, char **argv) {
(void) argc;
(void) argv;
Aws::SDKOptions options;
// Optional: change the log level for debugging.
// options.loggingOptions.logLevel = Aws::Utils::Logging::LogLevel::Debug;
Aws::InitAPI(options); // Should only be called once.
{
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::MedicalImaging::MedicalImagingClient medicalImagingClient(clientConfig);
Aws::MedicalImaging::Model::ListDatastoresRequest listDatastoresRequest;
Aws::Vector allDataStoreSummaries;
Aws::String nextToken; // Used for paginated results.
do {
if (!nextToken.empty()) {
listDatastoresRequest.SetNextToken(nextToken);
}
Aws::MedicalImaging::Model::ListDatastoresOutcome listDatastoresOutcome =
medicalImagingClient.ListDatastores(listDatastoresRequest);
if (listDatastoresOutcome.IsSuccess()) {
const Aws::Vector &dataStoreSummaries =
listDatastoresOutcome.GetResult().GetDatastoreSummaries();
allDataStoreSummaries.insert(allDataStoreSummaries.cend(),
dataStoreSummaries.cbegin(),
dataStoreSummaries.cend());
nextToken = listDatastoresOutcome.GetResult().GetNextToken();
}
else {
std::cerr << "ListDatastores error: "
<< listDatastoresOutcome.GetError().GetMessage() << std::endl;
break;
}
} while (!nextToken.empty());
std::cout << allDataStoreSummaries.size() << " HealthImaging data "
<< ((allDataStoreSummaries.size() == 1) ?
"store was retrieved." : "stores were retrieved.") << std::endl;
for (auto const &dataStoreSummary: allDataStoreSummaries) {
std::cout << " Datastore: " << dataStoreSummary.GetDatastoreName()
<< std::endl;
std::cout << " Datastore ID: " << dataStoreSummary.GetDatastoreId()
<< std::endl;
}
}
Aws::ShutdownAPI(options); // Should only be called once.
return 0;
}
```
+ Para obter detalhes da API, consulte [ListDatastores](https://docs.aws.amazon.com/goto/SdkForCpp/medical-imaging-2023-07-19/ListDatastores)a *Referência AWS SDK para C\$1\$1 da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/medical-imaging/hello_health_imaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import {
ListDatastoresCommand,
MedicalImagingClient,
} from "@aws-sdk/client-medical-imaging";
// When no region or credentials are provided, the SDK will use the
// region and credentials from the local AWS config.
const client = new MedicalImagingClient({});
export const helloMedicalImaging = async () => {
const command = new ListDatastoresCommand({});
const { datastoreSummaries } = await client.send(command);
console.log("Datastores: ");
console.log(datastoreSummaries.map((item) => item.datastoreName).join("\n"));
return datastoreSummaries;
};
```
+ Para obter detalhes da API, consulte [ListDatastores](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/ListDatastoresCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
def hello_medical_imaging(medical_imaging_client):
"""
Use the AWS SDK for Python (Boto3) to create an AWS HealthImaging
client and list the data stores in your account.
This example uses the default settings specified in your shared credentials
and config files.
:param medical_imaging_client: A Boto3 AWS HealthImaging Client object.
"""
print("Hello, Amazon Health Imaging! Let's list some of your data stores:\n")
try:
paginator = medical_imaging_client.get_paginator("list_datastores")
page_iterator = paginator.paginate()
datastore_summaries = []
for page in page_iterator:
datastore_summaries.extend(page["datastoreSummaries"])
print("\tData Stores:")
for ds in datastore_summaries:
print(f"\t\tDatastore: {ds['datastoreName']} ID {ds['datastoreId']}")
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
if __name__ == "__main__":
hello_medical_imaging(boto3.client("medical-imaging"))
```
+ Para obter detalhes da API, consulte a [ListDatastores](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/ListDatastores)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging/imaging_set_and_frames_workflow#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Ações para HealthImaging usar AWS SDKs
Os exemplos de código a seguir demonstram como realizar HealthImaging ações individuais com AWS SDKs. Cada exemplo inclui um link para GitHub, onde você pode encontrar instruções para configurar e executar o código.
Esses trechos chamam a HealthImaging API e são trechos de código de programas maiores que devem ser executados em contexto. É possível ver as ações em contexto em [Cenários para HealthImaging usar AWS SDKs](service_code_examples_scenarios.md).
Os exemplos a seguir incluem apenas as ações mais utilizadas. Para obter uma lista completa, consulte a [Referência de APIs do AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/APIReference/Welcome.html).
**Topics**
+ [`CopyImageSet`](example_medical-imaging_CopyImageSet_section.md)
+ [`CreateDatastore`](example_medical-imaging_CreateDatastore_section.md)
+ [`DeleteDatastore`](example_medical-imaging_DeleteDatastore_section.md)
+ [`DeleteImageSet`](example_medical-imaging_DeleteImageSet_section.md)
+ [`GetDICOMImportJob`](example_medical-imaging_GetDICOMImportJob_section.md)
+ [`GetDatastore`](example_medical-imaging_GetDatastore_section.md)
+ [`GetImageFrame`](example_medical-imaging_GetImageFrame_section.md)
+ [`GetImageSet`](example_medical-imaging_GetImageSet_section.md)
+ [`GetImageSetMetadata`](example_medical-imaging_GetImageSetMetadata_section.md)
+ [`ListDICOMImportJobs`](example_medical-imaging_ListDICOMImportJobs_section.md)
+ [`ListDatastores`](example_medical-imaging_ListDatastores_section.md)
+ [`ListImageSetVersions`](example_medical-imaging_ListImageSetVersions_section.md)
+ [`ListTagsForResource`](example_medical-imaging_ListTagsForResource_section.md)
+ [`SearchImageSets`](example_medical-imaging_SearchImageSets_section.md)
+ [`StartDICOMImportJob`](example_medical-imaging_StartDICOMImportJob_section.md)
+ [`TagResource`](example_medical-imaging_TagResource_section.md)
+ [`UntagResource`](example_medical-imaging_UntagResource_section.md)
+ [`UpdateImageSetMetadata`](example_medical-imaging_UpdateImageSetMetadata_section.md)
# Use `CopyImageSet` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `CopyImageSet`.
------
#### [ CLI ]
**AWS CLI**
**Exemplo 1: para copiar um conjunto de imagens sem um destino.**
O exemplo `copy-image-set` a seguir cria uma cópia duplicada de um conjunto de imagens sem um destino.
```
aws medical-imaging copy-image-set \
--datastore-id 12345678901234567890123456789012 \
--source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1" } }'
```
Saída:
```
{
"destinationImageSetProperties": {
"latestVersionId": "2",
"imageSetWorkflowStatus": "COPYING",
"updatedAt": 1680042357.432,
"imageSetId": "b9a06fef182a5f992842f77f8e0868e5",
"imageSetState": "LOCKED",
"createdAt": 1680042357.432
},
"sourceImageSetProperties": {
"latestVersionId": "1",
"imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS",
"updatedAt": 1680042357.432,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436
},
"datastoreId": "12345678901234567890123456789012"
}
```
**Exemplo 2: para copiar um conjunto de imagens com um destino.**
O exemplo `copy-image-set` a seguir cria uma cópia duplicada de um conjunto de imagens com um destino.
```
aws medical-imaging copy-image-set \
--datastore-id 12345678901234567890123456789012 \
--source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1" }, "destinationImageSet": { "imageSetId": "b9a06fef182a5f992842f77f8e0868e5", "latestVersionId": "1"} }'
```
Saída:
```
{
"destinationImageSetProperties": {
"latestVersionId": "2",
"imageSetWorkflowStatus": "COPYING",
"updatedAt": 1680042505.135,
"imageSetId": "b9a06fef182a5f992842f77f8e0868e5",
"imageSetState": "LOCKED",
"createdAt": 1680042357.432
},
"sourceImageSetProperties": {
"latestVersionId": "1",
"imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS",
"updatedAt": 1680042505.135,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436
},
"datastoreId": "12345678901234567890123456789012"
}
```
**Exemplo 3: copiar um subconjunto de instâncias de um conjunto de imagens de origem para um conjunto de imagens de destino.**
O exemplo `copy-image-set` a seguir copia uma instância DICOM do conjunto de imagens de origem para o conjunto de imagens de destino. O parâmetro force é fornecido para substituir inconsistências nos atributos dos níveis Patient, Study e Series.
```
aws medical-imaging copy-image-set \
--datastore-id 12345678901234567890123456789012 \
--source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1","DICOMCopies": {"copiableAttributes": "{\"SchemaVersion\":\"1.1\",\"Study\":{\"Series\":{\"1.3.6.1.4.1.5962.99.1.3673257865.2104868982.1369432891697.3666.0\":{\"Instances\":{\"1.3.6.1.4.1.5962.99.1.3673257865.2104868982.1369432891697.3669.0\":{}}}}}}"}},"destinationImageSet": {"imageSetId": "b9eb50d8ee682eb9fcf4acbf92f62bb7","latestVersionId": "1"}}' \
--force
```
Saída:
```
{
"destinationImageSetProperties": {
"latestVersionId": "2",
"imageSetWorkflowStatus": "COPYING",
"updatedAt": 1680042505.135,
"imageSetId": "b9eb50d8ee682eb9fcf4acbf92f62bb7",
"imageSetState": "LOCKED",
"createdAt": 1680042357.432
},
"sourceImageSetProperties": {
"latestVersionId": "1",
"imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS",
"updatedAt": 1680042505.135,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436
},
"datastoreId": "12345678901234567890123456789012"
}
```
Para obter mais informações, consulte [Copiar um conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/copy-image-set.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [CopyImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/copy-image-set.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
/**
* Copy an AWS HealthImaging image set.
*
* @param medicalImagingClient - The AWS HealthImaging client object.
* @param datastoreId - The datastore ID.
* @param imageSetId - The image set ID.
* @param latestVersionId - The version ID.
* @param destinationImageSetId - The optional destination image set ID, ignored if null.
* @param destinationVersionId - The optional destination version ID, ignored if null.
* @param force - The force flag.
* @param subsets - The optional subsets to copy, ignored if null.
* @return - The image set ID of the copy.
* @throws MedicalImagingException - Base exception for all service exceptions thrown by AWS HealthImaging.
*/
public static String copyMedicalImageSet(MedicalImagingClient medicalImagingClient,
String datastoreId,
String imageSetId,
String latestVersionId,
String destinationImageSetId,
String destinationVersionId,
boolean force,
Vector subsets) {
try {
CopySourceImageSetInformation.Builder copySourceImageSetInformation = CopySourceImageSetInformation.builder()
.latestVersionId(latestVersionId);
// Optionally copy a subset of image instances.
if (subsets != null) {
String subsetInstanceToCopy = getCopiableAttributesJSON(imageSetId, subsets);
copySourceImageSetInformation.dicomCopies(MetadataCopies.builder()
.copiableAttributes(subsetInstanceToCopy)
.build());
}
CopyImageSetInformation.Builder copyImageSetBuilder = CopyImageSetInformation.builder()
.sourceImageSet(copySourceImageSetInformation.build());
// Optionally designate a destination image set.
if (destinationImageSetId != null) {
copyImageSetBuilder = copyImageSetBuilder.destinationImageSet(CopyDestinationImageSet.builder()
.imageSetId(destinationImageSetId)
.latestVersionId(destinationVersionId)
.build());
}
CopyImageSetRequest copyImageSetRequest = CopyImageSetRequest.builder()
.datastoreId(datastoreId)
.sourceImageSetId(imageSetId)
.copyImageSetInformation(copyImageSetBuilder.build())
.force(force)
.build();
CopyImageSetResponse response = medicalImagingClient.copyImageSet(copyImageSetRequest);
return response.destinationImageSetProperties().imageSetId();
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
throw e;
}
}
```
Função utilitária para criar atributos copiáveis.
```
/**
* Create a JSON string of copiable image instances.
*
* @param imageSetId - The image set ID.
* @param subsets - The subsets to copy.
* @return A JSON string of copiable image instances.
*/
private static String getCopiableAttributesJSON(String imageSetId, Vector subsets) {
StringBuilder subsetInstanceToCopy = new StringBuilder(
"""
{
"SchemaVersion": 1.1,
"Study": {
"Series": {
"
"""
);
subsetInstanceToCopy.append(imageSetId);
subsetInstanceToCopy.append(
"""
": {
"Instances": {
"""
);
for (String subset : subsets) {
subsetInstanceToCopy.append('"' + subset + "\": {},");
}
subsetInstanceToCopy.deleteCharAt(subsetInstanceToCopy.length() - 1);
subsetInstanceToCopy.append("""
}
}
}
}
}
""");
return subsetInstanceToCopy.toString();
}
```
+ Para obter detalhes da API, consulte [CopyImageSet](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/CopyImageSet)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
Função de utilitário para copiar um conjunto de imagens.
```
import { CopyImageSetCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreId - The ID of the data store.
* @param {string} imageSetId - The source image set ID.
* @param {string} sourceVersionId - The source version ID.
* @param {string} destinationImageSetId - The optional ID of the destination image set.
* @param {string} destinationVersionId - The optional version ID of the destination image set.
* @param {boolean} force - Force the copy action.
* @param {[string]} copySubsets - A subset of instance IDs to copy.
*/
export const copyImageSet = async (
datastoreId = "xxxxxxxxxxx",
imageSetId = "xxxxxxxxxxxx",
sourceVersionId = "1",
destinationImageSetId = "",
destinationVersionId = "",
force = false,
copySubsets = [],
) => {
try {
const params = {
datastoreId: datastoreId,
sourceImageSetId: imageSetId,
copyImageSetInformation: {
sourceImageSet: { latestVersionId: sourceVersionId },
},
force: force,
};
if (destinationImageSetId !== "" && destinationVersionId !== "") {
params.copyImageSetInformation.destinationImageSet = {
imageSetId: destinationImageSetId,
latestVersionId: destinationVersionId,
};
}
if (copySubsets.length > 0) {
let copySubsetsJson;
copySubsetsJson = {
SchemaVersion: 1.1,
Study: {
Series: {
imageSetId: {
Instances: {},
},
},
},
};
for (let i = 0; i < copySubsets.length; i++) {
copySubsetsJson.Study.Series.imageSetId.Instances[copySubsets[i]] = {};
}
params.copyImageSetInformation.dicomCopies = copySubsetsJson;
}
const response = await medicalImagingClient.send(
new CopyImageSetCommand(params),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'd9b219ce-cc48-4a44-a5b2-c5c3068f1ee8',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// datastoreId: 'xxxxxxxxxxxxxx',
// destinationImageSetProperties: {
// createdAt: 2023-09-27T19:46:21.824Z,
// imageSetArn: 'arn:aws:medical-imaging:us-east-1:xxxxxxxxxxx:datastore/xxxxxxxxxxxxx/imageset/xxxxxxxxxxxxxxxxxxx',
// imageSetId: 'xxxxxxxxxxxxxxx',
// imageSetState: 'LOCKED',
// imageSetWorkflowStatus: 'COPYING',
// latestVersionId: '1',
// updatedAt: 2023-09-27T19:46:21.824Z
// },
// sourceImageSetProperties: {
// createdAt: 2023-09-22T14:49:26.427Z,
// imageSetArn: 'arn:aws:medical-imaging:us-east-1:xxxxxxxxxxx:datastore/xxxxxxxxxxxxx/imageset/xxxxxxxxxxxxxxxx',
// imageSetId: 'xxxxxxxxxxxxxxxx',
// imageSetState: 'LOCKED',
// imageSetWorkflowStatus: 'COPYING_WITH_READ_ONLY_ACCESS',
// latestVersionId: '4',
// updatedAt: 2023-09-27T19:46:21.824Z
// }
// }
return response;
} catch (err) {
console.error(err);
}
};
```
Copiar um conjunto de imagens sem um destino.
```
await copyImageSet(
"12345678901234567890123456789012",
"12345678901234567890123456789012",
"1",
);
```
Copiar um conjunto de imagens com um destino.
```
await copyImageSet(
"12345678901234567890123456789012",
"12345678901234567890123456789012",
"1",
"12345678901234567890123456789012",
"1",
false,
);
```
Copie um subconjunto de um conjunto de imagens com um destino e force a cópia.
```
await copyImageSet(
"12345678901234567890123456789012",
"12345678901234567890123456789012",
"1",
"12345678901234567890123456789012",
"1",
true,
["12345678901234567890123456789012", "11223344556677889900112233445566"],
);
```
+ Para obter detalhes da API, consulte [CopyImageSet](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/CopyImageSetCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
Função de utilitário para copiar um conjunto de imagens.
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def copy_image_set(
self,
datastore_id,
image_set_id,
version_id,
destination_image_set_id=None,
destination_version_id=None,
force=False,
subsets=[],
):
"""
Copy an image set.
:param datastore_id: The ID of the data store.
:param image_set_id: The ID of the image set.
:param version_id: The ID of the image set version.
:param destination_image_set_id: The ID of the optional destination image set.
:param destination_version_id: The ID of the optional destination image set version.
:param force: Force the copy.
:param subsets: The optional subsets to copy. For example: ["12345678901234567890123456789012"].
:return: The copied image set ID.
"""
try:
copy_image_set_information = {
"sourceImageSet": {"latestVersionId": version_id}
}
if destination_image_set_id and destination_version_id:
copy_image_set_information["destinationImageSet"] = {
"imageSetId": destination_image_set_id,
"latestVersionId": destination_version_id,
}
if len(subsets) > 0:
copySubsetsJson = {
"SchemaVersion": "1.1",
"Study": {"Series": {"imageSetId": {"Instances": {}}}},
}
for subset in subsets:
copySubsetsJson["Study"]["Series"]["imageSetId"]["Instances"][
subset
] = {}
copy_image_set_information["sourceImageSet"]["DICOMCopies"] = {
"copiableAttributes": json.dumps(copySubsetsJson)
}
copy_results = self.health_imaging_client.copy_image_set(
datastoreId=datastore_id,
sourceImageSetId=image_set_id,
copyImageSetInformation=copy_image_set_information,
force=force,
)
except ClientError as err:
logger.error(
"Couldn't copy image set. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return copy_results["destinationImageSetProperties"]["imageSetId"]
```
Copiar um conjunto de imagens sem um destino.
```
copy_image_set_information = {
"sourceImageSet": {"latestVersionId": version_id}
}
copy_results = self.health_imaging_client.copy_image_set(
datastoreId=datastore_id,
sourceImageSetId=image_set_id,
copyImageSetInformation=copy_image_set_information,
force=force,
)
```
Copiar um conjunto de imagens com um destino.
```
copy_image_set_information = {
"sourceImageSet": {"latestVersionId": version_id}
}
if destination_image_set_id and destination_version_id:
copy_image_set_information["destinationImageSet"] = {
"imageSetId": destination_image_set_id,
"latestVersionId": destination_version_id,
}
copy_results = self.health_imaging_client.copy_image_set(
datastoreId=datastore_id,
sourceImageSetId=image_set_id,
copyImageSetInformation=copy_image_set_information,
force=force,
)
```
Copiar um subconjunto de um conjunto de imagens.
```
copy_image_set_information = {
"sourceImageSet": {"latestVersionId": version_id}
}
if len(subsets) > 0:
copySubsetsJson = {
"SchemaVersion": "1.1",
"Study": {"Series": {"imageSetId": {"Instances": {}}}},
}
for subset in subsets:
copySubsetsJson["Study"]["Series"]["imageSetId"]["Instances"][
subset
] = {}
copy_image_set_information["sourceImageSet"]["DICOMCopies"] = {
"copiableAttributes": json.dumps(copySubsetsJson)
}
copy_results = self.health_imaging_client.copy_image_set(
datastoreId=datastore_id,
sourceImageSetId=image_set_id,
copyImageSetInformation=copy_image_set_information,
force=force,
)
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [CopyImageSet](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/CopyImageSet)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
" iv_source_image_set_id = '1234567890123456789012345678901234567890'
" iv_source_version_id = '1'
" iv_destination_image_set_id = '1234567890123456789012345678901234567890' (optional)
" iv_destination_version_id = '1' (optional)
" iv_force = abap_false
DATA(lo_source_info) = NEW /aws1/cl_migcpsrcimagesetinf00(
iv_latestversionid = iv_source_version_id ).
DATA(lo_copy_info) = NEW /aws1/cl_migcpimagesetinfmtion(
io_sourceimageset = lo_source_info ).
IF iv_destination_image_set_id IS NOT INITIAL AND
iv_destination_version_id IS NOT INITIAL.
DATA(lo_dest_info) = NEW /aws1/cl_migcopydstimageset(
iv_imagesetid = iv_destination_image_set_id
iv_latestversionid = iv_destination_version_id ).
lo_copy_info = NEW /aws1/cl_migcpimagesetinfmtion(
io_sourceimageset = lo_source_info
io_destinationimageset = lo_dest_info ).
ENDIF.
oo_result = lo_mig->copyimageset(
iv_datastoreid = iv_datastore_id
iv_sourceimagesetid = iv_source_image_set_id
io_copyimagesetinformation = lo_copy_info
iv_force = iv_force ).
DATA(lo_dest_props) = oo_result->get_dstimagesetproperties( ).
DATA(lv_new_id) = lo_dest_props->get_imagesetid( ).
MESSAGE |Image set copied with new ID: { lv_new_id }.| TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Image set not found.' 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.
```
+ Para obter detalhes da API, consulte a [CopyImageSet](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `CreateDatastore` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `CreateDatastore`.
------
#### [ Bash ]
**AWS CLI com script Bash**
```
###############################################################################
# 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
}
```
+ Para obter detalhes da API, consulte [CreateDatastore](https://docs.aws.amazon.com/goto/aws-cli/medical-imaging-2023-07-19/CreateDatastore)em *Referência de AWS CLI Comandos*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [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**
**Exemplo 1: criar um datastore**
O exemplo de código `create-datastore` a seguir cria um armazenamento de dados com o nome de `my-datastore`. Quando você cria um armazenamento de dados sem especificar um`--lossless-storage-format`, o AWS HealthImaging padrão é HTJ2 K (High Throughput JPEG 2000).
```
aws medical-imaging create-datastore \
--datastore-name "my-datastore"
```
Saída:
```
{
"datastoreId": "12345678901234567890123456789012",
"datastoreStatus": "CREATING"
}
```
**Exemplo 2: criar um datastore com o formato de armazenamento JPEG 2000 Lossless**
Um datastore configurado com o formato de armazenamento JPEG 2000 Lossless transcodificará e persistirá quadros de imagem sem perdas no formato JPEG 2000. Os quadros de imagem podem então ser recuperados no JPEG 2000 Lossless sem transcodificação. O exemplo de código `create-datastore` a seguir cria um datastore configurado para o formato de armazenamento JPEG 2000 Lossless com o nome `my-datastore`.
```
aws medical-imaging create-datastore \
--datastore-name "my-datastore" \
--lossless-storage-format JPEG_2000_LOSSLESS
```
Saída:
```
{
"datastoreId": "12345678901234567890123456789012",
"datastoreStatus": "CREATING"
}
```
Para obter mais informações, consulte [Criação de um armazenamento de dados](https://docs.aws.amazon.com/healthimaging/latest/devguide/create-data-store.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [CreateDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/create-datastore.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para 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 "";
}
```
+ Para obter detalhes da API, consulte [CreateDatastore](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/CreateDatastore)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para 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;
};
```
+ Para obter detalhes da API, consulte [CreateDatastore](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/CreateDatastoreCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para 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"]
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [CreateDatastore](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/CreateDatastore)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para 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.
```
+ Para obter detalhes da API, consulte a [CreateDatastore](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `DeleteDatastore` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `DeleteDatastore`.
------
#### [ Bash ]
**AWS CLI com script Bash**
```
###############################################################################
# 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
}
```
+ Para obter detalhes da API, consulte [DeleteDatastore](https://docs.aws.amazon.com/goto/aws-cli/medical-imaging-2023-07-19/DeleteDatastore)em *Referência de AWS CLI Comandos*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [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**
**Para excluir um armazenamento de dados**
O exemplo de código `delete-datastore` a seguir exclui um armazenamento de dados.
```
aws medical-imaging delete-datastore \
--datastore-id "12345678901234567890123456789012"
```
Saída:
```
{
"datastoreId": "12345678901234567890123456789012",
"datastoreStatus": "DELETING"
}
```
Para obter mais informações, consulte [Excluindo um armazenamento de dados](https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-data-store.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [DeleteDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-datastore.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para 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);
}
}
```
+ Para obter detalhes da API, consulte [DeleteDatastore](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/DeleteDatastore)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para 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;
};
```
+ Para obter detalhes da API, consulte [DeleteDatastore](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/DeleteDatastoreCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para 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
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [DeleteDatastore](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/DeleteDatastore)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para 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.
```
+ Para obter detalhes da API, consulte a [DeleteDatastore](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `DeleteImageSet` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `DeleteImageSet`.
Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação em contexto no seguinte exemplo de código:
+ [Começar a usar conjuntos de imagens e quadros de imagem](example_medical-imaging_Scenario_ImageSetsAndFrames_section.md)
------
#### [ C\$1\$1 ]
**SDK para C\$1\$1**
```
//! Routine which deletes an AWS HealthImaging image set.
/*!
\param dataStoreID: The HealthImaging data store ID.
\param imageSetID: The image set ID.
\param clientConfig: Aws client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::Medical_Imaging::deleteImageSet(
const Aws::String &dataStoreID, const Aws::String &imageSetID,
const Aws::Client::ClientConfiguration &clientConfig) {
Aws::MedicalImaging::MedicalImagingClient client(clientConfig);
Aws::MedicalImaging::Model::DeleteImageSetRequest request;
request.SetDatastoreId(dataStoreID);
request.SetImageSetId(imageSetID);
Aws::MedicalImaging::Model::DeleteImageSetOutcome outcome = client.DeleteImageSet(
request);
if (outcome.IsSuccess()) {
std::cout << "Successfully deleted image set " << imageSetID
<< " from data store " << dataStoreID << std::endl;
}
else {
std::cerr << "Error deleting image set " << imageSetID << " from data store "
<< dataStoreID << ": " <<
outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ Para obter detalhes da API, consulte [DeleteImageSet](https://docs.aws.amazon.com/goto/SdkForCpp/medical-imaging-2023-07-19/DeleteImageSet)a *Referência AWS SDK para C\$1\$1 da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/medical-imaging/#code-examples).
------
#### [ CLI ]
**AWS CLI**
**Para excluir um conjunto de imagens**
O exemplo de código `delete-image-set` a seguir exclui um conjunto de imagens.
```
aws medical-imaging delete-image-set \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e
```
Saída:
```
{
"imageSetWorkflowStatus": "DELETING",
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"datastoreId": "12345678901234567890123456789012"
}
```
Para obter mais informações, consulte [Excluir um conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-image-set.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [DeleteImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-image-set.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static void deleteMedicalImageSet(MedicalImagingClient medicalImagingClient,
String datastoreId,
String imagesetId) {
try {
DeleteImageSetRequest deleteImageSetRequest = DeleteImageSetRequest.builder()
.datastoreId(datastoreId)
.imageSetId(imagesetId)
.build();
medicalImagingClient.deleteImageSet(deleteImageSetRequest);
System.out.println("The image set was deleted.");
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ Para obter detalhes da API, consulte [DeleteImageSet](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/DeleteImageSet)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { DeleteImageSetCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreId - The data store ID.
* @param {string} imageSetId - The image set ID.
*/
export const deleteImageSet = async (
datastoreId = "xxxxxxxxxxxxxxxx",
imageSetId = "xxxxxxxxxxxxxxxx",
) => {
const response = await medicalImagingClient.send(
new DeleteImageSetCommand({
datastoreId: datastoreId,
imageSetId: imageSetId,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '6267bbd2-eaa5-4a50-8ee8-8fddf535cf73',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// datastoreId: 'xxxxxxxxxxxxxxxx',
// imageSetId: 'xxxxxxxxxxxxxxx',
// imageSetState: 'LOCKED',
// imageSetWorkflowStatus: 'DELETING'
// }
return response;
};
```
+ Para obter detalhes da API, consulte [DeleteImageSet](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/DeleteImageSetCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def delete_image_set(self, datastore_id, image_set_id):
"""
Delete an image set.
:param datastore_id: The ID of the data store.
:param image_set_id: The ID of the image set.
:return: The delete results.
"""
try:
delete_results = self.health_imaging_client.delete_image_set(
imageSetId=image_set_id, datastoreId=datastore_id
)
except ClientError as err:
logger.error(
"Couldn't delete image set. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return delete_results
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [DeleteImageSet](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/DeleteImageSet)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
" iv_image_set_id = '1234567890123456789012345678901234567890'
oo_result = lo_mig->deleteimageset(
iv_datastoreid = iv_datastore_id
iv_imagesetid = iv_image_set_id ).
MESSAGE 'Image set deleted.' TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Image set not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para obter detalhes da API, consulte a [DeleteImageSet](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `GetDICOMImportJob` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `GetDICOMImportJob`.
Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação em contexto no seguinte exemplo de código:
+ [Começar a usar conjuntos de imagens e quadros de imagem](example_medical-imaging_Scenario_ImageSetsAndFrames_section.md)
------
#### [ C\$1\$1 ]
**SDK para C\$1\$1**
```
//! Routine which gets a HealthImaging DICOM import job's properties.
/*!
\param dataStoreID: The HealthImaging data store ID.
\param importJobID: The DICOM import job ID
\param clientConfig: Aws client configuration.
\return GetDICOMImportJobOutcome: The import job outcome.
*/
Aws::MedicalImaging::Model::GetDICOMImportJobOutcome
AwsDoc::Medical_Imaging::getDICOMImportJob(const Aws::String &dataStoreID,
const Aws::String &importJobID,
const Aws::Client::ClientConfiguration &clientConfig) {
Aws::MedicalImaging::MedicalImagingClient client(clientConfig);
Aws::MedicalImaging::Model::GetDICOMImportJobRequest request;
request.SetDatastoreId(dataStoreID);
request.SetJobId(importJobID);
Aws::MedicalImaging::Model::GetDICOMImportJobOutcome outcome = client.GetDICOMImportJob(
request);
if (!outcome.IsSuccess()) {
std::cerr << "GetDICOMImportJob error: "
<< outcome.GetError().GetMessage() << std::endl;
}
return outcome;
}
```
+ Para obter detalhes da API, consulte [Get DICOMImport Job](https://docs.aws.amazon.com/goto/SdkForCpp/medical-imaging-2023-07-19/GetDICOMImportJob) in *AWS SDK para C\$1\$1 API Reference*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/medical-imaging/#code-examples).
------
#### [ CLI ]
**AWS CLI**
**Para obter as propriedades de um trabalho de importação dicom**
O exemplo de código `get-dicom-import-job` a seguir obtém as propriedades de um trabalho de importação dicom.
```
aws medical-imaging get-dicom-import-job \
--datastore-id "12345678901234567890123456789012" \
--job-id "09876543210987654321098765432109"
```
Saída:
```
{
"jobProperties": {
"jobId": "09876543210987654321098765432109",
"jobName": "my-job",
"jobStatus": "COMPLETED",
"datastoreId": "12345678901234567890123456789012",
"dataAccessRoleArn": "arn:aws:iam::123456789012:role/ImportJobDataAccessRole",
"endedAt": "2022-08-12T11:29:42.285000+00:00",
"submittedAt": "2022-08-12T11:28:11.152000+00:00",
"inputS3Uri": "s3://medical-imaging-dicom-input/dicom_input/",
"outputS3Uri": "s3://medical-imaging-output/job_output/12345678901234567890123456789012-DicomImport-09876543210987654321098765432109/"
}
}
```
Para obter mais informações, consulte [Obter propriedades do trabalho de importação](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-dicom-import-job.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [Get DICOMImport Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-dicom-import-job.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static DICOMImportJobProperties getDicomImportJob(MedicalImagingClient medicalImagingClient,
String datastoreId,
String jobId) {
try {
GetDicomImportJobRequest getDicomImportJobRequest = GetDicomImportJobRequest.builder()
.datastoreId(datastoreId)
.jobId(jobId)
.build();
GetDicomImportJobResponse response = medicalImagingClient.getDICOMImportJob(getDicomImportJobRequest);
return response.jobProperties();
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return null;
}
```
+ Para obter detalhes da API, consulte [Get DICOMImport Job](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/GetDICOMImportJob) in *AWS SDK for Java 2.x API Reference*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { GetDICOMImportJobCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreId - The ID of the data store.
* @param {string} jobId - The ID of the import job.
*/
export const getDICOMImportJob = async (
datastoreId = "xxxxxxxxxxxxxxxxxxxx",
jobId = "xxxxxxxxxxxxxxxxxxxx",
) => {
const response = await medicalImagingClient.send(
new GetDICOMImportJobCommand({ datastoreId: datastoreId, jobId: jobId }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'a2637936-78ea-44e7-98b8-7a87d95dfaee',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// jobProperties: {
// dataAccessRoleArn: 'arn:aws:iam::xxxxxxxxxxxx:role/dicom_import',
// datastoreId: 'xxxxxxxxxxxxxxxxxxxxxxxxx',
// endedAt: 2023-09-19T17:29:21.753Z,
// inputS3Uri: 's3://healthimaging-source/CTStudy/',
// jobId: ''xxxxxxxxxxxxxxxxxxxxxxxxx'',
// jobName: 'job_1',
// jobStatus: 'COMPLETED',
// outputS3Uri: 's3://health-imaging-dest/ouput_ct/'xxxxxxxxxxxxxxxxxxxxxxxxx'-DicomImport-'xxxxxxxxxxxxxxxxxxxxxxxxx'/',
// submittedAt: 2023-09-19T17:27:25.143Z
// }
// }
return response;
};
```
+ Para obter detalhes da API, consulte [Get DICOMImport Job](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/GetDICOMImportJobCommand) in *AWS SDK para JavaScript API Reference*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def get_dicom_import_job(self, datastore_id, job_id):
"""
Get the properties of a DICOM import job.
:param datastore_id: The ID of the data store.
:param job_id: The ID of the job.
:return: The job properties.
"""
try:
job = self.health_imaging_client.get_dicom_import_job(
jobId=job_id, datastoreId=datastore_id
)
except ClientError as err:
logger.error(
"Couldn't get DICOM import job. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return job["jobProperties"]
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para [obter detalhes da API, consulte Referência da API Get DICOMImport Job](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/GetDICOMImportJob) in *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
" iv_job_id = '12345678901234567890123456789012'
oo_result = lo_mig->getdicomimportjob(
iv_datastoreid = iv_datastore_id
iv_jobid = iv_job_id ).
DATA(lo_job_props) = oo_result->get_jobproperties( ).
DATA(lv_job_status) = lo_job_props->get_jobstatus( ).
MESSAGE |Job status: { lv_job_status }.| TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Job not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para [obter detalhes da API, consulte a referência da API Get DICOMImport Job](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) *in AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `GetDatastore` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `GetDatastore`.
------
#### [ Bash ]
**AWS CLI com script Bash**
```
###############################################################################
# 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
}
```
+ Para obter detalhes da API, consulte [GetDatastore](https://docs.aws.amazon.com/goto/aws-cli/medical-imaging-2023-07-19/GetDatastore)em *Referência de AWS CLI Comandos*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [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**
**Exemplo 1: obter as propriedades de um datastore**
O exemplo de código `get-datastore` a seguir obtém as propriedades de um armazenamento de dados.
```
aws medical-imaging get-datastore \
--datastore-id 12345678901234567890123456789012
```
Saída:
```
{
"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"
}
}
```
**Exemplo 2: Para configurar as propriedades do armazenamento de dados para JPEG2000**
O exemplo de código `get-datastore` a seguir obtém as propriedades de um datastore configurado para o formato de armazenamento JPEG 2000 Lossless.
```
aws medical-imaging get-datastore \
--datastore-id 12345678901234567890123456789012
```
Saída:
```
{
"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"
}
}
```
Para obter mais informações, consulte [Obter propriedades do armazenamento de dados](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-data-store.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [GetDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-datastore.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para 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;
}
```
+ Para obter detalhes da API, consulte [GetDatastore](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/GetDatastore)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para 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;
};
```
+ Para obter detalhes da API, consulte [GetDatastore](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/GetDatastoreCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para 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"]
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [GetDatastore](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/GetDatastore)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para 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.
```
+ Para obter detalhes da API, consulte a [GetDatastore](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `GetImageFrame` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `GetImageFrame`.
Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação em contexto no seguinte exemplo de código:
+ [Começar a usar conjuntos de imagens e quadros de imagem](example_medical-imaging_Scenario_ImageSetsAndFrames_section.md)
------
#### [ C\$1\$1 ]
**SDK para C\$1\$1**
```
//! Routine which downloads an AWS HealthImaging image frame.
/*!
\param dataStoreID: The HealthImaging data store ID.
\param imageSetID: The image set ID.
\param frameID: The image frame ID.
\param jphFile: File to store the downloaded frame.
\param clientConfig: Aws client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::Medical_Imaging::getImageFrame(const Aws::String &dataStoreID,
const Aws::String &imageSetID,
const Aws::String &frameID,
const Aws::String &jphFile,
const Aws::Client::ClientConfiguration &clientConfig) {
Aws::MedicalImaging::MedicalImagingClient client(clientConfig);
Aws::MedicalImaging::Model::GetImageFrameRequest request;
request.SetDatastoreId(dataStoreID);
request.SetImageSetId(imageSetID);
Aws::MedicalImaging::Model::ImageFrameInformation imageFrameInformation;
imageFrameInformation.SetImageFrameId(frameID);
request.SetImageFrameInformation(imageFrameInformation);
Aws::MedicalImaging::Model::GetImageFrameOutcome outcome = client.GetImageFrame(
request);
if (outcome.IsSuccess()) {
std::cout << "Successfully retrieved image frame." << std::endl;
auto &buffer = outcome.GetResult().GetImageFrameBlob();
std::ofstream outfile(jphFile, std::ios::binary);
outfile << buffer.rdbuf();
}
else {
std::cout << "Error retrieving image frame." << outcome.GetError().GetMessage()
<< std::endl;
}
return outcome.IsSuccess();
}
```
+ Para obter detalhes da API, consulte [GetImageFrame](https://docs.aws.amazon.com/goto/SdkForCpp/medical-imaging-2023-07-19/GetImageFrame)a *Referência AWS SDK para C\$1\$1 da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/medical-imaging/#code-examples).
------
#### [ CLI ]
**AWS CLI**
**Para obter dados de pixels do conjunto de imagens**
O exemplo de código `get-image-frame` a seguir obtém um quadro de imagem.
```
aws medical-imaging get-image-frame \
--datastore-id "12345678901234567890123456789012" \
--image-set-id "98765412345612345678907890789012" \
--image-frame-information imageFrameId=3abf5d5d7ae72f80a0ec81b2c0de3ef4 \
imageframe.jph
```
Observação: esse exemplo de código não inclui a saída porque a GetImageFrame ação retorna um fluxo de dados de pixels para o arquivo imageframe.jph. Para obter informações sobre decodificação e visualização de quadros de imagem, consulte Bibliotecas de decodificação HTJ2 K.
Para obter mais informações, consulte [Obter dados de pixels do conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-frame.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [GetImageFrame](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-frame.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static void getMedicalImageSetFrame(MedicalImagingClient medicalImagingClient,
String destinationPath,
String datastoreId,
String imagesetId,
String imageFrameId) {
try {
GetImageFrameRequest getImageSetMetadataRequest = GetImageFrameRequest.builder()
.datastoreId(datastoreId)
.imageSetId(imagesetId)
.imageFrameInformation(ImageFrameInformation.builder()
.imageFrameId(imageFrameId)
.build())
.build();
medicalImagingClient.getImageFrame(getImageSetMetadataRequest,
FileSystems.getDefault().getPath(destinationPath));
System.out.println("Image frame downloaded to " + destinationPath);
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ Para obter detalhes da API, consulte [GetImageFrame](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/GetImageFrame)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { GetImageFrameCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} imageFrameFileName - The name of the file for the HTJ2K-encoded image frame.
* @param {string} datastoreID - The data store's ID.
* @param {string} imageSetID - The image set's ID.
* @param {string} imageFrameID - The image frame's ID.
*/
export const getImageFrame = async (
imageFrameFileName = "image.jph",
datastoreID = "DATASTORE_ID",
imageSetID = "IMAGE_SET_ID",
imageFrameID = "IMAGE_FRAME_ID",
) => {
const response = await medicalImagingClient.send(
new GetImageFrameCommand({
datastoreId: datastoreID,
imageSetId: imageSetID,
imageFrameInformation: { imageFrameId: imageFrameID },
}),
);
const buffer = await response.imageFrameBlob.transformToByteArray();
writeFileSync(imageFrameFileName, buffer);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'e4ab42a5-25a3-4377-873f-374ecf4380e1',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// contentType: 'application/octet-stream',
// imageFrameBlob: [ IncomingMessage {}
// }
return response;
};
```
+ Para obter detalhes da API, consulte [GetImageFrame](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/GetImageFrameCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def get_pixel_data(
self, file_path_to_write, datastore_id, image_set_id, image_frame_id
):
"""
Get an image frame's pixel data.
:param file_path_to_write: The path to write the image frame's HTJ2K encoded pixel data.
:param datastore_id: The ID of the data store.
:param image_set_id: The ID of the image set.
:param image_frame_id: The ID of the image frame.
"""
try:
image_frame = self.health_imaging_client.get_image_frame(
datastoreId=datastore_id,
imageSetId=image_set_id,
imageFrameInformation={"imageFrameId": image_frame_id},
)
with open(file_path_to_write, "wb") as f:
for chunk in image_frame["imageFrameBlob"].iter_chunks():
if chunk:
f.write(chunk)
except ClientError as err:
logger.error(
"Couldn't get image frame. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [GetImageFrame](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/GetImageFrame)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
" iv_image_set_id = '1234567890123456789012345678901234567890'
" iv_image_frame_id = '1234567890123456789012345678901234567890'
oo_result = lo_mig->getimageframe(
iv_datastoreid = iv_datastore_id
iv_imagesetid = iv_image_set_id
io_imageframeinformation = NEW /aws1/cl_migimageframeinfmtion(
iv_imageframeid = iv_image_frame_id ) ).
DATA(lv_frame_blob) = oo_result->get_imageframeblob( ).
MESSAGE 'Image frame retrieved.' TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Image frame not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para obter detalhes da API, consulte a [GetImageFrame](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `GetImageSet` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `GetImageSet`.
------
#### [ CLI ]
**AWS CLI**
**Para obter as propriedades do conjunto de imagens**
O exemplo de código `get-image-set` a seguir obtém as propriedades de um conjunto de imagens.
```
aws medical-imaging get-image-set \
--datastore-id 12345678901234567890123456789012 \
--image-set-id 18f88ac7870584f58d56256646b4d92b \
--version-id 1
```
Saída:
```
{
"versionId": "1",
"imageSetWorkflowStatus": "COPIED",
"updatedAt": 1680027253.471,
"imageSetId": "18f88ac7870584f58d56256646b4d92b",
"imageSetState": "ACTIVE",
"createdAt": 1679592510.753,
"datastoreId": "12345678901234567890123456789012"
}
```
Para obter mais informações, consulte [Como obter propriedades do conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-properties.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [GetImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-set.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static GetImageSetResponse getMedicalImageSet(MedicalImagingClient medicalImagingClient,
String datastoreId,
String imagesetId,
String versionId) {
try {
GetImageSetRequest.Builder getImageSetRequestBuilder = GetImageSetRequest.builder()
.datastoreId(datastoreId)
.imageSetId(imagesetId);
if (versionId != null) {
getImageSetRequestBuilder = getImageSetRequestBuilder.versionId(versionId);
}
return medicalImagingClient.getImageSet(getImageSetRequestBuilder.build());
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return null;
}
```
+ Para obter detalhes da API, consulte [GetImageSet](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/GetImageSet)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { GetImageSetCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreId - The ID of the data store.
* @param {string} imageSetId - The ID of the image set.
* @param {string} imageSetVersion - The optional version of the image set.
*
*/
export const getImageSet = async (
datastoreId = "xxxxxxxxxxxxxxx",
imageSetId = "xxxxxxxxxxxxxxx",
imageSetVersion = "",
) => {
const params = { datastoreId: datastoreId, imageSetId: imageSetId };
if (imageSetVersion !== "") {
params.imageSetVersion = imageSetVersion;
}
const response = await medicalImagingClient.send(
new GetImageSetCommand(params),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '0615c161-410d-4d06-9d8c-6e1241bb0a5a',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// createdAt: 2023-09-22T14:49:26.427Z,
// datastoreId: 'xxxxxxxxxxxxxxx',
// imageSetArn: 'arn:aws:medical-imaging:us-east-1:xxxxxxxxxx:datastore/xxxxxxxxxxxxxxxxxxxx/imageset/xxxxxxxxxxxxxxxxxxxx',
// imageSetId: 'xxxxxxxxxxxxxxx',
// imageSetState: 'ACTIVE',
// imageSetWorkflowStatus: 'CREATED',
// updatedAt: 2023-09-22T14:49:26.427Z,
// versionId: '1'
// }
return response;
};
```
+ Para obter detalhes da API, consulte [GetImageSet](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/GetImageSetCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def get_image_set(self, datastore_id, image_set_id, version_id=None):
"""
Get the properties of an image set.
:param datastore_id: The ID of the data store.
:param image_set_id: The ID of the image set.
:param version_id: The optional version of the image set.
:return: The image set properties.
"""
try:
if version_id:
image_set = self.health_imaging_client.get_image_set(
imageSetId=image_set_id,
datastoreId=datastore_id,
versionId=version_id,
)
else:
image_set = self.health_imaging_client.get_image_set(
imageSetId=image_set_id, datastoreId=datastore_id
)
except ClientError as err:
logger.error(
"Couldn't get image set. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return image_set
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [GetImageSet](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/GetImageSet)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
" iv_image_set_id = '1234567890123456789012345678901234567890'
" iv_version_id = '1' (optional)
IF iv_version_id IS NOT INITIAL.
oo_result = lo_mig->getimageset(
iv_datastoreid = iv_datastore_id
iv_imagesetid = iv_image_set_id
iv_versionid = iv_version_id ).
ELSE.
oo_result = lo_mig->getimageset(
iv_datastoreid = iv_datastore_id
iv_imagesetid = iv_image_set_id ).
ENDIF.
DATA(lv_state) = oo_result->get_imagesetstate( ).
MESSAGE |Image set retrieved with state: { lv_state }.| TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Image set not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para obter detalhes da API, consulte a [GetImageSet](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `GetImageSetMetadata` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `GetImageSetMetadata`.
Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação em contexto no seguinte exemplo de código:
+ [Começar a usar conjuntos de imagens e quadros de imagem](example_medical-imaging_Scenario_ImageSetsAndFrames_section.md)
------
#### [ C\$1\$1 ]
**SDK para C\$1\$1**
Função de utilitário para obter metadados do conjunto de imagens.
```
//! Routine which gets a HealthImaging image set's metadata.
/*!
\param dataStoreID: The HealthImaging data store ID.
\param imageSetID: The HealthImaging image set ID.
\param versionID: The HealthImaging image set version ID, ignored if empty.
\param outputFilePath: The path where the metadata will be stored as gzipped json.
\param clientConfig: Aws client configuration.
\\return bool: Function succeeded.
*/
bool AwsDoc::Medical_Imaging::getImageSetMetadata(const Aws::String &dataStoreID,
const Aws::String &imageSetID,
const Aws::String &versionID,
const Aws::String &outputFilePath,
const Aws::Client::ClientConfiguration &clientConfig) {
Aws::MedicalImaging::Model::GetImageSetMetadataRequest request;
request.SetDatastoreId(dataStoreID);
request.SetImageSetId(imageSetID);
if (!versionID.empty()) {
request.SetVersionId(versionID);
}
Aws::MedicalImaging::MedicalImagingClient client(clientConfig);
Aws::MedicalImaging::Model::GetImageSetMetadataOutcome outcome = client.GetImageSetMetadata(
request);
if (outcome.IsSuccess()) {
std::ofstream file(outputFilePath, std::ios::binary);
auto &metadata = outcome.GetResult().GetImageSetMetadataBlob();
file << metadata.rdbuf();
}
else {
std::cerr << "Failed to get image set metadata: "
<< outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
Obter metadados do conjunto de imagens sem versão.
```
if (AwsDoc::Medical_Imaging::getImageSetMetadata(dataStoreID, imageSetID, "", outputFilePath, clientConfig))
{
std::cout << "Successfully retrieved image set metadata." << std::endl;
std::cout << "Metadata stored in: " << outputFilePath << std::endl;
}
```
Obter metadados do conjunto de imagens com versão.
```
if (AwsDoc::Medical_Imaging::getImageSetMetadata(dataStoreID, imageSetID, versionID, outputFilePath, clientConfig))
{
std::cout << "Successfully retrieved image set metadata." << std::endl;
std::cout << "Metadata stored in: " << outputFilePath << std::endl;
}
```
+ Para obter detalhes da API, consulte [GetImageSetMetadata](https://docs.aws.amazon.com/goto/SdkForCpp/medical-imaging-2023-07-19/GetImageSetMetadata)a *Referência AWS SDK para C\$1\$1 da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/medical-imaging/#code-examples).
------
#### [ CLI ]
**AWS CLI**
**Exemplo 1: para obter os metadados de um conjunto de imagens sem versão**
O exemplo de código `get-image-set-metadata` a seguir obtém metadados para um conjunto de imagens sem especificar uma versão.
Observação: `outfile` é um parâmetro obrigatório
```
aws medical-imaging get-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e \
studymetadata.json.gz
```
Os metadados retornados são compactados com o gzip e armazenados no arquivo studymetadata.json.gz. Para visualizar o conteúdo do objeto JSON retornado, você deve primeiro descompactá-lo.
Saída:
```
{
"contentType": "application/json",
"contentEncoding": "gzip"
}
```
**Exemplo 2: para obter os metadados de um conjunto de imagens com versão**
O exemplo de código `get-image-set-metadata` a seguir obtém metadados para um conjunto de imagens com uma versão especificada.
Observação: `outfile` é um parâmetro obrigatório
```
aws medical-imaging get-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--version-id 1 \
studymetadata.json.gz
```
Os metadados retornados são compactados com o gzip e armazenados no arquivo studymetadata.json.gz. Para visualizar o conteúdo do objeto JSON retornado, você deve primeiro descompactá-lo.
Saída:
```
{
"contentType": "application/json",
"contentEncoding": "gzip"
}
```
Para obter mais informações, consulte [Obter metadados do conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-metadata.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [GetImageSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-set-metadata.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static void getMedicalImageSetMetadata(MedicalImagingClient medicalImagingClient,
String destinationPath,
String datastoreId,
String imagesetId,
String versionId) {
try {
GetImageSetMetadataRequest.Builder getImageSetMetadataRequestBuilder = GetImageSetMetadataRequest.builder()
.datastoreId(datastoreId)
.imageSetId(imagesetId);
if (versionId != null) {
getImageSetMetadataRequestBuilder = getImageSetMetadataRequestBuilder.versionId(versionId);
}
medicalImagingClient.getImageSetMetadata(getImageSetMetadataRequestBuilder.build(),
FileSystems.getDefault().getPath(destinationPath));
System.out.println("Metadata downloaded to " + destinationPath);
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ Para obter detalhes da API, consulte [GetImageSetMetadata](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/GetImageSetMetadata)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
Função de utilitário para obter metadados do conjunto de imagens.
```
import { GetImageSetMetadataCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
import { writeFileSync } from "node:fs";
/**
* @param {string} metadataFileName - The name of the file for the gzipped metadata.
* @param {string} datastoreId - The ID of the data store.
* @param {string} imagesetId - The ID of the image set.
* @param {string} versionID - The optional version ID of the image set.
*/
export const getImageSetMetadata = async (
metadataFileName = "metadata.json.gzip",
datastoreId = "xxxxxxxxxxxxxx",
imagesetId = "xxxxxxxxxxxxxx",
versionID = "",
) => {
const params = { datastoreId: datastoreId, imageSetId: imagesetId };
if (versionID) {
params.versionID = versionID;
}
const response = await medicalImagingClient.send(
new GetImageSetMetadataCommand(params),
);
const buffer = await response.imageSetMetadataBlob.transformToByteArray();
writeFileSync(metadataFileName, buffer);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '5219b274-30ff-4986-8cab-48753de3a599',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// contentType: 'application/json',
// contentEncoding: 'gzip',
// imageSetMetadataBlob: ][ IncomingMessage {}
// }
return response;
};
```
Obter metadados do conjunto de imagens sem versão.
```
try {
await getImageSetMetadata(
"metadata.json.gzip",
"12345678901234567890123456789012",
"12345678901234567890123456789012",
);
} catch (err) {
console.log("Error", err);
}
```
Obter metadados do conjunto de imagens com versão.
```
try {
await getImageSetMetadata(
"metadata2.json.gzip",
"12345678901234567890123456789012",
"12345678901234567890123456789012",
"1",
);
} catch (err) {
console.log("Error", err);
}
```
+ Para obter detalhes da API, consulte [GetImageSetMetadata](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/GetImageSetMetadataCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
Função de utilitário para obter metadados do conjunto de imagens.
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def get_image_set_metadata(
self, metadata_file, datastore_id, image_set_id, version_id=None
):
"""
Get the metadata of an image set.
:param metadata_file: The file to store the JSON gzipped metadata.
:param datastore_id: The ID of the data store.
:param image_set_id: The ID of the image set.
:param version_id: The version of the image set.
"""
try:
if version_id:
image_set_metadata = self.health_imaging_client.get_image_set_metadata(
imageSetId=image_set_id,
datastoreId=datastore_id,
versionId=version_id,
)
else:
image_set_metadata = self.health_imaging_client.get_image_set_metadata(
imageSetId=image_set_id, datastoreId=datastore_id
)
print(image_set_metadata)
with open(metadata_file, "wb") as f:
for chunk in image_set_metadata["imageSetMetadataBlob"].iter_chunks():
if chunk:
f.write(chunk)
except ClientError as err:
logger.error(
"Couldn't get image metadata. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
Obter metadados do conjunto de imagens sem versão.
```
image_set_metadata = self.health_imaging_client.get_image_set_metadata(
imageSetId=image_set_id, datastoreId=datastore_id
)
```
Obter metadados do conjunto de imagens com versão.
```
image_set_metadata = self.health_imaging_client.get_image_set_metadata(
imageSetId=image_set_id,
datastoreId=datastore_id,
versionId=version_id,
)
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [GetImageSetMetadata](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/GetImageSetMetadata)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
" iv_image_set_id = '1234567890123456789012345678901234567890'
" iv_version_id = '1' (optional)
IF iv_version_id IS NOT INITIAL.
oo_result = lo_mig->getimagesetmetadata(
iv_datastoreid = iv_datastore_id
iv_imagesetid = iv_image_set_id
iv_versionid = iv_version_id ).
ELSE.
oo_result = lo_mig->getimagesetmetadata(
iv_datastoreid = iv_datastore_id
iv_imagesetid = iv_image_set_id ).
ENDIF.
DATA(lv_metadata_blob) = oo_result->get_imagesetmetadatablob( ).
MESSAGE 'Image set metadata retrieved.' TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Image set not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para obter detalhes da API, consulte a [GetImageSetMetadata](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `ListDICOMImportJobs` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `ListDICOMImportJobs`.
------
#### [ CLI ]
**AWS CLI**
**Para listar trabalhos de importação dicom**
O exemplo de código `list-dicom-import-jobs` a seguir lista os trabalhos de importação dicom.
```
aws medical-imaging list-dicom-import-jobs \
--datastore-id "12345678901234567890123456789012"
```
Saída:
```
{
"jobSummaries": [
{
"jobId": "09876543210987654321098765432109",
"jobName": "my-job",
"jobStatus": "COMPLETED",
"datastoreId": "12345678901234567890123456789012",
"dataAccessRoleArn": "arn:aws:iam::123456789012:role/ImportJobDataAccessRole",
"endedAt": "2022-08-12T11:21:56.504000+00:00",
"submittedAt": "2022-08-12T11:20:21.734000+00:00"
}
]
}
```
Para obter mais informações, consulte [Listar trabalhos de importação](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-dicom-import-jobs.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [Listar DICOMImport trabalhos](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-dicom-import-jobs.html) na *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static List listDicomImportJobs(MedicalImagingClient medicalImagingClient,
String datastoreId) {
try {
ListDicomImportJobsRequest listDicomImportJobsRequest = ListDicomImportJobsRequest.builder()
.datastoreId(datastoreId)
.build();
ListDicomImportJobsResponse response = medicalImagingClient.listDICOMImportJobs(listDicomImportJobsRequest);
return response.jobSummaries();
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return new ArrayList<>();
}
```
+ Para obter detalhes da API, consulte [Listar DICOMImport trabalhos](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/ListDICOMImportJobs) na *referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { paginateListDICOMImportJobs } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreId - The ID of the data store.
*/
export const listDICOMImportJobs = async (
datastoreId = "xxxxxxxxxxxxxxxxxx",
) => {
const paginatorConfig = {
client: medicalImagingClient,
pageSize: 50,
};
const commandParams = { datastoreId: datastoreId };
const paginator = paginateListDICOMImportJobs(paginatorConfig, commandParams);
const jobSummaries = [];
for await (const page of paginator) {
// Each page contains a list of `jobSummaries`. The list is truncated if is larger than `pageSize`.
jobSummaries.push(...page.jobSummaries);
console.log(page);
}
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '3c20c66e-0797-446a-a1d8-91b742fd15a0',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// jobSummaries: [
// {
// dataAccessRoleArn: 'arn:aws:iam::xxxxxxxxxxxx:role/dicom_import',
// datastoreId: 'xxxxxxxxxxxxxxxxxxxxxxxxx',
// endedAt: 2023-09-22T14:49:51.351Z,
// jobId: 'xxxxxxxxxxxxxxxxxxxxxxxxx',
// jobName: 'test-1',
// jobStatus: 'COMPLETED',
// submittedAt: 2023-09-22T14:48:45.767Z
// }
// ]}
return jobSummaries;
};
```
+ Para obter detalhes da API, consulte [Listar DICOMImport trabalhos](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/ListDICOMImportJobsCommand) na *referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def list_dicom_import_jobs(self, datastore_id):
"""
List the DICOM import jobs.
:param datastore_id: The ID of the data store.
:return: The list of jobs.
"""
try:
paginator = self.health_imaging_client.get_paginator(
"list_dicom_import_jobs"
)
page_iterator = paginator.paginate(datastoreId=datastore_id)
job_summaries = []
for page in page_iterator:
job_summaries.extend(page["jobSummaries"])
except ClientError as err:
logger.error(
"Couldn't list DICOM import jobs. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return job_summaries
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte Referência da API [Listar DICOMImport trabalhos](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/ListDICOMImportJobs) no *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
oo_result = lo_mig->listdicomimportjobs( iv_datastoreid = iv_datastore_id ).
DATA(lt_jobs) = oo_result->get_jobsummaries( ).
DATA(lv_count) = lines( lt_jobs ).
MESSAGE |Found { lv_count } DICOM import jobs.| TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Resource not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para obter detalhes da API, consulte [Listar DICOMImport trabalhos](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) no *AWS SDK para referência da API SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `ListDatastores` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `ListDatastores`.
------
#### [ Bash ]
**AWS CLI com script Bash**
```
###############################################################################
# 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
}
```
+ Para obter detalhes da API, consulte [ListDatastores](https://docs.aws.amazon.com/goto/aws-cli/medical-imaging-2023-07-19/ListDatastores)em *Referência de AWS CLI Comandos*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [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**
**Para listar armazenamentos de dados**
O exemplo de código `list-datastores` a seguir lista os armazenamentos de dados disponíveis.
```
aws medical-imaging list-datastores
```
Saída:
```
{
"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"
}
]
}
```
Para obter mais informações, consulte [Listar armazenamentos de dados](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-data-stores.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [ListDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-datastores.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para 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;
}
```
+ Para obter detalhes da API, consulte [ListDatastores](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/ListDatastores)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para 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;
};
```
+ Para obter detalhes da API, consulte [ListDatastores](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/ListDatastoresCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para 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
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [ListDatastores](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/ListDatastores)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para 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.
```
+ Para obter detalhes da API, consulte a [ListDatastores](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `ListImageSetVersions` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `ListImageSetVersions`.
------
#### [ CLI ]
**AWS CLI**
** Para listar as versões de um conjunto de imagens**
O exemplo de código `list-image-set-versions` a seguir lista o histórico de versões de um conjunto de imagens.
```
aws medical-imaging list-image-set-versions \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e
```
Saída:
```
{
"imageSetPropertiesList": [
{
"ImageSetWorkflowStatus": "UPDATED",
"versionId": "4",
"updatedAt": 1680029436.304,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "ACTIVE",
"createdAt": 1680027126.436
},
{
"ImageSetWorkflowStatus": "UPDATED",
"versionId": "3",
"updatedAt": 1680029163.325,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "ACTIVE",
"createdAt": 1680027126.436
},
{
"ImageSetWorkflowStatus": "COPY_FAILED",
"versionId": "2",
"updatedAt": 1680027455.944,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "ACTIVE",
"message": "INVALID_REQUEST: Series of SourceImageSet and DestinationImageSet don't match.",
"createdAt": 1680027126.436
},
{
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "ACTIVE",
"versionId": "1",
"ImageSetWorkflowStatus": "COPIED",
"createdAt": 1680027126.436
}
]
}
```
Para obter mais informações, consulte [Listar as versões do conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-image-set-versions.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [ListImageSetVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-image-set-versions.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static List listMedicalImageSetVersions(MedicalImagingClient medicalImagingClient,
String datastoreId,
String imagesetId) {
try {
ListImageSetVersionsRequest getImageSetRequest = ListImageSetVersionsRequest.builder()
.datastoreId(datastoreId)
.imageSetId(imagesetId)
.build();
ListImageSetVersionsIterable responses = medicalImagingClient
.listImageSetVersionsPaginator(getImageSetRequest);
List imageSetProperties = new ArrayList<>();
responses.stream().forEach(response -> imageSetProperties.addAll(response.imageSetPropertiesList()));
return imageSetProperties;
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return null;
}
```
+ Para obter detalhes da API, consulte [ListImageSetVersions](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/ListImageSetVersions)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { paginateListImageSetVersions } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreId - The ID of the data store.
* @param {string} imageSetId - The ID of the image set.
*/
export const listImageSetVersions = async (
datastoreId = "xxxxxxxxxxxx",
imageSetId = "xxxxxxxxxxxx",
) => {
const paginatorConfig = {
client: medicalImagingClient,
pageSize: 50,
};
const commandParams = { datastoreId, imageSetId };
const paginator = paginateListImageSetVersions(
paginatorConfig,
commandParams,
);
const imageSetPropertiesList = [];
for await (const page of paginator) {
// Each page contains a list of `jobSummaries`. The list is truncated if is larger than `pageSize`.
imageSetPropertiesList.push(...page.imageSetPropertiesList);
console.log(page);
}
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '74590b37-a002-4827-83f2-3c590279c742',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// imageSetPropertiesList: [
// {
// ImageSetWorkflowStatus: 'CREATED',
// createdAt: 2023-09-22T14:49:26.427Z,
// imageSetId: 'xxxxxxxxxxxxxxxxxxxxxxx',
// imageSetState: 'ACTIVE',
// versionId: '1'
// }]
// }
return imageSetPropertiesList;
};
```
+ Para obter detalhes da API, consulte [ListImageSetVersions](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/ListImageSetVersionsCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def list_image_set_versions(self, datastore_id, image_set_id):
"""
List the image set versions.
:param datastore_id: The ID of the data store.
:param image_set_id: The ID of the image set.
:return: The list of image set versions.
"""
try:
paginator = self.health_imaging_client.get_paginator(
"list_image_set_versions"
)
page_iterator = paginator.paginate(
imageSetId=image_set_id, datastoreId=datastore_id
)
image_set_properties_list = []
for page in page_iterator:
image_set_properties_list.extend(page["imageSetPropertiesList"])
except ClientError as err:
logger.error(
"Couldn't list image set versions. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return image_set_properties_list
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [ListImageSetVersions](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/ListImageSetVersions)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
" iv_image_set_id = '1234567890123456789012345678901234567890'
oo_result = lo_mig->listimagesetversions(
iv_datastoreid = iv_datastore_id
iv_imagesetid = iv_image_set_id ).
DATA(lt_versions) = oo_result->get_imagesetpropertieslist( ).
DATA(lv_count) = lines( lt_versions ).
MESSAGE |Found { lv_count } image set versions.| TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Image set not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para obter detalhes da API, consulte a [ListImageSetVersions](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `ListTagsForResource` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `ListTagsForResource`.
Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação em contexto nos seguintes exemplos de código:
+ [Marcar um datastore](example_medical-imaging_Scenario_TaggingDataStores_section.md)
+ [Marcar um conjunto de imagens](example_medical-imaging_Scenario_TaggingImageSets_section.md)
------
#### [ CLI ]
**AWS CLI**
**Exemplo 1: para listar as tags de recurso de um armazenamento de dados**
O exemplo de código `list-tags-for-resource` a seguir lista as tags de um armazenamento de dados.
```
aws medical-imaging list-tags-for-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012"
```
Saída:
```
{
"tags":{
"Deployment":"Development"
}
}
```
**Exemplo 2: para listar tags de recurso de um conjunto de imagens**
O exemplo de código `list-tags-for-resource` a seguir lista as tags de um conjunto de imagens.
```
aws medical-imaging list-tags-for-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b"
```
Saída:
```
{
"tags":{
"Deployment":"Development"
}
}
```
Para obter mais informações, consulte Como [marcar recursos AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-tags-for-resource.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static ListTagsForResourceResponse listMedicalImagingResourceTags(MedicalImagingClient medicalImagingClient,
String resourceArn) {
try {
ListTagsForResourceRequest listTagsForResourceRequest = ListTagsForResourceRequest.builder()
.resourceArn(resourceArn)
.build();
return medicalImagingClient.listTagsForResource(listTagsForResourceRequest);
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return null;
}
```
+ Para obter detalhes da API, consulte [ListTagsForResource](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/ListTagsForResource)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { ListTagsForResourceCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} resourceArn - The Amazon Resource Name (ARN) for the data store or image set.
*/
export const listTagsForResource = async (
resourceArn = "arn:aws:medical-imaging:us-east-1:abc:datastore/def/imageset/ghi",
) => {
const response = await medicalImagingClient.send(
new ListTagsForResourceCommand({ resourceArn: resourceArn }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '008fc6d3-abec-4870-a155-20fa3631e645',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// tags: { Deployment: 'Development' }
// }
return response;
};
```
+ Para obter detalhes da API, consulte [ListTagsForResource](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/ListTagsForResourceCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def list_tags_for_resource(self, resource_arn):
"""
List the tags for a resource.
:param resource_arn: The ARN of the resource.
:return: The list of tags.
"""
try:
tags = self.health_imaging_client.list_tags_for_resource(
resourceArn=resource_arn
)
except ClientError as err:
logger.error(
"Couldn't list tags for resource. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return tags["tags"]
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [ListTagsForResource](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/ListTagsForResource)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_resource_arn = 'arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012'
oo_result = lo_mig->listtagsforresource( iv_resourcearn = iv_resource_arn ).
DATA(lt_tags) = oo_result->get_tags( ).
DATA(lv_count) = lines( lt_tags ).
MESSAGE |Found { lv_count } tags for resource.| 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 'Resource not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para obter detalhes da API, consulte a [ListTagsForResource](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `SearchImageSets` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `SearchImageSets`.
Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação em contexto no seguinte exemplo de código:
+ [Começar a usar conjuntos de imagens e quadros de imagem](example_medical-imaging_Scenario_ImageSetsAndFrames_section.md)
------
#### [ C\$1\$1 ]
**SDK para C\$1\$1**
A função de utilitário para pesquisar conjuntos de imagens.
```
//! Routine which searches for image sets based on defined input attributes.
/*!
\param dataStoreID: The HealthImaging data store ID.
\param searchCriteria: A search criteria instance.
\param imageSetResults: Vector to receive the image set IDs.
\param clientConfig: Aws client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::Medical_Imaging::searchImageSets(const Aws::String &dataStoreID,
const Aws::MedicalImaging::Model::SearchCriteria &searchCriteria,
Aws::Vector &imageSetResults,
const Aws::Client::ClientConfiguration &clientConfig) {
Aws::MedicalImaging::MedicalImagingClient client(clientConfig);
Aws::MedicalImaging::Model::SearchImageSetsRequest request;
request.SetDatastoreId(dataStoreID);
request.SetSearchCriteria(searchCriteria);
Aws::String nextToken; // Used for paginated results.
bool result = true;
do {
if (!nextToken.empty()) {
request.SetNextToken(nextToken);
}
Aws::MedicalImaging::Model::SearchImageSetsOutcome outcome = client.SearchImageSets(
request);
if (outcome.IsSuccess()) {
for (auto &imageSetMetadataSummary: outcome.GetResult().GetImageSetsMetadataSummaries()) {
imageSetResults.push_back(imageSetMetadataSummary.GetImageSetId());
}
nextToken = outcome.GetResult().GetNextToken();
}
else {
std::cout << "Error: " << outcome.GetError().GetMessage() << std::endl;
result = false;
}
} while (!nextToken.empty());
return result;
}
```
Caso de uso nº 1: operador EQUAL.
```
Aws::Vector imageIDsForPatientID;
Aws::MedicalImaging::Model::SearchCriteria searchCriteriaEqualsPatientID;
Aws::Vector patientIDSearchFilters = {
Aws::MedicalImaging::Model::SearchFilter().WithOperator(Aws::MedicalImaging::Model::Operator::EQUAL)
.WithValues({Aws::MedicalImaging::Model::SearchByAttributeValue().WithDICOMPatientId(patientID)})
};
searchCriteriaEqualsPatientID.SetFilters(patientIDSearchFilters);
bool result = AwsDoc::Medical_Imaging::searchImageSets(dataStoreID,
searchCriteriaEqualsPatientID,
imageIDsForPatientID,
clientConfig);
if (result) {
std::cout << imageIDsForPatientID.size() << " image sets found for the patient with ID '"
<< patientID << "'." << std::endl;
for (auto &imageSetResult : imageIDsForPatientID) {
std::cout << " Image set with ID '" << imageSetResult << std::endl;
}
}
```
Caso de uso \$12: operador BETWEEN usando DICOMStudy data e DICOMStudy hora.
```
Aws::MedicalImaging::Model::SearchByAttributeValue useCase2StartDate;
useCase2StartDate.SetDICOMStudyDateAndTime(Aws::MedicalImaging::Model::DICOMStudyDateAndTime()
.WithDICOMStudyDate("19990101")
.WithDICOMStudyTime("000000.000"));
Aws::MedicalImaging::Model::SearchByAttributeValue useCase2EndDate;
useCase2EndDate.SetDICOMStudyDateAndTime(Aws::MedicalImaging::Model::DICOMStudyDateAndTime()
.WithDICOMStudyDate(Aws::Utils::DateTime(std::chrono::system_clock::now()).ToLocalTimeString("%Y%m%d"))
.WithDICOMStudyTime("000000.000"));
Aws::MedicalImaging::Model::SearchFilter useCase2SearchFilter;
useCase2SearchFilter.SetValues({useCase2StartDate, useCase2EndDate});
useCase2SearchFilter.SetOperator(Aws::MedicalImaging::Model::Operator::BETWEEN);
Aws::MedicalImaging::Model::SearchCriteria useCase2SearchCriteria;
useCase2SearchCriteria.SetFilters({useCase2SearchFilter});
Aws::Vector usesCase2Results;
result = AwsDoc::Medical_Imaging::searchImageSets(dataStoreID,
useCase2SearchCriteria,
usesCase2Results,
clientConfig);
if (result) {
std::cout << usesCase2Results.size() << " image sets found for between 1999/01/01 and present."
<< std::endl;
for (auto &imageSetResult : usesCase2Results) {
std::cout << " Image set with ID '" << imageSetResult << std::endl;
}
}
```
Caso de uso nº 3: operador BETWEEN usando o createdAt. Os estudos de tempo foram previamente persistidos.
```
Aws::MedicalImaging::Model::SearchByAttributeValue useCase3StartDate;
useCase3StartDate.SetCreatedAt(Aws::Utils::DateTime("20231130T000000000Z",Aws::Utils::DateFormat::ISO_8601_BASIC));
Aws::MedicalImaging::Model::SearchByAttributeValue useCase3EndDate;
useCase3EndDate.SetCreatedAt(Aws::Utils::DateTime(std::chrono::system_clock::now()));
Aws::MedicalImaging::Model::SearchFilter useCase3SearchFilter;
useCase3SearchFilter.SetValues({useCase3StartDate, useCase3EndDate});
useCase3SearchFilter.SetOperator(Aws::MedicalImaging::Model::Operator::BETWEEN);
Aws::MedicalImaging::Model::SearchCriteria useCase3SearchCriteria;
useCase3SearchCriteria.SetFilters({useCase3SearchFilter});
Aws::Vector usesCase3Results;
result = AwsDoc::Medical_Imaging::searchImageSets(dataStoreID,
useCase3SearchCriteria,
usesCase3Results,
clientConfig);
if (result) {
std::cout << usesCase3Results.size() << " image sets found for created between 2023/11/30 and present."
<< std::endl;
for (auto &imageSetResult : usesCase3Results) {
std::cout << " Image set with ID '" << imageSetResult << std::endl;
}
}
```
Caso de uso \$14: operador EQUAL em DICOMSeries InstanceUID e BETWEEN em updatedAt e classifique a resposta em ordem ASC no campo updatedAt.
```
Aws::MedicalImaging::Model::SearchByAttributeValue useCase4StartDate;
useCase4StartDate.SetUpdatedAt(Aws::Utils::DateTime("20231130T000000000Z",Aws::Utils::DateFormat::ISO_8601_BASIC));
Aws::MedicalImaging::Model::SearchByAttributeValue useCase4EndDate;
useCase4EndDate.SetUpdatedAt(Aws::Utils::DateTime(std::chrono::system_clock::now()));
Aws::MedicalImaging::Model::SearchFilter useCase4SearchFilterBetween;
useCase4SearchFilterBetween.SetValues({useCase4StartDate, useCase4EndDate});
useCase4SearchFilterBetween.SetOperator(Aws::MedicalImaging::Model::Operator::BETWEEN);
Aws::MedicalImaging::Model::SearchByAttributeValue seriesInstanceUID;
seriesInstanceUID.SetDICOMSeriesInstanceUID(dicomSeriesInstanceUID);
Aws::MedicalImaging::Model::SearchFilter useCase4SearchFilterEqual;
useCase4SearchFilterEqual.SetValues({seriesInstanceUID});
useCase4SearchFilterEqual.SetOperator(Aws::MedicalImaging::Model::Operator::EQUAL);
Aws::MedicalImaging::Model::SearchCriteria useCase4SearchCriteria;
useCase4SearchCriteria.SetFilters({useCase4SearchFilterBetween, useCase4SearchFilterEqual});
Aws::MedicalImaging::Model::Sort useCase4Sort;
useCase4Sort.SetSortField(Aws::MedicalImaging::Model::SortField::updatedAt);
useCase4Sort.SetSortOrder(Aws::MedicalImaging::Model::SortOrder::ASC);
useCase4SearchCriteria.SetSort(useCase4Sort);
Aws::Vector usesCase4Results;
result = AwsDoc::Medical_Imaging::searchImageSets(dataStoreID,
useCase4SearchCriteria,
usesCase4Results,
clientConfig);
if (result) {
std::cout << usesCase4Results.size() << " image sets found for EQUAL operator "
<< "on DICOMSeriesInstanceUID and BETWEEN on updatedAt and sort response\n"
<< "in ASC order on updatedAt field." << std::endl;
for (auto &imageSetResult : usesCase4Results) {
std::cout << " Image set with ID '" << imageSetResult << std::endl;
}
}
```
+ Para obter detalhes da API, consulte [SearchImageSets](https://docs.aws.amazon.com/goto/SdkForCpp/medical-imaging-2023-07-19/SearchImageSets)a *Referência AWS SDK para C\$1\$1 da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/medical-imaging/#code-examples).
------
#### [ CLI ]
**AWS CLI**
**Exemplo 1: para pesquisar conjuntos de imagens com um operador EQUAL**
O exemplo de código `search-image-sets` a seguir usa o operador EQUAL para pesquisar conjuntos de imagens com base em um valor específico.
```
aws medical-imaging search-image-sets \
--datastore-id 12345678901234567890123456789012 \
--search-criteria file://search-criteria.json
```
Conteúdo de `search-criteria.json`
```
{
"filters": [{
"values": [{"DICOMPatientId" : "SUBJECT08701"}],
"operator": "EQUAL"
}]
}
```
Saída:
```
{
"imageSetsMetadataSummaries": [{
"imageSetId": "09876543210987654321098765432109",
"createdAt": "2022-12-06T21:40:59.429000+00:00",
"version": 1,
"DICOMTags": {
"DICOMStudyId": "2011201407",
"DICOMStudyDate": "19991122",
"DICOMPatientSex": "F",
"DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
"DICOMPatientBirthDate": "19201120",
"DICOMStudyDescription": "UNKNOWN",
"DICOMPatientId": "SUBJECT08701",
"DICOMPatientName": "Melissa844 Huel628",
"DICOMNumberOfStudyRelatedInstances": 1,
"DICOMStudyTime": "140728",
"DICOMNumberOfStudyRelatedSeries": 1
},
"updatedAt": "2022-12-06T21:40:59.429000+00:00"
}]
}
```
**Exemplo 2: Para pesquisar conjuntos de imagens com um operador BETWEEN usando DICOMStudy data e DICOMStudy hora**
O exemplo de código `search-image-sets` a seguir pesquisa conjuntos de imagens com estudos DICOM gerados entre 1º de janeiro de 1990 (00h) e 1º de janeiro de 2023 (00h).
Nota: O DICOMStudy horário é opcional. Se não estiver presente, 00h (início do dia) é o valor da hora para as datas fornecidas para filtragem.
```
aws medical-imaging search-image-sets \
--datastore-id 12345678901234567890123456789012 \
--search-criteria file://search-criteria.json
```
Conteúdo de `search-criteria.json`
```
{
"filters": [{
"values": [{
"DICOMStudyDateAndTime": {
"DICOMStudyDate": "19900101",
"DICOMStudyTime": "000000"
}
},
{
"DICOMStudyDateAndTime": {
"DICOMStudyDate": "20230101",
"DICOMStudyTime": "000000"
}
}],
"operator": "BETWEEN"
}]
}
```
Saída:
```
{
"imageSetsMetadataSummaries": [{
"imageSetId": "09876543210987654321098765432109",
"createdAt": "2022-12-06T21:40:59.429000+00:00",
"version": 1,
"DICOMTags": {
"DICOMStudyId": "2011201407",
"DICOMStudyDate": "19991122",
"DICOMPatientSex": "F",
"DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
"DICOMPatientBirthDate": "19201120",
"DICOMStudyDescription": "UNKNOWN",
"DICOMPatientId": "SUBJECT08701",
"DICOMPatientName": "Melissa844 Huel628",
"DICOMNumberOfStudyRelatedInstances": 1,
"DICOMStudyTime": "140728",
"DICOMNumberOfStudyRelatedSeries": 1
},
"updatedAt": "2022-12-06T21:40:59.429000+00:00"
}]
}
```
**Exemplo 3: para pesquisar conjuntos de imagens com um operador BETWEEN usando createdAt (os estudos de tempo persistiam anteriormente)**
O exemplo de `search-image-sets` código a seguir pesquisa conjuntos de imagens com estudos DICOM persistentes HealthImaging entre os intervalos de tempo no fuso horário UTC.
Observação: forneça createdAt no formato do exemplo ("1985-04-12T23:20:50.52Z").
```
aws medical-imaging search-image-sets \
--datastore-id 12345678901234567890123456789012 \
--search-criteria file://search-criteria.json
```
Conteúdo de `search-criteria.json`
```
{
"filters": [{
"values": [{
"createdAt": "1985-04-12T23:20:50.52Z"
},
{
"createdAt": "2022-04-12T23:20:50.52Z"
}],
"operator": "BETWEEN"
}]
}
```
Saída:
```
{
"imageSetsMetadataSummaries": [{
"imageSetId": "09876543210987654321098765432109",
"createdAt": "2022-12-06T21:40:59.429000+00:00",
"version": 1,
"DICOMTags": {
"DICOMStudyId": "2011201407",
"DICOMStudyDate": "19991122",
"DICOMPatientSex": "F",
"DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
"DICOMPatientBirthDate": "19201120",
"DICOMStudyDescription": "UNKNOWN",
"DICOMPatientId": "SUBJECT08701",
"DICOMPatientName": "Melissa844 Huel628",
"DICOMNumberOfStudyRelatedInstances": 1,
"DICOMStudyTime": "140728",
"DICOMNumberOfStudyRelatedSeries": 1
},
"lastUpdatedAt": "2022-12-06T21:40:59.429000+00:00"
}]
}
```
**Exemplo 4: Para pesquisar conjuntos de imagens com um operador EQUAL em DICOMSeries InstanceUID e BETWEEN em updatedAt e classificar a resposta em ordem ASC no campo updatedAt**
O exemplo de `search-image-sets` código a seguir pesquisa conjuntos de imagens com um operador EQUAL em DICOMSeries InstanceUID e BETWEEN em updatedAt e classifica a resposta em ordem ASC no campo updatedAt.
Observação: forneça updatedAt no formato do exemplo ("1985-04-12T23:20:50.52Z").
```
aws medical-imaging search-image-sets \
--datastore-id 12345678901234567890123456789012 \
--search-criteria file://search-criteria.json
```
Conteúdo de `search-criteria.json`
```
{
"filters": [{
"values": [{
"updatedAt": "2024-03-11T15:00:05.074000-07:00"
}, {
"updatedAt": "2024-03-11T16:00:05.074000-07:00"
}],
"operator": "BETWEEN"
}, {
"values": [{
"DICOMSeriesInstanceUID": "1.2.840.99999999.84710745.943275268089"
}],
"operator": "EQUAL"
}],
"sort": {
"sortField": "updatedAt",
"sortOrder": "ASC"
}
}
```
Saída:
```
{
"imageSetsMetadataSummaries": [{
"imageSetId": "09876543210987654321098765432109",
"createdAt": "2022-12-06T21:40:59.429000+00:00",
"version": 1,
"DICOMTags": {
"DICOMStudyId": "2011201407",
"DICOMStudyDate": "19991122",
"DICOMPatientSex": "F",
"DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
"DICOMPatientBirthDate": "19201120",
"DICOMStudyDescription": "UNKNOWN",
"DICOMPatientId": "SUBJECT08701",
"DICOMPatientName": "Melissa844 Huel628",
"DICOMNumberOfStudyRelatedInstances": 1,
"DICOMStudyTime": "140728",
"DICOMNumberOfStudyRelatedSeries": 1
},
"lastUpdatedAt": "2022-12-06T21:40:59.429000+00:00"
}]
}
```
Para obter mais informações, consulte [Pesquisar conjuntos de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/search-image-sets.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [SearchImageSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/search-image-sets.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
A função de utilitário para pesquisar conjuntos de imagens.
```
public static List searchMedicalImagingImageSets(
MedicalImagingClient medicalImagingClient,
String datastoreId, SearchCriteria searchCriteria) {
try {
SearchImageSetsRequest datastoreRequest = SearchImageSetsRequest.builder()
.datastoreId(datastoreId)
.searchCriteria(searchCriteria)
.build();
SearchImageSetsIterable responses = medicalImagingClient
.searchImageSetsPaginator(datastoreRequest);
List imageSetsMetadataSummaries = new ArrayList<>();
responses.stream().forEach(response -> imageSetsMetadataSummaries
.addAll(response.imageSetsMetadataSummaries()));
return imageSetsMetadataSummaries;
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return null;
}
```
Caso de uso nº 1: operador EQUAL.
```
List searchFilters = Collections.singletonList(SearchFilter.builder()
.operator(Operator.EQUAL)
.values(SearchByAttributeValue.builder()
.dicomPatientId(patientId)
.build())
.build());
SearchCriteria searchCriteria = SearchCriteria.builder()
.filters(searchFilters)
.build();
List imageSetsMetadataSummaries = searchMedicalImagingImageSets(
medicalImagingClient,
datastoreId, searchCriteria);
if (imageSetsMetadataSummaries != null) {
System.out.println("The image sets for patient " + patientId + " are:\n"
+ imageSetsMetadataSummaries);
System.out.println();
}
```
Caso de uso \$12: operador BETWEEN usando DICOMStudy data e DICOMStudy hora.
```
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyyMMdd");
searchFilters = Collections.singletonList(SearchFilter.builder()
.operator(Operator.BETWEEN)
.values(SearchByAttributeValue.builder()
.dicomStudyDateAndTime(DICOMStudyDateAndTime.builder()
.dicomStudyDate("19990101")
.dicomStudyTime("000000.000")
.build())
.build(),
SearchByAttributeValue.builder()
.dicomStudyDateAndTime(DICOMStudyDateAndTime.builder()
.dicomStudyDate((LocalDate.now()
.format(formatter)))
.dicomStudyTime("000000.000")
.build())
.build())
.build());
searchCriteria = SearchCriteria.builder()
.filters(searchFilters)
.build();
imageSetsMetadataSummaries = searchMedicalImagingImageSets(medicalImagingClient,
datastoreId, searchCriteria);
if (imageSetsMetadataSummaries != null) {
System.out.println(
"The image sets searched with BETWEEN operator using DICOMStudyDate and DICOMStudyTime are:\n"
+
imageSetsMetadataSummaries);
System.out.println();
}
```
Caso de uso nº 3: operador BETWEEN usando o createdAt. Os estudos de tempo foram previamente persistidos.
```
searchFilters = Collections.singletonList(SearchFilter.builder()
.operator(Operator.BETWEEN)
.values(SearchByAttributeValue.builder()
.createdAt(Instant.parse("1985-04-12T23:20:50.52Z"))
.build(),
SearchByAttributeValue.builder()
.createdAt(Instant.now())
.build())
.build());
searchCriteria = SearchCriteria.builder()
.filters(searchFilters)
.build();
imageSetsMetadataSummaries = searchMedicalImagingImageSets(medicalImagingClient,
datastoreId, searchCriteria);
if (imageSetsMetadataSummaries != null) {
System.out.println("The image sets searched with BETWEEN operator using createdAt are:\n "
+ imageSetsMetadataSummaries);
System.out.println();
}
```
Caso de uso \$14: operador EQUAL em DICOMSeries InstanceUID e BETWEEN em updatedAt e classifique a resposta em ordem ASC no campo updatedAt.
```
Instant startDate = Instant.parse("1985-04-12T23:20:50.52Z");
Instant endDate = Instant.now();
searchFilters = Arrays.asList(
SearchFilter.builder()
.operator(Operator.EQUAL)
.values(SearchByAttributeValue.builder()
.dicomSeriesInstanceUID(seriesInstanceUID)
.build())
.build(),
SearchFilter.builder()
.operator(Operator.BETWEEN)
.values(
SearchByAttributeValue.builder().updatedAt(startDate).build(),
SearchByAttributeValue.builder().updatedAt(endDate).build()
).build());
Sort sort = Sort.builder().sortOrder(SortOrder.ASC).sortField(SortField.UPDATED_AT).build();
searchCriteria = SearchCriteria.builder()
.filters(searchFilters)
.sort(sort)
.build();
imageSetsMetadataSummaries = searchMedicalImagingImageSets(medicalImagingClient,
datastoreId, searchCriteria);
if (imageSetsMetadataSummaries != null) {
System.out.println("The image sets searched with EQUAL operator on DICOMSeriesInstanceUID and BETWEEN on updatedAt and sort response\n" +
"in ASC order on updatedAt field are:\n "
+ imageSetsMetadataSummaries);
System.out.println();
}
```
+ Para obter detalhes da API, consulte [SearchImageSets](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/SearchImageSets)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
A função de utilitário para pesquisar conjuntos de imagens.
```
import { paginateSearchImageSets } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreId - The data store's ID.
* @param { import('@aws-sdk/client-medical-imaging').SearchFilter[] } filters - The search criteria filters.
* @param { import('@aws-sdk/client-medical-imaging').Sort } sort - The search criteria sort.
*/
export const searchImageSets = async (
datastoreId = "xxxxxxxx",
searchCriteria = {},
) => {
const paginatorConfig = {
client: medicalImagingClient,
pageSize: 50,
};
const commandParams = {
datastoreId: datastoreId,
searchCriteria: searchCriteria,
};
const paginator = paginateSearchImageSets(paginatorConfig, commandParams);
const imageSetsMetadataSummaries = [];
for await (const page of paginator) {
// Each page contains a list of `jobSummaries`. The list is truncated if is larger than `pageSize`.
imageSetsMetadataSummaries.push(...page.imageSetsMetadataSummaries);
console.log(page);
}
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'f009ea9c-84ca-4749-b5b6-7164f00a5ada',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// imageSetsMetadataSummaries: [
// {
// DICOMTags: [Object],
// createdAt: "2023-09-19T16:59:40.551Z",
// imageSetId: '7f75e1b5c0f40eac2b24cf712f485f50',
// updatedAt: "2023-09-19T16:59:40.551Z",
// version: 1
// }]
// }
return imageSetsMetadataSummaries;
};
```
Caso de uso nº 1: operador EQUAL.
```
const datastoreId = "12345678901234567890123456789012";
try {
const searchCriteria = {
filters: [
{
values: [{ DICOMPatientId: "1234567" }],
operator: "EQUAL",
},
],
};
await searchImageSets(datastoreId, searchCriteria);
} catch (err) {
console.error(err);
}
```
Caso de uso \$12: operador BETWEEN usando DICOMStudy data e DICOMStudy hora.
```
const datastoreId = "12345678901234567890123456789012";
try {
const searchCriteria = {
filters: [
{
values: [
{
DICOMStudyDateAndTime: {
DICOMStudyDate: "19900101",
DICOMStudyTime: "000000",
},
},
{
DICOMStudyDateAndTime: {
DICOMStudyDate: "20230901",
DICOMStudyTime: "000000",
},
},
],
operator: "BETWEEN",
},
],
};
await searchImageSets(datastoreId, searchCriteria);
} catch (err) {
console.error(err);
}
```
Caso de uso nº 3: operador BETWEEN usando o createdAt. Os estudos de tempo foram previamente persistidos.
```
const datastoreId = "12345678901234567890123456789012";
try {
const searchCriteria = {
filters: [
{
values: [
{ createdAt: new Date("1985-04-12T23:20:50.52Z") },
{ createdAt: new Date() },
],
operator: "BETWEEN",
},
],
};
await searchImageSets(datastoreId, searchCriteria);
} catch (err) {
console.error(err);
}
```
Caso de uso \$14: operador EQUAL em DICOMSeries InstanceUID e BETWEEN em updatedAt e classifique a resposta em ordem ASC no campo updatedAt.
```
const datastoreId = "12345678901234567890123456789012";
try {
const searchCriteria = {
filters: [
{
values: [
{ updatedAt: new Date("1985-04-12T23:20:50.52Z") },
{ updatedAt: new Date() },
],
operator: "BETWEEN",
},
{
values: [
{
DICOMSeriesInstanceUID:
"1.1.123.123456.1.12.1.1234567890.1234.12345678.123",
},
],
operator: "EQUAL",
},
],
sort: {
sortOrder: "ASC",
sortField: "updatedAt",
},
};
await searchImageSets(datastoreId, searchCriteria);
} catch (err) {
console.error(err);
}
```
+ Para obter detalhes da API, consulte [SearchImageSets](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/SearchImageSetsCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
A função de utilitário para pesquisar conjuntos de imagens.
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def search_image_sets(self, datastore_id, search_filter):
"""
Search for image sets.
:param datastore_id: The ID of the data store.
:param search_filter: The search filter.
For example: {"filters" : [{ "operator": "EQUAL", "values": [{"DICOMPatientId": "3524578"}]}]}.
:return: The list of image sets.
"""
try:
paginator = self.health_imaging_client.get_paginator("search_image_sets")
page_iterator = paginator.paginate(
datastoreId=datastore_id, searchCriteria=search_filter
)
metadata_summaries = []
for page in page_iterator:
metadata_summaries.extend(page["imageSetsMetadataSummaries"])
except ClientError as err:
logger.error(
"Couldn't search image sets. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return metadata_summaries
```
Caso de uso nº 1: operador EQUAL.
```
search_filter = {
"filters": [
{"operator": "EQUAL", "values": [{"DICOMPatientId": patient_id}]}
]
}
image_sets = self.search_image_sets(data_store_id, search_filter)
print(f"Image sets found with EQUAL operator\n{image_sets}")
```
Caso de uso \$12: operador BETWEEN usando DICOMStudy data e DICOMStudy hora.
```
search_filter = {
"filters": [
{
"operator": "BETWEEN",
"values": [
{
"DICOMStudyDateAndTime": {
"DICOMStudyDate": "19900101",
"DICOMStudyTime": "000000",
}
},
{
"DICOMStudyDateAndTime": {
"DICOMStudyDate": "20230101",
"DICOMStudyTime": "000000",
}
},
],
}
]
}
image_sets = self.search_image_sets(data_store_id, search_filter)
print(
f"Image sets found with BETWEEN operator using DICOMStudyDate and DICOMStudyTime\n{image_sets}"
)
```
Caso de uso nº 3: operador BETWEEN usando o createdAt. Os estudos de tempo foram previamente persistidos.
```
search_filter = {
"filters": [
{
"values": [
{
"createdAt": datetime.datetime(
2021, 8, 4, 14, 49, 54, 429000
)
},
{
"createdAt": datetime.datetime.now()
+ datetime.timedelta(days=1)
},
],
"operator": "BETWEEN",
}
]
}
recent_image_sets = self.search_image_sets(data_store_id, search_filter)
print(
f"Image sets found with with BETWEEN operator using createdAt\n{recent_image_sets}"
)
```
Caso de uso \$14: operador EQUAL em DICOMSeries InstanceUID e BETWEEN em updatedAt e classifique a resposta em ordem ASC no campo updatedAt.
```
search_filter = {
"filters": [
{
"values": [
{
"updatedAt": datetime.datetime(
2021, 8, 4, 14, 49, 54, 429000
)
},
{
"updatedAt": datetime.datetime.now()
+ datetime.timedelta(days=1)
},
],
"operator": "BETWEEN",
},
{
"values": [{"DICOMSeriesInstanceUID": series_instance_uid}],
"operator": "EQUAL",
},
],
"sort": {
"sortOrder": "ASC",
"sortField": "updatedAt",
},
}
image_sets = self.search_image_sets(data_store_id, search_filter)
print(
"Image sets found with EQUAL operator on DICOMSeriesInstanceUID and BETWEEN on updatedAt and"
)
print(f"sort response in ASC order on updatedAt field\n{image_sets}")
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [SearchImageSets](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/SearchImageSets)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
oo_result = lo_mig->searchimagesets(
iv_datastoreid = iv_datastore_id
io_searchcriteria = io_search_criteria ).
DATA(lt_imagesets) = oo_result->get_imagesetsmetadatasums( ).
DATA(lv_count) = lines( lt_imagesets ).
MESSAGE |Found { lv_count } image sets.| TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Resource not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para obter detalhes da API, consulte a [SearchImageSets](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `StartDICOMImportJob` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `StartDICOMImportJob`.
Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação em contexto no seguinte exemplo de código:
+ [Começar a usar conjuntos de imagens e quadros de imagem](example_medical-imaging_Scenario_ImageSetsAndFrames_section.md)
------
#### [ C\$1\$1 ]
**SDK para C\$1\$1**
```
//! Routine which starts a HealthImaging import job.
/*!
\param dataStoreID: The HealthImaging data store ID.
\param inputBucketName: The name of the Amazon S3 bucket containing the DICOM files.
\param inputDirectory: The directory in the S3 bucket containing the DICOM files.
\param outputBucketName: The name of the S3 bucket for the output.
\param outputDirectory: The directory in the S3 bucket to store the output.
\param roleArn: The ARN of the IAM role with permissions for the import.
\param importJobId: A string to receive the import job ID.
\param clientConfig: Aws client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::Medical_Imaging::startDICOMImportJob(
const Aws::String &dataStoreID, const Aws::String &inputBucketName,
const Aws::String &inputDirectory, const Aws::String &outputBucketName,
const Aws::String &outputDirectory, const Aws::String &roleArn,
Aws::String &importJobId,
const Aws::Client::ClientConfiguration &clientConfig) {
Aws::MedicalImaging::MedicalImagingClient medicalImagingClient(clientConfig);
Aws::String inputURI = "s3://" + inputBucketName + "/" + inputDirectory + "/";
Aws::String outputURI = "s3://" + outputBucketName + "/" + outputDirectory + "/";
Aws::MedicalImaging::Model::StartDICOMImportJobRequest startDICOMImportJobRequest;
startDICOMImportJobRequest.SetDatastoreId(dataStoreID);
startDICOMImportJobRequest.SetDataAccessRoleArn(roleArn);
startDICOMImportJobRequest.SetInputS3Uri(inputURI);
startDICOMImportJobRequest.SetOutputS3Uri(outputURI);
Aws::MedicalImaging::Model::StartDICOMImportJobOutcome startDICOMImportJobOutcome = medicalImagingClient.StartDICOMImportJob(
startDICOMImportJobRequest);
if (startDICOMImportJobOutcome.IsSuccess()) {
importJobId = startDICOMImportJobOutcome.GetResult().GetJobId();
}
else {
std::cerr << "Failed to start DICOM import job because "
<< startDICOMImportJobOutcome.GetError().GetMessage() << std::endl;
}
return startDICOMImportJobOutcome.IsSuccess();
}
```
+ Para obter detalhes sobre a API, consulte [Start DICOMImport Job](https://docs.aws.amazon.com/goto/SdkForCpp/medical-imaging-2023-07-19/StartDICOMImportJob) in *AWS SDK para C\$1\$1 API Reference*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/medical-imaging/#code-examples).
------
#### [ CLI ]
**AWS CLI**
**Para iniciar um trabalho de importação dicom**
O exemplo de código `start-dicom-import-job` a seguir inicia um trabalho de importação dicom.
```
aws medical-imaging start-dicom-import-job \
--job-name "my-job" \
--datastore-id "12345678901234567890123456789012" \
--input-s3-uri "s3://medical-imaging-dicom-input/dicom_input/" \
--output-s3-uri "s3://medical-imaging-output/job_output/" \
--data-access-role-arn "arn:aws:iam::123456789012:role/ImportJobDataAccessRole"
```
Saída:
```
{
"datastoreId": "12345678901234567890123456789012",
"jobId": "09876543210987654321098765432109",
"jobStatus": "SUBMITTED",
"submittedAt": "2022-08-12T11:28:11.152000+00:00"
}
```
Para obter mais informações, consulte [Iniciando um trabalho de importação](https://docs.aws.amazon.com/healthimaging/latest/devguide/start-dicom-import-job.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [Start DICOMImport Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/start-dicom-import-job.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static String startDicomImportJob(MedicalImagingClient medicalImagingClient,
String jobName,
String datastoreId,
String dataAccessRoleArn,
String inputS3Uri,
String outputS3Uri) {
try {
StartDicomImportJobRequest startDicomImportJobRequest = StartDicomImportJobRequest.builder()
.jobName(jobName)
.datastoreId(datastoreId)
.dataAccessRoleArn(dataAccessRoleArn)
.inputS3Uri(inputS3Uri)
.outputS3Uri(outputS3Uri)
.build();
StartDicomImportJobResponse response = medicalImagingClient.startDICOMImportJob(startDicomImportJobRequest);
return response.jobId();
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
```
+ Para obter detalhes sobre a API, consulte [Start DICOMImport Job](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/StartDICOMImportJob) in *AWS SDK for Java 2.x API Reference*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { StartDICOMImportJobCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} jobName - The name of the import job.
* @param {string} datastoreId - The ID of the data store.
* @param {string} dataAccessRoleArn - The Amazon Resource Name (ARN) of the role that grants permission.
* @param {string} inputS3Uri - The URI of the S3 bucket containing the input files.
* @param {string} outputS3Uri - The URI of the S3 bucket where the output files are stored.
*/
export const startDicomImportJob = async (
jobName = "test-1",
datastoreId = "12345678901234567890123456789012",
dataAccessRoleArn = "arn:aws:iam::xxxxxxxxxxxx:role/ImportJobDataAccessRole",
inputS3Uri = "s3://medical-imaging-dicom-input/dicom_input/",
outputS3Uri = "s3://medical-imaging-output/job_output/",
) => {
const response = await medicalImagingClient.send(
new StartDICOMImportJobCommand({
jobName: jobName,
datastoreId: datastoreId,
dataAccessRoleArn: dataAccessRoleArn,
inputS3Uri: inputS3Uri,
outputS3Uri: outputS3Uri,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '6e81d191-d46b-4e48-a08a-cdcc7e11eb79',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// datastoreId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
// jobId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
// jobStatus: 'SUBMITTED',
// submittedAt: 2023-09-22T14:48:45.767Z
// }
return response;
};
```
+ Para obter detalhes sobre a API, consulte [Start DICOMImport Job](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/StartDICOMImportJobCommand) in *AWS SDK para JavaScript API Reference*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def start_dicom_import_job(
self, job_name, datastore_id, role_arn, input_s3_uri, output_s3_uri
):
"""
Start a DICOM import job.
:param job_name: The name of the job.
:param datastore_id: The ID of the data store.
:param role_arn: The Amazon Resource Name (ARN) of the role to use for the job.
:param input_s3_uri: The S3 bucket input prefix path containing the DICOM files.
:param output_s3_uri: The S3 bucket output prefix path for the result.
:return: The job ID.
"""
try:
job = self.health_imaging_client.start_dicom_import_job(
jobName=job_name,
datastoreId=datastore_id,
dataAccessRoleArn=role_arn,
inputS3Uri=input_s3_uri,
outputS3Uri=output_s3_uri,
)
except ClientError as err:
logger.error(
"Couldn't start DICOM import job. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return job["jobId"]
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte Referência da API [Start DICOMImport Job](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/StartDICOMImportJob) in *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_job_name = 'import-job-1'
" iv_datastore_id = '1234567890123456789012345678901234567890'
" iv_role_arn = 'arn:aws:iam::123456789012:role/ImportJobRole'
" iv_input_s3_uri = 's3://my-bucket/input/'
" iv_output_s3_uri = 's3://my-bucket/output/'
oo_result = lo_mig->startdicomimportjob(
iv_jobname = iv_job_name
iv_datastoreid = iv_datastore_id
iv_dataaccessrolearn = iv_role_arn
iv_inputs3uri = iv_input_s3_uri
iv_outputs3uri = iv_output_s3_uri ).
DATA(lv_job_id) = oo_result->get_jobid( ).
MESSAGE |DICOM import job started with ID: { lv_job_id }.| TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Resource not found.' 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.
```
+ Para obter detalhes da API, consulte [a referência da API Start DICOMImport Job](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) *in AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `TagResource` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `TagResource`.
Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação em contexto nos seguintes exemplos de código:
+ [Marcar um datastore](example_medical-imaging_Scenario_TaggingDataStores_section.md)
+ [Marcar um conjunto de imagens](example_medical-imaging_Scenario_TaggingImageSets_section.md)
------
#### [ CLI ]
**AWS CLI**
**Exemplo 1: para marcar um armazenamento de dados**
Os exemplos de código `tag-resource` a seguir marcam um armazenamento de dados.
```
aws medical-imaging tag-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" \
--tags '{"Deployment":"Development"}'
```
Este comando não produz saída.
**Exemplo 2: para marcar um conjunto de imagens**
Os exemplos de código `tag-resource` a seguir marcam um conjunto de imagens.
```
aws medical-imaging tag-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" \
--tags '{"Deployment":"Development"}'
```
Este comando não produz saída.
Para obter mais informações, consulte Como [marcar recursos AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/tag-resource.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static void tagMedicalImagingResource(MedicalImagingClient medicalImagingClient,
String resourceArn,
Map tags) {
try {
TagResourceRequest tagResourceRequest = TagResourceRequest.builder()
.resourceArn(resourceArn)
.tags(tags)
.build();
medicalImagingClient.tagResource(tagResourceRequest);
System.out.println("Tags have been added to the resource.");
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ Para obter detalhes da API, consulte [TagResource](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/TagResource)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { TagResourceCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} resourceArn - The Amazon Resource Name (ARN) for the data store or image set.
* @param {Record} tags - The tags to add to the resource as JSON.
* - For example: {"Deployment" : "Development"}
*/
export const tagResource = async (
resourceArn = "arn:aws:medical-imaging:us-east-1:xxxxxx:datastore/xxxxx/imageset/xxx",
tags = {},
) => {
const response = await medicalImagingClient.send(
new TagResourceCommand({ resourceArn: resourceArn, tags: tags }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 204,
// requestId: '8a6de9a3-ec8e-47ef-8643-473518b19d45',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// }
// }
return response;
};
```
+ Para obter detalhes da API, consulte [TagResource](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/TagResourceCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def tag_resource(self, resource_arn, tags):
"""
Tag a resource.
:param resource_arn: The ARN of the resource.
:param tags: The tags to apply.
"""
try:
self.health_imaging_client.tag_resource(resourceArn=resource_arn, tags=tags)
except ClientError as err:
logger.error(
"Couldn't tag resource. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [TagResource](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/TagResource)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_resource_arn = 'arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012'
lo_mig->tagresource(
iv_resourcearn = iv_resource_arn
it_tags = it_tags ).
MESSAGE 'Resource tagged successfully.' 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 'Resource not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para obter detalhes da API, consulte a [TagResource](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `UntagResource` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `UntagResource`.
Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação em contexto nos seguintes exemplos de código:
+ [Marcar um datastore](example_medical-imaging_Scenario_TaggingDataStores_section.md)
+ [Marcar um conjunto de imagens](example_medical-imaging_Scenario_TaggingImageSets_section.md)
------
#### [ CLI ]
**AWS CLI**
**Exemplo 1: para desmarcar um armazenamento de dados**
O exemplo de código `untag-resource` a seguir desmarca um armazenamento de dados.
```
aws medical-imaging untag-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" \
--tag-keys '["Deployment"]'
```
Este comando não produz saída.
**Exemplo 2: para desmarcar um conjunto de imagens**
O exemplo de código `untag-resource` a seguir desmarca um conjunto de imagens.
```
aws medical-imaging untag-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" \
--tag-keys '["Deployment"]'
```
Este comando não produz saída.
Para obter mais informações, consulte Como [marcar recursos AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/untag-resource.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
public static void untagMedicalImagingResource(MedicalImagingClient medicalImagingClient,
String resourceArn,
Collection tagKeys) {
try {
UntagResourceRequest untagResourceRequest = UntagResourceRequest.builder()
.resourceArn(resourceArn)
.tagKeys(tagKeys)
.build();
medicalImagingClient.untagResource(untagResourceRequest);
System.out.println("Tags have been removed from the resource.");
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ Para obter detalhes da API, consulte [UntagResource](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/UntagResource)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { UntagResourceCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} resourceArn - The Amazon Resource Name (ARN) for the data store or image set.
* @param {string[]} tagKeys - The keys of the tags to remove.
*/
export const untagResource = async (
resourceArn = "arn:aws:medical-imaging:us-east-1:xxxxxx:datastore/xxxxx/imageset/xxx",
tagKeys = [],
) => {
const response = await medicalImagingClient.send(
new UntagResourceCommand({ resourceArn: resourceArn, tagKeys: tagKeys }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 204,
// requestId: '8a6de9a3-ec8e-47ef-8643-473518b19d45',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// }
// }
return response;
};
```
+ Para obter detalhes da API, consulte [UntagResource](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/UntagResourceCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def untag_resource(self, resource_arn, tag_keys):
"""
Untag a resource.
:param resource_arn: The ARN of the resource.
:param tag_keys: The tag keys to remove.
"""
try:
self.health_imaging_client.untag_resource(
resourceArn=resource_arn, tagKeys=tag_keys
)
except ClientError as err:
logger.error(
"Couldn't untag resource. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
+ Para obter detalhes da API, consulte a [UntagResource](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/UntagResource)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_resource_arn = 'arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012'
lo_mig->untagresource(
iv_resourcearn = iv_resource_arn
it_tagkeys = it_tag_keys ).
MESSAGE 'Resource untagged successfully.' 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 'Resource not found.' TYPE 'I'.
CATCH /aws1/cx_migthrottlingex.
MESSAGE 'Request throttled.' TYPE 'I'.
CATCH /aws1/cx_migvalidationex.
MESSAGE 'Validation error.' TYPE 'I'.
ENDTRY.
```
+ Para obter detalhes da API, consulte a [UntagResource](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `UpdateImageSetMetadata` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `UpdateImageSetMetadata`.
------
#### [ CLI ]
**AWS CLI**
**Exemplo 1: inserir ou atualizar um atributo nos metadados do conjunto de imagens**
O exemplo `update-image-set-metadata` a seguir insere ou atualiza um atributo nos metadados do conjunto de imagens.
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--update-image-set-metadata-updates file://metadata-updates.json
```
Conteúdo de `metadata-updates.json`
```
{
"DICOMUpdates": {
"updatableAttributes": "{\"SchemaVersion\":1.1,\"Patient\":{\"DICOM\":{\"PatientName\":\"MX^MX\"}}}"
}
}
```
Saída:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
**Exemplo 2: remover um atributo dos metadados do conjunto de imagens**
O exemplo `update-image-set-metadata` a seguir remove um atributo dos metadados do conjunto de imagens.
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--update-image-set-metadata-updates file://metadata-updates.json
```
Conteúdo de `metadata-updates.json`
```
{
"DICOMUpdates": {
"removableAttributes": "{\"SchemaVersion\":1.1,\"Study\":{\"DICOM\":{\"StudyDescription\":\"CHEST\"}}}"
}
}
```
Saída:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
**Exemplo 3: remover uma instância dos metadados de um conjunto de imagens**
O exemplo `update-image-set-metadata` a seguir remove uma instância dos metadados de um conjunto de imagens.
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--update-image-set-metadata-updates file://metadata-updates.json \
--force
```
Conteúdo de `metadata-updates.json`
```
{
"DICOMUpdates": {
"removableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {}}}}}}"
}
}
```
Saída:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
**Exemplo 4: reverter um conjunto de imagens para uma versão anterior**
O `update-image-set-metadata` exemplo a seguir mostra como reverter um conjunto de imagens para uma versão anterior. CopyImageSet e UpdateImageSetMetadata as ações criam novas versões dos conjuntos de imagens.
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
--latest-version-id 3 \
--cli-binary-format raw-in-base64-out \
--update-image-set-metadata-updates '{"revertToVersionId": "1"}'
```
Saída:
```
{
"datastoreId": "12345678901234567890123456789012",
"imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
"latestVersionId": "4",
"imageSetState": "LOCKED",
"imageSetWorkflowStatus": "UPDATING",
"createdAt": 1680027126.436,
"updatedAt": 1680042257.908
}
```
**Exemplo 5: adicionar um elemento de dados DICOM privado a uma instância**
O exemplo `update-image-set-metadata` a seguir mostra como adicionar um elemento privado a uma instância especificada em um conjunto de imagens. O padrão DICOM permite elementos de dados privados para comunicação de informações que não podem estar contidas em elementos de dados padrão. Você pode criar, atualizar e excluir elementos de dados privados com a UpdateImageSetMetadata ação.
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--force \
--update-image-set-metadata-updates file://metadata-updates.json
```
Conteúdo de `metadata-updates.json`
```
{
"DICOMUpdates": {
"updatableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"DICOM\": {\"001910F9\": \"97\"},\"DICOMVRs\": {\"001910F9\": \"DS\"}}}}}}}"
}
}
```
Saída:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
**Exemplo 6: atualizar um elemento de dados DICOM privado a uma instância**
O exemplo `update-image-set-metadata` a seguir mostra como atualizar o valor de um elemento privado que pertence a uma instância em um conjunto de imagens.
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--force \
--update-image-set-metadata-updates file://metadata-updates.json
```
Conteúdo de `metadata-updates.json`
```
{
"DICOMUpdates": {
"updatableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"DICOM\": {\"00091001\": \"GE_GENESIS_DD\"}}}}}}}"
}
}
```
Saída:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
**Exemplo 7: Para atualizar um SOPInstance UID com o parâmetro force**
O `update-image-set-metadata` exemplo a seguir mostra como atualizar um SOPInstance UID usando o parâmetro force para substituir as restrições de metadados DICOM.
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--force \
--update-image-set-metadata-updates file://metadata-updates.json
```
Conteúdo de `metadata-updates.json`
```
{
"DICOMUpdates": {
"updatableAttributes": "{\"SchemaVersion\":1.1,\"Study\":{\"Series\":{\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3656.0\":{\"Instances\":{\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3659.0\":{\"DICOM\":{\"SOPInstanceUID\":\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3659.9\"}}}}}}}"
}
}
```
Saída:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
Para obter mais informações, consulte [Atualização dos metadados do conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/update-image-set-metadata.html) no *Guia do AWS HealthImaging desenvolvedor*.
+ Para obter detalhes da API, consulte [UpdateImageSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/update-image-set-metadata.html)em *Referência de AWS CLI Comandos*.
------
#### [ Java ]
**SDK para Java 2.x**
```
/**
* Update the metadata of an AWS HealthImaging image set.
*
* @param medicalImagingClient - The AWS HealthImaging client object.
* @param datastoreId - The datastore ID.
* @param imageSetId - The image set ID.
* @param versionId - The version ID.
* @param metadataUpdates - A MetadataUpdates object containing the updates.
* @param force - The force flag.
* @throws MedicalImagingException - Base exception for all service exceptions thrown by AWS HealthImaging.
*/
public static void updateMedicalImageSetMetadata(MedicalImagingClient medicalImagingClient,
String datastoreId,
String imageSetId,
String versionId,
MetadataUpdates metadataUpdates,
boolean force) {
try {
UpdateImageSetMetadataRequest updateImageSetMetadataRequest = UpdateImageSetMetadataRequest
.builder()
.datastoreId(datastoreId)
.imageSetId(imageSetId)
.latestVersionId(versionId)
.updateImageSetMetadataUpdates(metadataUpdates)
.force(force)
.build();
UpdateImageSetMetadataResponse response = medicalImagingClient.updateImageSetMetadata(updateImageSetMetadataRequest);
System.out.println("The image set metadata was updated" + response);
} catch (MedicalImagingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
throw e;
}
}
```
Caso de uso 1: insira ou atualize um atributo.
```
final String insertAttributes = """
{
"SchemaVersion": 1.1,
"Study": {
"DICOM": {
"StudyDescription": "CT CHEST"
}
}
}
""";
MetadataUpdates metadataInsertUpdates = MetadataUpdates.builder()
.dicomUpdates(DICOMUpdates.builder()
.updatableAttributes(SdkBytes.fromByteBuffer(
ByteBuffer.wrap(insertAttributes
.getBytes(StandardCharsets.UTF_8))))
.build())
.build();
updateMedicalImageSetMetadata(medicalImagingClient, datastoreId, imagesetId,
versionid, metadataInsertUpdates, force);
```
Caso de uso 2: remova um atributo.
```
final String removeAttributes = """
{
"SchemaVersion": 1.1,
"Study": {
"DICOM": {
"StudyDescription": "CT CHEST"
}
}
}
""";
MetadataUpdates metadataRemoveUpdates = MetadataUpdates.builder()
.dicomUpdates(DICOMUpdates.builder()
.removableAttributes(SdkBytes.fromByteBuffer(
ByteBuffer.wrap(removeAttributes
.getBytes(StandardCharsets.UTF_8))))
.build())
.build();
updateMedicalImageSetMetadata(medicalImagingClient, datastoreId, imagesetId,
versionid, metadataRemoveUpdates, force);
```
Caso de uso 3: remova uma instância.
```
final String removeInstance = """
{
"SchemaVersion": 1.1,
"Study": {
"Series": {
"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1": {
"Instances": {
"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1": {}
}
}
}
}
}
""";
MetadataUpdates metadataRemoveUpdates = MetadataUpdates.builder()
.dicomUpdates(DICOMUpdates.builder()
.removableAttributes(SdkBytes.fromByteBuffer(
ByteBuffer.wrap(removeInstance
.getBytes(StandardCharsets.UTF_8))))
.build())
.build();
updateMedicalImageSetMetadata(medicalImagingClient, datastoreId, imagesetId,
versionid, metadataRemoveUpdates, force);
```
Caso de uso 4: reverta para uma versão anterior.
```
// In this case, revert to previous version.
String revertVersionId = Integer.toString(Integer.parseInt(versionid) - 1);
MetadataUpdates metadataRemoveUpdates = MetadataUpdates.builder()
.revertToVersionId(revertVersionId)
.build();
updateMedicalImageSetMetadata(medicalImagingClient, datastoreId, imagesetId,
versionid, metadataRemoveUpdates, force);
```
+ Para obter detalhes da API, consulte [UpdateImageSetMetadata](https://docs.aws.amazon.com/goto/SdkForJavaV2/medical-imaging-2023-07-19/UpdateImageSetMetadata)a *Referência AWS SDK for Java 2.x da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/medicalimaging#code-examples).
------
#### [ JavaScript ]
**SDK para JavaScript (v3)**
```
import { UpdateImageSetMetadataCommand } from "@aws-sdk/client-medical-imaging";
import { medicalImagingClient } from "../libs/medicalImagingClient.js";
/**
* @param {string} datastoreId - The ID of the HealthImaging data store.
* @param {string} imageSetId - The ID of the HealthImaging image set.
* @param {string} latestVersionId - The ID of the HealthImaging image set version.
* @param {{}} updateMetadata - The metadata to update.
* @param {boolean} force - Force the update.
*/
export const updateImageSetMetadata = async (
datastoreId = "xxxxxxxxxx",
imageSetId = "xxxxxxxxxx",
latestVersionId = "1",
updateMetadata = "{}",
force = false,
) => {
try {
const response = await medicalImagingClient.send(
new UpdateImageSetMetadataCommand({
datastoreId: datastoreId,
imageSetId: imageSetId,
latestVersionId: latestVersionId,
updateImageSetMetadataUpdates: updateMetadata,
force: force,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '7966e869-e311-4bff-92ec-56a61d3003ea',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// createdAt: 2023-09-22T14:49:26.427Z,
// datastoreId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
// imageSetId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
// imageSetState: 'LOCKED',
// imageSetWorkflowStatus: 'UPDATING',
// latestVersionId: '4',
// updatedAt: 2023-09-27T19:41:43.494Z
// }
return response;
} catch (err) {
console.error(err);
}
};
```
Caso de uso 1: insira ou atualize um atributo e force a atualização.
```
const insertAttributes = JSON.stringify({
SchemaVersion: 1.1,
Study: {
DICOM: {
StudyDescription: "CT CHEST",
},
},
});
const updateMetadata = {
DICOMUpdates: {
updatableAttributes: new TextEncoder().encode(insertAttributes),
},
};
await updateImageSetMetadata(
datastoreID,
imageSetID,
versionID,
updateMetadata,
true,
);
```
Caso de uso 2: remova um atributo.
```
// Attribute key and value must match the existing attribute.
const remove_attribute = JSON.stringify({
SchemaVersion: 1.1,
Study: {
DICOM: {
StudyDescription: "CT CHEST",
},
},
});
const updateMetadata = {
DICOMUpdates: {
removableAttributes: new TextEncoder().encode(remove_attribute),
},
};
await updateImageSetMetadata(
datastoreID,
imageSetID,
versionID,
updateMetadata,
);
```
Caso de uso 3: remova uma instância.
```
const remove_instance = JSON.stringify({
SchemaVersion: 1.1,
Study: {
Series: {
"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1": {
Instances: {
"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1": {},
},
},
},
},
});
const updateMetadata = {
DICOMUpdates: {
removableAttributes: new TextEncoder().encode(remove_instance),
},
};
await updateImageSetMetadata(
datastoreID,
imageSetID,
versionID,
updateMetadata,
);
```
Caso de uso 4: reverta para uma versão anterior.
```
const updateMetadata = {
revertToVersionId: "1",
};
await updateImageSetMetadata(
datastoreID,
imageSetID,
versionID,
updateMetadata,
);
```
+ Para obter detalhes da API, consulte [UpdateImageSetMetadata](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/medical-imaging/command/UpdateImageSetMetadataCommand)a *Referência AWS SDK para JavaScript da API*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/medical-imaging#code-examples).
------
#### [ Python ]
**SDK para Python (Boto3)**
```
class MedicalImagingWrapper:
def __init__(self, health_imaging_client):
self.health_imaging_client = health_imaging_client
def update_image_set_metadata(
self, datastore_id, image_set_id, version_id, metadata, force=False
):
"""
Update the metadata of an image set.
:param datastore_id: The ID of the data store.
:param image_set_id: The ID of the image set.
:param version_id: The ID of the image set version.
:param metadata: The image set metadata as a dictionary.
For example {"DICOMUpdates": {"updatableAttributes":
"{\"SchemaVersion\":1.1,\"Patient\":{\"DICOM\":{\"PatientName\":\"Garcia^Gloria\"}}}"}}
:param: force: Force the update.
:return: The updated image set metadata.
"""
try:
updated_metadata = self.health_imaging_client.update_image_set_metadata(
imageSetId=image_set_id,
datastoreId=datastore_id,
latestVersionId=version_id,
updateImageSetMetadataUpdates=metadata,
force=force,
)
except ClientError as err:
logger.error(
"Couldn't update image set metadata. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return updated_metadata
```
O código a seguir instancia o MedicalImagingWrapper objeto.
```
client = boto3.client("medical-imaging")
medical_imaging_wrapper = MedicalImagingWrapper(client)
```
Caso de uso 1: insira ou atualize um atributo.
```
attributes = """{
"SchemaVersion": 1.1,
"Study": {
"DICOM": {
"StudyDescription": "CT CHEST"
}
}
}"""
metadata = {"DICOMUpdates": {"updatableAttributes": attributes}}
self.update_image_set_metadata(
data_store_id, image_set_id, version_id, metadata, force
)
```
Caso de uso 2: remova um atributo.
```
# Attribute key and value must match the existing attribute.
attributes = """{
"SchemaVersion": 1.1,
"Study": {
"DICOM": {
"StudyDescription": "CT CHEST"
}
}
}"""
metadata = {"DICOMUpdates": {"removableAttributes": attributes}}
self.update_image_set_metadata(
data_store_id, image_set_id, version_id, metadata, force
)
```
Caso de uso 3: remova uma instância.
```
attributes = """{
"SchemaVersion": 1.1,
"Study": {
"Series": {
"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1": {
"Instances": {
"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1": {}
}
}
}
}
}"""
metadata = {"DICOMUpdates": {"removableAttributes": attributes}}
self.update_image_set_metadata(
data_store_id, image_set_id, version_id, metadata, force
)
```
Caso de uso 4: reverta para uma versão anterior.
```
metadata = {"revertToVersionId": "1"}
self.update_image_set_metadata(
data_store_id, image_set_id, version_id, metadata, force
)
```
+ Para obter detalhes da API, consulte a [UpdateImageSetMetadata](https://docs.aws.amazon.com/goto/boto3/medical-imaging-2023-07-19/UpdateImageSetMetadata)Referência da API *AWS SDK for Python (Boto3*).
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/medical-imaging#code-examples).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
```
TRY.
" iv_datastore_id = '1234567890123456789012345678901234567890'
" iv_image_set_id = '1234567890123456789012345678901234567890'
" iv_latest_version_id = '1'
" iv_force = abap_false
oo_result = lo_mig->updateimagesetmetadata(
iv_datastoreid = iv_datastore_id
iv_imagesetid = iv_image_set_id
iv_latestversionid = iv_latest_version_id
io_updateimagesetmetupdates = io_metadata_updates
iv_force = iv_force ).
DATA(lv_new_version) = oo_result->get_latestversionid( ).
MESSAGE |Image set metadata updated to version: { lv_new_version }.| TYPE 'I'.
CATCH /aws1/cx_migaccessdeniedex.
MESSAGE 'Access denied.' TYPE 'I'.
CATCH /aws1/cx_migconflictexception.
MESSAGE 'Conflict error.' TYPE 'I'.
CATCH /aws1/cx_miginternalserverex.
MESSAGE 'Internal server error.' TYPE 'I'.
CATCH /aws1/cx_migresourcenotfoundex.
MESSAGE 'Image set not found.' 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.
```
+ Para obter detalhes da API, consulte a [UpdateImageSetMetadata](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/mig#code-examples).
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando esse serviço com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.]