DescribeMetricsExportCommand

Suggest an Edit

Describes the metrics of the application configuration being exported.

Example Syntax

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

import { ResiliencehubClient, DescribeMetricsExportCommand } from "@aws-sdk/client-resiliencehub"; // ES Modules import
// const { ResiliencehubClient, DescribeMetricsExportCommand } = require("@aws-sdk/client-resiliencehub"); // CommonJS import
const client = new ResiliencehubClient(config);
const input = { // DescribeMetricsExportRequest
  metricsExportId: "STRING_VALUE", // required
};
const command = new DescribeMetricsExportCommand(input);
const response = await client.send(command);
// { // DescribeMetricsExportResponse
//   metricsExportId: "STRING_VALUE", // required
//   status: "Pending" || "InProgress" || "Failed" || "Success", // required
//   exportLocation: { // S3Location
//     bucket: "STRING_VALUE",
//     prefix: "STRING_VALUE",
//   },
//   errorMessage: "STRING_VALUE",
// };

DescribeMetricsExportCommand Input

See DescribeMetricsExportCommandInput for more details

Parameter
Type
Description
metricsExportId
Required
string | undefined

Identifier of the metrics export task.

DescribeMetricsExportCommand Output

See DescribeMetricsExportCommandOutput for details

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

Identifier for the metrics export task.

status
Required
MetricsExportStatusType | undefined

Indicates the status of the metrics export task.

errorMessage
string | undefined

Explains the error that occurred while exporting the metrics.

exportLocation
S3Location | undefined

Specifies the name of the Amazon S3 bucket where the exported metrics is stored.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

InternalServerException
server

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException
client

This exception occurs when the specified resource could not be found.

ThrottlingException
client

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException
client

This exception occurs when a request is not valid.

ResiliencehubServiceException
Base exception class for all service exceptions from Resiliencehub service.