GetDatastoreCommand

Get data store properties.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MedicalImagingClient, GetDatastoreCommand } from "@aws-sdk/client-medical-imaging"; // ES Modules import
// const { MedicalImagingClient, GetDatastoreCommand } = require("@aws-sdk/client-medical-imaging"); // CommonJS import
const client = new MedicalImagingClient(config);
const input = { // GetDatastoreRequest
  datastoreId: "STRING_VALUE", // required
};
const command = new GetDatastoreCommand(input);
const response = await client.send(command);
// { // GetDatastoreResponse
//   datastoreProperties: { // DatastoreProperties
//     datastoreId: "STRING_VALUE", // required
//     datastoreName: "STRING_VALUE", // required
//     datastoreStatus: "CREATING" || "CREATE_FAILED" || "ACTIVE" || "DELETING" || "DELETED", // required
//     kmsKeyArn: "STRING_VALUE",
//     datastoreArn: "STRING_VALUE",
//     createdAt: new Date("TIMESTAMP"),
//     updatedAt: new Date("TIMESTAMP"),
//   },
// };

GetDatastoreCommand Input

See GetDatastoreCommandInput for more details

Parameter
Type
Description
datastoreId
Required
string | undefined

The data store identifier.

GetDatastoreCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
datastoreProperties
Required
DatastoreProperties | undefined

The data store properties.

Throws

Name
Fault
Details
AccessDeniedException
client

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

InternalServerException
server

An unexpected error occurred during processing of the request.

ResourceNotFoundException
client

The request references a resource which does not exist.

ThrottlingException
client

The request was denied due to throttling.

ValidationException
client

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

MedicalImagingServiceException
Base exception class for all service exceptions from MedicalImaging service.