:doc:`QuickSight <../../quicksight>` / Client / describe_topic_refresh

**********************
describe_topic_refresh
**********************



.. py:method:: QuickSight.Client.describe_topic_refresh(**kwargs)

  

  Describes the status of a topic refresh.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefresh>`_  


  **Request Syntax**
  ::

    response = client.describe_topic_refresh(
        AwsAccountId='string',
        TopicId='string',
        RefreshId='string'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.

    

  
  :type TopicId: string
  :param TopicId: **[REQUIRED]** 

    The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

    

  
  :type RefreshId: string
  :param RefreshId: **[REQUIRED]** 

    The ID of the refresh, which is performed when the topic is created or updated.

    

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

    
    ::

      {
          'RefreshDetails': {
              'RefreshArn': 'string',
              'RefreshId': 'string',
              'RefreshStatus': 'INITIALIZED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED'
          },
          'RequestId': 'string',
          'Status': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RefreshDetails** *(dict) --* 

        Details of the refresh, which is performed when the topic is created or updated.

        
        

        - **RefreshArn** *(string) --* 

          The Amazon Resource Name (ARN) of the topic refresh.

          
        

        - **RefreshId** *(string) --* 

          The ID of the refresh, which occurs as a result of topic creation or topic update.

          
        

        - **RefreshStatus** *(string) --* 

          The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

          
    
      

      - **RequestId** *(string) --* 

        The Amazon Web Services request ID for this operation.

        
      

      - **Status** *(integer) --* 

        The HTTP status of the request.

        
  
  **Exceptions**
  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

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

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

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  