ResilienceHub / Client / start_metrics_export

start_metrics_export#

ResilienceHub.Client.start_metrics_export(**kwargs)#

Initiates the export task of metrics.

See also: AWS API Documentation

Request Syntax

response = client.start_metrics_export(
    bucketName='string',
    clientToken='string'
)
Parameters:

  • bucketName (string) – (Optional) Specifies the name of the Amazon Simple Storage Service bucket where the exported metrics will be stored.

  • clientToken (string) –

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'metricsExportId': 'string',
    'status': 'Pending'|'InProgress'|'Failed'|'Success'
}

Response Structure

  • (dict) –

    • metricsExportId (string) –

      Identifier of the metrics export task.

    • status (string) –

      Indicates the status of the metrics export task.

Exceptions