Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

DescribeMetricsExport

Describes the metrics of the application configuration being exported.

Request Syntax


POST /describe-metrics-export HTTP/1.1
Content-type: application/json

{
   "metricsExportId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

metricsExportId

Identifier of the metrics export task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "errorMessage": "string",
   "exportLocation": { 
      "bucket": "string",
      "prefix": "string"
   },
   "metricsExportId": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

errorMessage

Explains the error that occurred while exporting the metrics.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

exportLocation

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

Type: S3Location object

metricsExportId

Identifier for the metrics export task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

status

Indicates the status of the metrics export task.

Type: String

Valid Values: Pending | InProgress | Failed | Success

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

This exception occurs when a request is not valid.

HTTP Status Code: 400

Examples

Sample Request

The following is an example request payload.

Sample Request


{
  "metricsExportId": "fe0e1e00-03eb-11ee-8796-02038f8a9691"
}

Sample Response

The following is an example response payload.

Sample Response


{
  "metricsExportId": "fe0e1e00-03eb-11ee-8796-02038f8a9691",
  "status": "Success",
  "exportLocation": {
    "bucket": "my-bucket-name",
    "prefix": "resiliencehub-metrics/2024-11-14/fe0e1e00-03eb-11ee-8796-02038f8a9691"
  }
}