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

***********************
describe_metrics_export
***********************



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

  

  Describes the metrics of the application configuration being exported.

  

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


  **Request Syntax**
  ::

    response = client.describe_metrics_export(
        metricsExportId='string'
    )
    
  :type metricsExportId: string
  :param metricsExportId: **[REQUIRED]** 

    Identifier of the metrics export task.

    

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

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

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

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

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

  