:doc:`Backup <../../backup>` / Client / update_recovery_point_index_settings

************************************
update_recovery_point_index_settings
************************************



.. py:method:: Backup.Client.update_recovery_point_index_settings(**kwargs)

  

  This operation updates the settings of a recovery point index.

   

  Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRecoveryPointIndexSettings>`_  


  **Request Syntax**
  ::

    response = client.update_recovery_point_index_settings(
        BackupVaultName='string',
        RecoveryPointArn='string',
        IamRoleArn='string',
        Index='ENABLED'|'DISABLED'
    )
    
  :type BackupVaultName: string
  :param BackupVaultName: **[REQUIRED]** 

    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.

     

    Accepted characters include lowercase letters, numbers, and hyphens.

    

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

    An ARN that uniquely identifies a recovery point; for example, ``arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45``.

    

  
  :type IamRoleArn: string
  :param IamRoleArn: 

    This specifies the IAM role ARN used for this operation.

     

    For example, arn:aws:iam::123456789012:role/S3Access

    

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

    Index can have 1 of 2 possible values, either ``ENABLED`` or ``DISABLED``.

     

    To create a backup index for an eligible ``ACTIVE`` recovery point that does not yet have a backup index, set value to ``ENABLED``.

     

    To delete a backup index, set value to ``DISABLED``.

    

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

    
    ::

      {
          'BackupVaultName': 'string',
          'RecoveryPointArn': 'string',
          'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING',
          'Index': 'ENABLED'|'DISABLED'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **BackupVaultName** *(string) --* 

        The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.

        
      

      - **RecoveryPointArn** *(string) --* 

        An ARN that uniquely identifies a recovery point; for example, ``arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45``.

        
      

      - **IndexStatus** *(string) --* 

        This is the current status for the backup index associated with the specified recovery point.

         

        Statuses are: ``PENDING`` | ``ACTIVE`` | ``FAILED`` | ``DELETING``

         

        A recovery point with an index that has the status of ``ACTIVE`` can be included in a search.

        
      

      - **Index** *(string) --* 

        Index can have 1 of 2 possible values, either ``ENABLED`` or ``DISABLED``.

         

        A value of ``ENABLED`` means a backup index for an eligible ``ACTIVE`` recovery point has been created.

         

        A value of ``DISABLED`` means a backup index was deleted.

        
  
  **Exceptions**
  
  *   :py:class:`Backup.Client.exceptions.MissingParameterValueException`

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

  
  *   :py:class:`Backup.Client.exceptions.InvalidRequestException`

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

  
  *   :py:class:`Backup.Client.exceptions.ServiceUnavailableException`

  