alibabacloud_oss_v2.aio package

Subpackages

• alibabacloud_oss_v2.aio.operations package
  • Submodules
  • alibabacloud_oss_v2.aio.operations.bucket_basic module
    • delete_bucket()
    • get_bucket_acl()
    • get_bucket_info()
    • get_bucket_location()
    • get_bucket_stat()
    • get_bucket_versioning()
    • list_object_versions()
    • list_objects()
    • list_objects_v2()
    • put_bucket()
    • put_bucket_acl()
    • put_bucket_versioning()
  • alibabacloud_oss_v2.aio.operations.bucket_tags module
    • delete_bucket_tags()
    • get_bucket_tags()
    • put_bucket_tags()
  • alibabacloud_oss_v2.aio.operations.object_basic module
    • abort_multipart_upload()
    • append_object()
    • async_process_object()
    • clean_restored_object()
    • complete_multipart_upload()
    • copy_object()
    • delete_multiple_objects()
    • delete_object()
    • delete_object_tagging()
    • get_object()
    • get_object_acl()
    • get_object_meta()
    • get_object_tagging()
    • get_symlink()
    • head_object()
    • initiate_multipart_upload()
    • list_multipart_uploads()
    • list_parts()
    • process_object()
    • put_object()
    • put_object_acl()
    • put_object_tagging()
    • put_symlink()
    • restore_object()
    • upload_part()
    • upload_part_copy()
  • alibabacloud_oss_v2.aio.operations.region module
    • describe_regions()
  • alibabacloud_oss_v2.aio.operations.service module
    • list_buckets()
  • Module contents
• alibabacloud_oss_v2.aio.transport package
  • Submodules
  • alibabacloud_oss_v2.aio.transport.aiohttp_client module
    • AioHttpClient
      • AioHttpClient.close()
      • AioHttpClient.open()
      • AioHttpClient.send()
  • Module contents

Submodules

alibabacloud_oss_v2.aio.aio_utils module

utils for stream wrapper

class alibabacloud_oss_v2.aio.aio_utils.AsyncStreamBodyReader(response: AsyncHttpResponse)

Bases: AsyncStreamBody

A StreamBodyReader that convert AsyncHttpResponse type to AsyncStreamBody type.

async close() → None

close the stream

property content: bytes

Content of the stream, in bytes.

Return type:

bytes

Returns:

The stream’s content in bytes.

property is_closed: bool

Whether the stream has been closed yet.

Return type:

bool

Returns:

Whether the stream has been closed yet.

property is_stream_consumed: bool

Whether the stream has been consumed.

Return type:

bool

Returns:

Whether the stream has been consumed.

async iter_bytes(**kwargs: Any) → AsyncIterator[bytes]

Iterates over the stream’s bytes. Will decompress in the process.

Returns:

An iterator of bytes from the stream

Return type:

Iterator[str]

async read() → bytes

Read the stream’s bytes.

Returns:

The read in bytes

Return type:

bytes

class alibabacloud_oss_v2.aio.aio_utils.TeeAsyncIterator

Bases: object

A AsyncIterator that writes to w what it reads from source

static from_source(source: Any, writers: List[Any], **kwargs: Any) → TeeAsyncIterator

Converts source to TeeAsyncIterator

Parameters:

• source (Any) – what it reads from

• writers (List[Any]) – what it writes to

Raises:

TypeError – If the type of source is is not supported, raises error.

Returns:

A AsyncIterator that writes to w what it reads from source

Return type:

TeeAsyncIterator

reset() → None

Resets the buffer to the marked position.

seekable()

Is there a file pointer offset

alibabacloud_oss_v2.aio.aio_utils.is_seekable_io(fileobj)

is seekable io

alibabacloud_oss_v2.aio.client module

Client used to interact with Alibaba Cloud Object Storage Service (OSS).

class alibabacloud_oss_v2.aio.client.AsyncClient(config: Config, **kwargs)

Bases: object

Initialize Client

Parameters:

config (Config) – _description_

async abort_multipart_upload(request: AbortMultipartUploadRequest, **kwargs) → AbortMultipartUploadResult

Cancels a multipart upload task and deletes the parts uploaded in the task.

Parameters:

request (AbortMultipartUploadRequest) – Request parameters for AbortMultipartUpload operation.

Returns:

Response result for AbortMultipartUpload operation.

Return type:

AbortMultipartUploadResult

async append_object(request: AppendObjectRequest, **kwargs) → AppendObjectResult

Uploads an object by appending the object to an existing object. Objects created by using the AppendObject operation are appendable objects.

Parameters:

request (AppendObjectRequest) – Request parameters for AppendObject operation.

Returns:

