DeleteImageSetCommand

Suggest an Edit

Delete an image set.

Example Syntax

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

import { MedicalImagingClient, DeleteImageSetCommand } from "@aws-sdk/client-medical-imaging"; // ES Modules import
// const { MedicalImagingClient, DeleteImageSetCommand } = require("@aws-sdk/client-medical-imaging"); // CommonJS import
const client = new MedicalImagingClient(config);
const input = { // DeleteImageSetRequest
  datastoreId: "STRING_VALUE", // required
  imageSetId: "STRING_VALUE", // required
};
const command = new DeleteImageSetCommand(input);
const response = await client.send(command);
// { // DeleteImageSetResponse
//   datastoreId: "STRING_VALUE", // required
//   imageSetId: "STRING_VALUE", // required
//   imageSetState: "ACTIVE" || "LOCKED" || "DELETED", // required
//   imageSetWorkflowStatus: "CREATED" || "COPIED" || "COPYING" || "COPYING_WITH_READ_ONLY_ACCESS" || "COPY_FAILED" || "UPDATING" || "UPDATED" || "UPDATE_FAILED" || "DELETING" || "DELETED", // required
// };

DeleteImageSetCommand Input

See DeleteImageSetCommandInput for more details

Parameter
Type
Description
datastoreId
Required
string | undefined

The data store identifier.

imageSetId
Required
string | undefined

The image set identifier.

DeleteImageSetCommand Output

See DeleteImageSetCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
datastoreId
Required
string | undefined

The data store identifier.

imageSetId
Required
string | undefined

The image set identifier.

imageSetState
Required
ImageSetState | undefined

The image set state.

imageSetWorkflowStatus
Required
ImageSetWorkflowStatus | undefined

The image set workflow status.

Throws

Name
Fault
Details
AccessDeniedException
client

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

ConflictException
client

Updating or deleting a resource can cause an inconsistent state.

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.