:doc:`KendraRanking <../../kendra-ranking>` / Client / describe_rescore_execution_plan

*******************************
describe_rescore_execution_plan
*******************************



.. py:method:: KendraRanking.Client.describe_rescore_execution_plan(**kwargs)

  

  Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the ``Rescore`` API.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan>`_  


  **Request Syntax**
  ::

    response = client.describe_rescore_execution_plan(
        Id='string'
    )
    
  :type Id: string
  :param Id: **[REQUIRED]** 

    The identifier of the rescore execution plan that you want to get information on.

    

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

    
    ::

      {
          'Id': 'string',
          'Arn': 'string',
          'Name': 'string',
          'Description': 'string',
          'CapacityUnits': {
              'RescoreCapacityUnits': 123
          },
          'CreatedAt': datetime(2015, 1, 1),
          'UpdatedAt': datetime(2015, 1, 1),
          'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
          'ErrorMessage': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Id** *(string) --* 

        The identifier of the rescore execution plan.

        
      

      - **Arn** *(string) --* 

        The Amazon Resource Name (ARN) of the rescore execution plan.

        
      

      - **Name** *(string) --* 

        The name for the rescore execution plan.

        
      

      - **Description** *(string) --* 

        The description for the rescore execution plan.

        
      

      - **CapacityUnits** *(dict) --* 

        The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution plan is using the default capacity. For more information on the default capacity and additional capacity units, see `Adjusting capacity <https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html>`__.

        
        

        - **RescoreCapacityUnits** *(integer) --* 

          The amount of extra capacity for your rescore execution plan.

           

          A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.

          
    
      

      - **CreatedAt** *(datetime) --* 

        The Unix timestamp of when the rescore execution plan was created.

        
      

      - **UpdatedAt** *(datetime) --* 

        The Unix timestamp of when the rescore execution plan was last updated.

        
      

      - **Status** *(string) --* 

        The current status of the rescore execution plan. When the value is ``ACTIVE``, the rescore execution plan is ready for use. If the ``Status`` field value is ``FAILED``, the ``ErrorMessage`` field contains a message that explains why.

        
      

      - **ErrorMessage** *(string) --* 

        When the ``Status`` field value is ``FAILED``, the ``ErrorMessage`` field contains a message that explains why.

        
  
  **Exceptions**
  
  *   :py:class:`KendraRanking.Client.exceptions.ValidationException`

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

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

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

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

  