BackupStorageClient#
Index > BackupStorage > BackupStorageClient
Auto-generated documentation for BackupStorage type annotations stubs module mypy-boto3-backupstorage.
BackupStorageClient#
Type annotations and code completion for boto3.client("backupstorage")
.
boto3 documentation
# BackupStorageClient usage example
from boto3.session import Session
from mypy_boto3_backupstorage.client import BackupStorageClient
def get_backupstorage_client() -> BackupStorageClient:
return Session().client("backupstorage")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("backupstorage").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("backupstorage")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.DataAlreadyExistsException,
client.exceptions.IllegalArgumentException,
client.exceptions.KMSInvalidKeyUsageException,
client.exceptions.NotReadableInputStreamException,
client.exceptions.ResourceNotFoundException,
client.exceptions.RetryableException,
client.exceptions.ServiceInternalException,
client.exceptions.ServiceUnavailableException,
client.exceptions.ThrottlingException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_backupstorage.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("backupstorage").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("backupstorage").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
delete_object#
Delete Object from the incremental base Backup.
Type annotations and code completion for boto3.client("backupstorage").delete_object
method.
boto3 documentation
# delete_object method definition
def delete_object(
self,
*,
BackupJobId: str,
ObjectName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_object method usage example with argument unpacking
kwargs: DeleteObjectInputRequestTypeDef = { # (1)
"BackupJobId": ...,
"ObjectName": ...,
}
parent.delete_object(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("backupstorage").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_chunk#
Gets the specified object's chunk.
Type annotations and code completion for boto3.client("backupstorage").get_chunk
method.
boto3 documentation
# get_chunk method definition
def get_chunk(
self,
*,
StorageJobId: str,
ChunkToken: str,
) -> GetChunkOutputTypeDef: # (1)
...
# get_chunk method usage example with argument unpacking
kwargs: GetChunkInputRequestTypeDef = { # (1)
"StorageJobId": ...,
"ChunkToken": ...,
}
parent.get_chunk(**kwargs)
get_object_metadata#
Get metadata associated with an Object.
Type annotations and code completion for boto3.client("backupstorage").get_object_metadata
method.
boto3 documentation
# get_object_metadata method definition
def get_object_metadata(
self,
*,
StorageJobId: str,
ObjectToken: str,
) -> GetObjectMetadataOutputTypeDef: # (1)
...
# get_object_metadata method usage example with argument unpacking
kwargs: GetObjectMetadataInputRequestTypeDef = { # (1)
"StorageJobId": ...,
"ObjectToken": ...,
}
parent.get_object_metadata(**kwargs)
list_chunks#
List chunks in a given Object See also: AWS API Documentation.
Type annotations and code completion for boto3.client("backupstorage").list_chunks
method.
boto3 documentation
# list_chunks method definition
def list_chunks(
self,
*,
StorageJobId: str,
ObjectToken: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListChunksOutputTypeDef: # (1)
...
# list_chunks method usage example with argument unpacking
kwargs: ListChunksInputRequestTypeDef = { # (1)
"StorageJobId": ...,
"ObjectToken": ...,
}
parent.list_chunks(**kwargs)
list_objects#
List all Objects in a given Backup.
Type annotations and code completion for boto3.client("backupstorage").list_objects
method.
boto3 documentation
# list_objects method definition
def list_objects(
self,
*,
StorageJobId: str,
StartingObjectName: str = ...,
StartingObjectPrefix: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
CreatedBefore: Union[datetime, str] = ...,
CreatedAfter: Union[datetime, str] = ...,
) -> ListObjectsOutputTypeDef: # (1)
...
# list_objects method usage example with argument unpacking
kwargs: ListObjectsInputRequestTypeDef = { # (1)
"StorageJobId": ...,
}
parent.list_objects(**kwargs)
notify_object_complete#
Complete upload See also: AWS API Documentation.
Type annotations and code completion for boto3.client("backupstorage").notify_object_complete
method.
boto3 documentation
# notify_object_complete method definition
def notify_object_complete(
self,
*,
BackupJobId: str,
UploadId: str,
ObjectChecksum: str,
ObjectChecksumAlgorithm: SummaryChecksumAlgorithmType, # (1)
MetadataString: str = ...,
MetadataBlob: Union[str, bytes, IO[Any], StreamingBody] = ...,
MetadataBlobLength: int = ...,
MetadataBlobChecksum: str = ...,
MetadataBlobChecksumAlgorithm: DataChecksumAlgorithmType = ..., # (2)
) -> NotifyObjectCompleteOutputTypeDef: # (3)
...
- See SummaryChecksumAlgorithmType
- See DataChecksumAlgorithmType
- See NotifyObjectCompleteOutputTypeDef
# notify_object_complete method usage example with argument unpacking
kwargs: NotifyObjectCompleteInputRequestTypeDef = { # (1)
"BackupJobId": ...,
"UploadId": ...,
"ObjectChecksum": ...,
"ObjectChecksumAlgorithm": ...,
}
parent.notify_object_complete(**kwargs)
put_chunk#
Upload chunk.
Type annotations and code completion for boto3.client("backupstorage").put_chunk
method.
boto3 documentation
# put_chunk method definition
def put_chunk(
self,
*,
BackupJobId: str,
UploadId: str,
ChunkIndex: int,
Data: Union[str, bytes, IO[Any], StreamingBody],
Length: int,
Checksum: str,
ChecksumAlgorithm: DataChecksumAlgorithmType, # (1)
) -> PutChunkOutputTypeDef: # (2)
...
# put_chunk method usage example with argument unpacking
kwargs: PutChunkInputRequestTypeDef = { # (1)
"BackupJobId": ...,
"UploadId": ...,
"ChunkIndex": ...,
"Data": ...,
"Length": ...,
"Checksum": ...,
"ChecksumAlgorithm": ...,
}
parent.put_chunk(**kwargs)
put_object#
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
Type annotations and code completion for boto3.client("backupstorage").put_object
method.
boto3 documentation
# put_object method definition
def put_object(
self,
*,
BackupJobId: str,
ObjectName: str,
MetadataString: str = ...,
InlineChunk: Union[str, bytes, IO[Any], StreamingBody] = ...,
InlineChunkLength: int = ...,
InlineChunkChecksum: str = ...,
InlineChunkChecksumAlgorithm: str = ...,
ObjectChecksum: str = ...,
ObjectChecksumAlgorithm: SummaryChecksumAlgorithmType = ..., # (1)
ThrowOnDuplicate: bool = ...,
) -> PutObjectOutputTypeDef: # (2)
...
# put_object method usage example with argument unpacking
kwargs: PutObjectInputRequestTypeDef = { # (1)
"BackupJobId": ...,
"ObjectName": ...,
}
parent.put_object(**kwargs)
start_object#
Start upload containing one or many chunks.
Type annotations and code completion for boto3.client("backupstorage").start_object
method.
boto3 documentation
# start_object method definition
def start_object(
self,
*,
BackupJobId: str,
ObjectName: str,
ThrowOnDuplicate: bool = ...,
) -> StartObjectOutputTypeDef: # (1)
...
# start_object method usage example with argument unpacking
kwargs: StartObjectInputRequestTypeDef = { # (1)
"BackupJobId": ...,
"ObjectName": ...,
}
parent.start_object(**kwargs)