Skip to content

create_autonomous_database_backup async

create_autonomous_database_backup(
    autonomous_database_id: ResourceIdOrArn,
    *,
    config_overrides: Optional[AsyncodbClientConfig] = None,
    display_name: Optional[ResourceDisplayName] = None,
    retention_period_in_days: Optional[int] = None,
    client_token: Optional[GeneralInputString] = None,
    tags: Optional[RequestTagMap] = None,
) -> CreateAutonomousDatabaseBackupOutput

Creates a new backup of the specified Autonomous Database.

Parameters:

  • autonomous_database_id (ResourceIdOrArn) –

    The unique identifier of the Autonomous Database to back up.

  • display_name (Optional[ResourceDisplayName], default: None ) –

    The user-friendly name for the Autonomous Database backup.

  • retention_period_in_days (Optional[int], default: None ) –

    The retention period, in days, for the Autonomous Database backup.

  • client_token (Optional[GeneralInputString], default: None ) –

    A client-provided token to ensure the idempotency of the request.

  • tags (Optional[RequestTagMap], default: None ) –

    The list of resource tags to apply to the Autonomous Database backup. Each tag is a key-value pair with no predefined name, type, or namespace.

Raises:

  • AccessDeniedException –

    You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

  • ConflictException –

    Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

  • InternalServerException –

    Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

  • ResourceNotFoundException –

    The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

  • ServiceQuotaExceededException –

    You have exceeded the service quota.

  • ThrottlingException –

    The request was denied due to request throttling.

  • ValidationException –

    The request has failed validation because it is missing required fields or has invalid inputs.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_odb/_services/async_odb.py
async def create_autonomous_database_backup(
    self,
    autonomous_database_id: "capo_odb.types.resource_id_or_arn.ResourceIdOrArn",
    *,
    config_overrides: Optional[AsyncodbClientConfig] = None,
    display_name: Optional[
        "capo_odb.types.resource_display_name.ResourceDisplayName"
    ] = None,
    retention_period_in_days: Optional[int] = None,
    client_token: Optional[
        "capo_odb.types.general_input_string.GeneralInputString"
    ] = None,
    tags: Optional["capo_odb.types.request_tag_map.RequestTagMap"] = None,
) -> "capo_odb.types.create_autonomous_database_backup_output.CreateAutonomousDatabaseBackupOutput":
    """<p>Creates a new backup of the specified Autonomous Database.</p>

    Args:
        autonomous_database_id: <p>The unique identifier of the Autonomous Database to back up.</p>
        display_name: <p>The user-friendly name for the Autonomous Database backup.</p>
        retention_period_in_days: <p>The retention period, in days, for the Autonomous Database backup.</p>
        client_token: <p>A client-provided token to ensure the idempotency of the request.</p>
        tags: <p>The list of resource tags to apply to the Autonomous Database backup. Each tag is a key-value pair with no predefined name, type, or namespace.</p>

    Raises:
        capo_odb.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.</p>
        capo_odb.errors.conflict_exception.ConflictException: <p>Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.</p>
        capo_odb.errors.internal_server_exception.InternalServerException: <p>Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.</p>
        capo_odb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.</p>
        capo_odb.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have exceeded the service quota.</p>
        capo_odb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_odb.errors.validation_exception.ValidationException: <p>The request has failed validation because it is missing required fields or has invalid inputs.</p>
        capo_odb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_odb.types.create_autonomous_database_backup_input.CreateAutonomousDatabaseBackupInput]",
    ) -> AsyncOperationResponse[
        "capo_odb.types.create_autonomous_database_backup_output.CreateAutonomousDatabaseBackupOutput"
    ]:
        import capo_odb._operations.odb.create_autonomous_database_backup

        (
            output,
            http_response,
        ) = await capo_odb._operations.odb.create_autonomous_database_backup.async_create_autonomous_database_backup(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateAutonomousDatabaseBackup")
    )
    input_: capo_odb.types.create_autonomous_database_backup_input.CreateAutonomousDatabaseBackupInput = {
        "autonomous_database_id": autonomous_database_id
    }
    if display_name is not None:
        input_["display_name"] = display_name
    if retention_period_in_days is not None:
        input_["retention_period_in_days"] = retention_period_in_days
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output