:doc:`ResilienceHub <../../resiliencehub>` / Client / start_metrics_export

********************
start_metrics_export
********************



.. py:method:: ResilienceHub.Client.start_metrics_export(**kwargs)

  

  Initiates the export task of metrics.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/StartMetricsExport>`_  


  **Request Syntax**
  ::

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

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

    

  
  :type clientToken: string
  :param clientToken: 

    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.

  
  
  :rtype: 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**
  
  *   :py:class:`ResilienceHub.Client.exceptions.InternalServerException`

  
  *   :py:class:`ResilienceHub.Client.exceptions.ConflictException`

  
  *   :py:class:`ResilienceHub.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`ResilienceHub.Client.exceptions.ThrottlingException`

  
  *   :py:class:`ResilienceHub.Client.exceptions.ValidationException`

  
  *   :py:class:`ResilienceHub.Client.exceptions.AccessDeniedException`

  