Response result for AppendObject operation.

Return type:

AppendObjectResult

async async_process_object(request: AsyncProcessObjectRequest, **kwargs) → AsyncProcessObjectResult

Applies async process on the specified image file.

Parameters:

request (AsyncProcessObjectRequest) – Request parameters for AsyncProcessObject operation.

Returns:

Response result for AsyncProcessObject operation.

Return type:

AsyncProcessObjectResult

async close()

_summary_

async complete_multipart_upload(request: CompleteMultipartUploadRequest, **kwargs) → CompleteMultipartUploadResult

Completes the multipart upload task of an object after all parts of the object are uploaded.

Parameters:

request (CompleteMultipartUploadRequest) – Request parameters for CompleteMultipartUpload operation.

Returns:

Response result for CompleteMultipartUpload operation.

Return type:

CompleteMultipartUploadResult

async copy_object(request: CopyObjectRequest, **kwargs) → CopyObjectResult

Copies objects within a bucket or between buckets in the same region.

Parameters:

request (CopyObjectRequest) – Request parameters for CopyObject operation.

Returns:

Response result for CopyObject operation.

Return type:

CopyObjectResult

async delete_bucket(request: DeleteBucketRequest, **kwargs) → DeleteBucketResult

Deletes a bucket.

Parameters:

request (DeleteBucketRequest) – Request parameters for DeleteBucket operation.

Returns:

Response result for DeleteBucket operation.

Return type:

DeleteBucketResult

async delete_multiple_objects(request: DeleteMultipleObjectsRequest, **kwargs) → DeleteMultipleObjectsResult

Deletes multiple objects from a bucket.

Parameters:

request (DeleteMultipleObjectsRequest) – Request parameters for DeleteMultipleObjects operation.

Returns:

Response result for DeleteMultipleObjects operation.

Return type:

DeleteMultipleObjectsResult

async delete_object(request: DeleteObjectRequest, **kwargs) → DeleteObjectResult

Deletes an object.

Parameters:

request (DeleteObjectRequest) – Request parameters for DeleteObject operation.

Returns:

Response result for DeleteObject operation.

Return type:

DeleteObjectResult

async delete_object_tagging(request: DeleteObjectTaggingRequest, **kwargs) → DeleteObjectTaggingResult

You can call this operation to delete the tags of a specified object.

Parameters:

request (DeleteObjectTaggingRequest) – Request parameters for DeleteObjectTagging operation.

Returns:

Response result for DeleteObjectTagging operation.

Return type:

DeleteObjectTaggingResult

async describe_regions(request: DescribeRegionsRequest, **kwargs) → DescribeRegionsResult

Queries the endpoints of all regions supported by Object Storage Service (OSS) or a specific region, including public endpoints, internal endpoints, and acceleration endpoints.

Parameters:

request (DescribeRegionsRequest) – Request parameters for DescribeRegions operation.

Returns:

Response result for DescribeRegions operation.

Return type:

DescribeRegionsResult

async get_bucket_acl(request: GetBucketAclRequest, **kwargs) → GetBucketAclResult

You can call this operation to query the ACL of a bucket. Only the bucket owner can query the ACL of the bucket.

Parameters:

request (GetBucketAclRequest) – Request parameters for GetBucketAcl operation.

Returns:

Response result for GetBucketAcl operation.

Return type:

GetBucketAclResult

async get_bucket_info(request: GetBucketInfoRequest, **kwargs) → GetBucketInfoResult

GetBucketInfo Queries information about a bucket.

Parameters:

request (GetBucketInfoRequest) – Request parameters for GetBucketInfo operation.

Returns:

Response result for GetBucketInfo operation.

Return type:

GetBucketInfoResult

async get_bucket_location(request: GetBucketLocationRequest, **kwargs) → GetBucketLocationResult

GetBucketLocation Queries the region of an Object Storage Service (OSS) bucket.

Parameters:

request (GetBucketLocationRequest) – Request parameters for GetBucketLocation operation.

Returns:

Response result for GetBucketLocation operation.

Return type:

GetBucketLocationResult

async get_bucket_stat(request: GetBucketStatRequest, **kwargs) → GetBucketStatResult

GetBucketStat Queries the storage capacity of a specified bucket and the number of objects that are stored in the bucket.

Parameters:

request (GetBucketStatRequest) – Request parameters for GetBucketStat operation.

Returns:

Response result for GetBucketStat operation.

Return type:

GetBucketStatResult

async get_bucket_versioning(request: GetBucketVersioningRequest, **kwargs) → GetBucketVersioningResult

GetBucketVersioning You can call this operation to query the versioning state of a bucket.

Parameters:

