Skip to content

describe_backup async

describe_backup(
    backup_arn: BackupArn,
    *,
    config_overrides: Optional[AsyncDynamoDBClientConfig] = None,
) -> DescribeBackupOutput

Describes an existing backup of a table.

You can call DescribeBackup at a maximum rate of 10 times per second.

Parameters:

  • backup_arn (BackupArn) –

    The Amazon Resource Name (ARN) associated with the backup.

Raises:

Source code in docs_src/capo_dynamodb/_services/async_dynamo_db.py
async def describe_backup(
    self,
    backup_arn: "capo_dynamodb.types.backup_arn.BackupArn",
    *,
    config_overrides: Optional[AsyncDynamoDBClientConfig] = None,
) -> "capo_dynamodb.types.describe_backup_output.DescribeBackupOutput":
    """<p>Describes an existing backup of a table.</p> <p>You can call <code>DescribeBackup</code> at a maximum rate of 10 times per second.</p>

    Args:
        backup_arn: <p>The Amazon Resource Name (ARN) associated with the backup.</p>

    Raises:
        capo_dynamodb.errors.backup_not_found_exception.BackupNotFoundException: <p>Backup not found for the given BackupARN. </p>
        capo_dynamodb.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_dynamodb.errors.invalid_endpoint_exception.InvalidEndpointException
        capo_dynamodb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_dynamodb.types.describe_backup_input.DescribeBackupInput]",
    ) -> AsyncOperationResponse[
        "capo_dynamodb.types.describe_backup_output.DescribeBackupOutput"
    ]:
        import capo_dynamodb._operations.dynamo_db_20120810.describe_backup

        (
            output,
            http_response,
        ) = await capo_dynamodb._operations.dynamo_db_20120810.describe_backup.async_describe_backup(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeBackup")
    )
    input_: capo_dynamodb.types.describe_backup_input.DescribeBackupInput = {
        "backup_arn": backup_arn
    }

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