update_recovery_point_index_settings ¶

def update_recovery_point_index_settings(
    self,
    backup_vault_name: "capo_backup.types.backup_vault_name.BackupVaultName",
    recovery_point_arn: "capo_backup.types.arn.ARN",
    index: "capo_backup.types.index.Index",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    iam_role_arn: Optional["capo_backup.types.iam_role_arn.IAMRoleArn"] = None,
) -> "capo_backup.types.update_recovery_point_index_settings_output.UpdateRecoveryPointIndexSettingsOutput":
    """<p>This operation updates the settings of a recovery point index.</p> <p>Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn</p>

    Args:
        backup_vault_name: <p>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.</p> <p>Accepted characters include lowercase letters, numbers, and hyphens.</p>
        recovery_point_arn: <p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
        iam_role_arn: <p>This specifies the IAM role ARN used for this operation.</p> <p>For example, arn:aws:iam::123456789012:role/S3Access</p>
        index: <p>Index can have 1 of 2 possible values, either <code>ENABLED</code> or <code>DISABLED</code>.</p> <p>To create a backup index for an eligible <code>ACTIVE</code> recovery point that does not yet have a backup index, set value to <code>ENABLED</code>.</p> <p>To delete a backup index, set value to <code>DISABLED</code>.</p>

    Raises:
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.</p>
        capo_backup.errors.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</p>
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup.types.update_recovery_point_index_settings_input.UpdateRecoveryPointIndexSettingsInput]",
    ) -> OperationResponse[
        "capo_backup.types.update_recovery_point_index_settings_output.UpdateRecoveryPointIndexSettingsOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.update_recovery_point_index_settings

        output, http_response = (
            capo_backup._operations.cryo_controller_user_manager.update_recovery_point_index_settings.update_recovery_point_index_settings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRecoveryPointIndexSettings")
    )
    input_: capo_backup.types.update_recovery_point_index_settings_input.UpdateRecoveryPointIndexSettingsInput = {
        "backup_vault_name": backup_vault_name,
        "recovery_point_arn": recovery_point_arn,
        "index": index,
    }
    if iam_role_arn is not None:
        input_["iam_role_arn"] = iam_role_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output