request (GetBucketVersioningRequest) – Request parameters for GetBucketVersioning operation.

Returns:

Response result for GetBucketVersioning operation.

Return type:

GetBucketVersioningResult

async get_object(request: GetObjectRequest, **kwargs) → GetObjectResult

Queries an object. To call this operation, you must have read permissions on the object.

Parameters:

request (GetObjectRequest) – Request parameters for GetObject operation.

Returns:

Response result for GetObject operation.

Return type:

GetObjectResult

async get_object_acl(request: GetObjectAclRequest, **kwargs) → GetObjectAclResult

Queries the access control list (ACL) of an object in a bucket.

Parameters:

request (GetObjectAclRequest) – Request parameters for GetObjectAcl operation.

Returns:

Response result for GetObjectAcl operation.

Return type:

GetObjectAclResult

async get_object_meta(request: GetObjectMetaRequest, **kwargs) → GetObjectMetaResult

Queries the metadata of an object, including ETag, Size, and LastModified.

Parameters:

request (GetObjectMetaRequest) – Request parameters for GetObjectMeta operation.

Returns:

Response result for GetObjectMeta operation.

Return type:

GetObjectMetaResult

async get_object_tagging(request: GetObjectTaggingRequest, **kwargs) → GetObjectTaggingResult

You can call this operation to query the tags of an object.

Parameters:

request (GetObjectTaggingRequest) – Request parameters for GetObjectTagging operation.

Returns:

Response result for GetObjectTagging operation.

Return type:

GetObjectTaggingResult

async get_symlink(request: GetSymlinkRequest, **kwargs) → GetSymlinkResult

Obtains a symbol link. To perform GetSymlink operations, you must have the read permission on the symbol link.

Parameters:

request (GetSymlinkRequest) – Request parameters for GetSymlink operation.

Returns:

Response result for GetSymlink operation.

Return type:

GetSymlinkResult

async head_object(request: HeadObjectRequest, **kwargs) → HeadObjectResult

Queries information about the object in a bucket.

Parameters:

request (HeadObjectRequest) – Request parameters for HeadObject operation.

Returns:

Response result for HeadObject operation.

Return type:

HeadObjectResult

async initiate_multipart_upload(request: InitiateMultipartUploadRequest, **kwargs) → InitiateMultipartUploadResult

Initiates a multipart upload task before you can upload data in parts to Object Storage Service (OSS).

Parameters:

request (InitiateMultipartUploadRequest) – Request parameters for InitiateMultipartUpload operation.

Returns:

Response result for InitiateMultipartUpload operation.

Return type:

InitiateMultipartUploadResult

async invoke_operation(op_input: OperationInput, **kwargs) → OperationOutput

invoke operation

Parameters:

op_input (OperationInput) – _description_

Returns:

_description_

Return type:

OperationOutput

async is_bucket_exist(bucket: str, request_payer: str | None = None, **kwargs) → bool

Checks if the bucket exists

Parameters:

• bucket (str, required) – The name of the bucket.

• request_payer (str, optional) – To indicate that the requester is aware that the request and data download will incur costs.

Returns:

True if the bucket exists, else False.

Return type:

bool

async is_object_exist(bucket: str, key: str, version_id: str | None = None, request_payer: str | None = None, **kwargs) → bool

Checks if the object exists

Parameters:

• bucket (str, required) – The name of the bucket.

• key (str, required) – The name of the object.

• version_id (str, optional) – The version ID of the source object.

• request_payer (str, optional) – To indicate that the requester is aware that the request and data download will incur costs.

Returns:

True if the object exists, else False.

Return type:

bool

async list_buckets(request: ListBucketsRequest, **kwargs) → ListBucketsResult

Lists all buckets that belong to your Alibaba Cloud account.

Parameters:

request (ListBucketsRequest) – Request parameters for ListBuckets operation.

Returns:

Response result for ListBuckets operation.

Return type:

ListBucketsResult

async list_multipart_uploads(request: ListMultipartUploadsRequest, **kwargs) → ListMultipartUploadsResult

Lists all multipart upload tasks in progress. The tasks are not completed or canceled.

Parameters:

request (ListMultipartUploadsRequest) – Request parameters for ListMultipartUploads operation.

Returns:

Response result for ListMultipartUploads operation.

Return type:

ListMultipartUploadsResult

async list_object_versions(request: ListObjectVersionsRequest, **kwargs) → ListObjectVersionsResult

ListObjectVersions Lists the versions of all objects in a bucket, including delete markers.

Parameters:

request (ListObjectVersionsRequest) – Request parameters for ListObjectVersions operation.

Returns:

Response result for ListObjectVersions operation.

Return type:

ListObjectVersionsResult

