ResilienceHub / Client / describe_metrics_export

describe_metrics_export#

ResilienceHub.Client.describe_metrics_export(**kwargs)#

Describes the metrics of the application configuration being exported.

See also: AWS API Documentation

Request Syntax

response = client.describe_metrics_export(
    metricsExportId='string'
)
Parameters:

metricsExportId (string) –

[REQUIRED]

Identifier of the metrics export task.

Return type:

dict

Returns:

Response Syntax

{
    'errorMessage': 'string',
    'exportLocation': {
        'bucket': 'string',
        'prefix': 'string'
    },
    'metricsExportId': 'string',
    'status': 'Pending'|'InProgress'|'Failed'|'Success'
}

Response Structure

  • (dict) –

    • errorMessage (string) –

      Explains the error that occurred while exporting the metrics.

    • exportLocation (dict) –

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

      • bucket (string) –

        The name of the Amazon S3 bucket.

      • prefix (string) –

        The prefix for the Amazon S3 bucket.

    • metricsExportId (string) –

      Identifier for the metrics export task.

    • status (string) –

      Indicates the status of the metrics export task.

Exceptions