:doc:`Artifact <../../artifact>` / Client / get_report_metadata

*******************
get_report_metadata
*******************



.. py:method:: Artifact.Client.get_report_metadata(**kwargs)

  

  Get the metadata for a single report.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/artifact-2018-05-10/GetReportMetadata>`_  


  **Request Syntax**
  ::

    response = client.get_report_metadata(
        reportId='string',
        reportVersion=123
    )
    
  :type reportId: string
  :param reportId: **[REQUIRED]** 

    Unique resource ID for the report resource.

    

  
  :type reportVersion: integer
  :param reportVersion: 

    Version for the report resource.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'reportDetails': {
              'id': 'string',
              'name': 'string',
              'description': 'string',
              'periodStart': datetime(2015, 1, 1),
              'periodEnd': datetime(2015, 1, 1),
              'createdAt': datetime(2015, 1, 1),
              'lastModifiedAt': datetime(2015, 1, 1),
              'deletedAt': datetime(2015, 1, 1),
              'state': 'PUBLISHED'|'UNPUBLISHED',
              'arn': 'string',
              'series': 'string',
              'category': 'string',
              'companyName': 'string',
              'productName': 'string',
              'termArn': 'string',
              'version': 123,
              'acceptanceType': 'PASSTHROUGH'|'EXPLICIT',
              'sequenceNumber': 123,
              'uploadState': 'PROCESSING'|'COMPLETE'|'FAILED'|'FAULT',
              'statusMessage': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **reportDetails** *(dict) --* 

        Report resource detail.

        
        

        - **id** *(string) --* 

          Unique resource ID for the report resource.

          
        

        - **name** *(string) --* 

          Name for the report resource.

          
        

        - **description** *(string) --* 

          Description for the report resource.

          
        

        - **periodStart** *(datetime) --* 

          Timestamp indicating the report resource effective start.

          
        

        - **periodEnd** *(datetime) --* 

          Timestamp indicating the report resource effective end.

          
        

        - **createdAt** *(datetime) --* 

          Timestamp indicating when the report resource was created.

          
        

        - **lastModifiedAt** *(datetime) --* 

          Timestamp indicating when the report resource was last modified.

          
        

        - **deletedAt** *(datetime) --* 

          Timestamp indicating when the report resource was deleted.

          
        

        - **state** *(string) --* 

          Current state of the report resource

          
        

        - **arn** *(string) --* 

          ARN for the report resource.

          
        

        - **series** *(string) --* 

          Series for the report resource.

          
        

        - **category** *(string) --* 

          Category for the report resource.

          
        

        - **companyName** *(string) --* 

          Associated company name for the report resource.

          
        

        - **productName** *(string) --* 

          Associated product name for the report resource.

          
        

        - **termArn** *(string) --* 

          Unique resource ARN for term resource.

          
        

        - **version** *(integer) --* 

          Version for the report resource.

          
        

        - **acceptanceType** *(string) --* 

          Acceptance type for report.

          
        

        - **sequenceNumber** *(integer) --* 

          Sequence number to enforce optimistic locking.

          
        

        - **uploadState** *(string) --* 

          The current state of the document upload.

          
        

        - **statusMessage** *(string) --* 

          The message associated with the current upload state.

          
    
  
  **Exceptions**
  
  *   :py:class:`Artifact.Client.exceptions.ResourceNotFoundException`

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

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

  
  *   :py:class:`Artifact.Client.exceptions.InternalServerException`

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

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

  