async list_objects(request: ListObjectsRequest, **kwargs) → ListObjectsResult

Lists information about all objects in an Object Storage Service (OSS) bucket.

Parameters:

request (ListObjectsRequest) – Request parameters for ListObjects operation.

Returns:

Response result for ListObjects operation.

Return type:

ListObjectsResult

async list_objects_v2(request: ListObjectsV2Request, **kwargs) → ListObjectsV2Result

Lists all objects in a bucket.

Parameters:

request (ListObjectsV2Request) – Request parameters for ListObjectsV2 operation.

Returns:

Response result for ListObjectsV2 operation.

Return type:

ListObjectsV2Result

async list_parts(request: ListPartsRequest, **kwargs) → ListPartsResult

Lists all parts that are uploaded by using a specified upload ID.

Parameters:

request (ListPartsRequest) – Request parameters for ListParts operation.

Returns:

Response result for ListParts operation.

Return type:

ListPartsResult

async process_object(request: ProcessObjectRequest, **kwargs) → ProcessObjectResult

Applies process on the specified image file.

Parameters:

request (ProcessObjectRequest) – Request parameters for ProcessObject operation.

Returns:

Response result for ProcessObject operation.

Return type:

ProcessObjectResult

async put_bucket(request: PutBucketRequest, **kwargs) → PutBucketResult

Creates a bucket.

Parameters:

request (PutBucketRequest) – Request parameters for PutBucket operation.

Returns:

Response result for PutBucket operation.

Return type:

PutBucketResult

async put_bucket_acl(request: PutBucketAclRequest, **kwargs) → PutBucketAclResult

You can call this operation to configure or modify the ACL of a bucket.

Parameters:

request (PutBucketAclRequest) – Request parameters for PutBucketAcl operation.

Returns:

Response result for PutBucketAcl operation.

Return type:

PutBucketAclResult

async put_bucket_versioning(request: PutBucketVersioningRequest, **kwargs) → PutBucketVersioningResult

PutBucketVersioning Configures the versioning state for a bucket.

Parameters:

request (PutBucketVersioningRequest) – Request parameters for PutBucketVersioning operation.

Returns:

Response result for PutBucketVersioning operation.

Return type:

PutBucketVersioningResult

async put_object(request: PutObjectRequest, **kwargs) → PutObjectResult

Uploads objects.

Parameters:

request (PutObjectRequest) – Request parameters for PutObject operation.

Returns:

Response result for PutObject operation.

Return type:

PutObjectResult

async put_object_acl(request: PutObjectAclRequest, **kwargs) → PutObjectAclResult

You can call this operation to modify the access control list (ACL) of an object.

Parameters:

request (PutObjectAclRequest) – Request parameters for PutObjectAcl operation.

Returns:

Response result for PutObjectAcl operation.

Return type:

PutObjectAclResult

async put_object_tagging(request: PutObjectTaggingRequest, **kwargs) → PutObjectTaggingResult

Adds tags to an object or updates the tags added to the object. Each tag added to an object is a key-value pair.

Parameters:

request (PutObjectTaggingRequest) – Request parameters for PutObjectTagging operation.

Returns:

Response result for PutObjectTagging operation.

Return type:

PutObjectTaggingResult

async put_symlink(request: PutSymlinkRequest, **kwargs) → PutSymlinkResult

Creates a symbolic link that points to a destination object. You can use the symbolic link to access the destination object.

Parameters:

request (PutSymlinkRequest) – Request parameters for PutSymlink operation.

Returns:

Response result for PutSymlink operation.

Return type:

PutSymlinkResult

async restore_object(request: RestoreObjectRequest, **kwargs) → RestoreObjectResult

Restores Archive, Cold Archive, or Deep Cold Archive objects.

Parameters:

request (RestoreObjectRequest) – Request parameters for RestoreObject operation.

Returns:

Response result for RestoreObject operation.

Return type:

RestoreObjectResult

async upload_part(request: UploadPartRequest, **kwargs) → UploadPartResult

Call the UploadPart interface to upload data in blocks (parts) based on the specified Object name and uploadId.

Parameters:

request (UploadPartRequest) – Request parameters for UploadPart operation.

Returns:

Response result for UploadPart operation.

Return type:

UploadPartResult

async upload_part_copy(request: UploadPartCopyRequest, **kwargs) → UploadPartCopyResult

You can call this operation to copy data from an existing object to upload a part by adding a x-oss-copy-request header to UploadPart.

Parameters:

request (UploadPartCopyRequest) – Request parameters for UploadPartCopy operation.

Returns:

Response result for UploadPartCopy operation.

Return type:

UploadPartCopyResult

Module contents