Backup / Client / update_recovery_point_index_settings

update_recovery_point_index_settings#

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

Request Syntax

response = client.update_recovery_point_index_settings(
    BackupVaultName='string',
    RecoveryPointArn='string',
    IamRoleArn='string',
    Index='ENABLED'|'DISABLED'
)
Parameters:

  • BackupVaultName (string) –

    [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.

  • RecoveryPointArn (string) –

    [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.

  • IamRoleArn (string) –

    This specifies the IAM role ARN used for this operation.

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

  • Index (string) –

    [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.

Return type:

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

  • Backup.Client.exceptions.MissingParameterValueException

  • Backup.Client.exceptions.InvalidParameterValueException

  • Backup.Client.exceptions.InvalidRequestException

  • Backup.Client.exceptions.ResourceNotFoundException

  • Backup.Client.exceptions.ServiceUnavailableException