alibabacloud_oss_v2 package¶

Subpackages¶

Submodules¶

alibabacloud_oss_v2.checkpoint module¶

class alibabacloud_oss_v2.checkpoint.DownloadCheckpoint(request: GetObjectRequest, filepath: str, basedir: str, headers: MutableMapping, part_size: int)[source]¶

Bases: object

Download Checkpoint

dump() → bool[source]¶

Returns:: _description_
Return type:: _type_

load()[source]¶: load checkpoint from local file

remove() → None[source]¶

class alibabacloud_oss_v2.checkpoint.UploadCheckpoint(request: PutObjectRequest, filepath: str, basedir: str, fileinfo: stat_result, part_size: int)[source]¶

Bases: object

Upload Checkpoint

dump() → bool[source]¶

Returns:: _description_
Return type:: _type_

load()[source]¶: load checkpoint from local file

remove() → None[source]¶

alibabacloud_oss_v2.client module¶

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

class alibabacloud_oss_v2.client.Client(config: Config, **kwargs)[source]¶

Bases: object

Initialize Client

Parameters:: config (Config) – _description_

abort_bucket_worm(request: AbortBucketWormRequest, **kwargs) → AbortBucketWormResult[source]¶

Deletes an unlocked retention policy for a bucket.

Parameters:: request (AbortBucketWormRequest) – Request parameters for AbortBucketWorm operation.
Returns:: Response result for AbortBucketWorm operation.
Return type:: AbortBucketWormResult

abort_multipart_upload(request: AbortMultipartUploadRequest, **kwargs) → AbortMultipartUploadResult[source]¶

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

append_file(bucket: str, key: str, request_payer: str | None = None, create_parameter: AppendObjectRequest | None = None, **kwargs) → AppendOnlyFile[source]¶

Opens or creates the named file for appending

Parameters:

bucket (str, required) – The name of the bucket.
key (str, required) – The name of the object.
request_payer (str, optional) – To indicate that the requester is aware that the request and data download will incur costs
create_parameter (AppendObjectRequest, optional) – The parameters when the object is first generated, supports below CacheControl, ContentEncoding, Expires, ContentType, ContentType, Metadata,SSE’s parameters, Acl, StorageClass, Tagging. If the object exists, ignore this parameters

Returns:

_description_

Return type:

AppendOnlyFile

append_object(request: AppendObjectRequest, **kwargs) → AppendObjectResult[source]¶

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_process_object(request: AsyncProcessObjectRequest, **kwargs) → AsyncProcessObjectResult[source]¶

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

clean_restored_object(request: CleanRestoredObjectRequest, **kwargs) → CleanRestoredObjectResult[source]¶

You can call this operation to clean an object restored from Archive or Cold Archive state. After that, the restored object returns to the frozen state.

Parameters:: request (CleanRestoredObjectRequest) – Request parameters for CleanRestoredObject operation.
Returns:: Response result for CleanRestoredObject operation.
Return type:: CleanRestoredObjectResult

close_meta_query(request: CloseMetaQueryRequest, **kwargs) → CloseMetaQueryResult[source]¶

Disables the metadata management feature for an Object Storage Service (OSS) bucket. After the metadata management feature is disabled for a bucket, OSS automatically deletes the metadata index library of the bucket and you cannot perform metadata indexing.

Parameters:: request (CloseMetaQueryRequest) – Request parameters for CloseMetaQuery operation.
Returns:: Response result for CloseMetaQuery operation.
Return type:: CloseMetaQueryResult

complete_bucket_worm(request: CompleteBucketWormRequest, **kwargs) → CompleteBucketWormResult[source]¶

Locks a retention policy.

Parameters:: request (CompleteBucketWormRequest) – Request parameters for CompleteBucketWorm operation.
Returns:: Response result for CompleteBucketWorm operation.
Return type:: CompleteBucketWormResult

complete_multipart_upload(request: CompleteMultipartUploadRequest, **kwargs) → CompleteMultipartUploadResult[source]¶

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

copy_object(request: CopyObjectRequest, **kwargs) → CopyObjectResult[source]¶

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

create_access_point(request: CreateAccessPointRequest, **kwargs) → CreateAccessPointResult[source]¶

Creates an access point.

Parameters:: request (CreateAccessPointRequest) – Request parameters for CreateAccessPoint operation.
Returns:: Response result for CreateAccessPoint operation.
Return type:: CreateAccessPointResult

create_bucket_data_redundancy_transition(request: CreateBucketDataRedundancyTransitionRequest, **kwargs) → CreateBucketDataRedundancyTransitionResult[source]¶

Creates a redundancy type conversion task for a bucket.

Parameters:: request (CreateBucketDataRedundancyTransitionRequest) – Request parameters for CreateBucketDataRedundancyTransition operation.
Returns:: Response result for CreateBucketDataRedundancyTransition operation.
Return type:: CreateBucketDataRedundancyTransitionResult

create_cname_token(request: CreateCnameTokenRequest, **kwargs) → CreateCnameTokenResult[source]¶

Creates a CNAME token to verify the ownership of a domain name.

Parameters:: request (CreateCnameTokenRequest) – Request parameters for CreateCnameToken operation.
Returns:: Response result for CreateCnameToken operation.
Return type:: CreateCnameTokenResult

delete_access_point(request: DeleteAccessPointRequest, **kwargs) → DeleteAccessPointResult[source]¶

Deletes an access point.

Parameters:: request (DeleteAccessPointRequest) – Request parameters for DeleteAccessPoint operation.
Returns:: Response result for DeleteAccessPoint operation.
Return type:: DeleteAccessPointResult

delete_access_point_policy(request: DeleteAccessPointPolicyRequest, **kwargs) → DeleteAccessPointPolicyResult[source]¶

Deletes an access point policy.

Parameters:: request (DeleteAccessPointPolicyRequest) – Request parameters for DeleteAccessPointPolicy operation.
Returns:: Response result for DeleteAccessPointPolicy operation.
Return type:: DeleteAccessPointPolicyResult

delete_access_point_public_access_block(request: DeleteAccessPointPublicAccessBlockRequest, **kwargs) → DeleteAccessPointPublicAccessBlockResult[source]¶

Deletes the Block Public Access configurations of an access point.

Parameters:: request (DeleteAccessPointPublicAccessBlockRequest) – Request parameters for DeleteAccessPointPublicAccessBlock operation.
Returns:: Response result for DeleteAccessPointPublicAccessBlock operation.
Return type:: DeleteAccessPointPublicAccessBlockResult

delete_bucket(request: DeleteBucketRequest, **kwargs) → DeleteBucketResult[source]¶

Deletes a bucket.

Parameters:: request (DeleteBucketRequest) – Request parameters for DeleteBucket operation.
Returns:: Response result for DeleteBucket operation.
Return type:: DeleteBucketResult

delete_bucket_cors(request: DeleteBucketCorsRequest, **kwargs) → DeleteBucketCorsResult[source]¶

Disables the cross-origin resource sharing (CORS) feature and deletes all CORS rules for a bucket.

Parameters:: request (DeleteBucketCorsRequest) – Request parameters for DeleteBucketCors operation.
Returns:: Response result for DeleteBucketCors operation.
Return type:: DeleteBucketCorsResult

delete_bucket_data_redundancy_transition(request: DeleteBucketDataRedundancyTransitionRequest, **kwargs) → DeleteBucketDataRedundancyTransitionResult[source]¶

Deletes a redundancy type conversion task of a bucket.

Parameters:: request (DeleteBucketDataRedundancyTransitionRequest) – Request parameters for DeleteBucketDataRedundancyTransition operation.
Returns:: Response result for DeleteBucketDataRedundancyTransition operation.
Return type:: DeleteBucketDataRedundancyTransitionResult

delete_bucket_encryption(request: DeleteBucketEncryptionRequest, **kwargs) → DeleteBucketEncryptionResult[source]¶

Deletes encryption rules for a bucket.

Parameters:: request (DeleteBucketEncryptionRequest) – Request parameters for DeleteBucketEncryption operation.
Returns:: Response result for DeleteBucketEncryption operation.
Return type:: DeleteBucketEncryptionResult

delete_bucket_inventory(request: DeleteBucketInventoryRequest, **kwargs) → DeleteBucketInventoryResult[source]¶

Deletes an inventory for a bucket.

Parameters:: request (DeleteBucketInventoryRequest) – Request parameters for DeleteBucketInventory operation.
Returns:: Response result for DeleteBucketInventory operation.
Return type:: DeleteBucketInventoryResult

delete_bucket_lifecycle(request: DeleteBucketLifecycleRequest, **kwargs) → DeleteBucketLifecycleResult[source]¶

Deletes the lifecycle rules of a bucket.

Parameters:: request (DeleteBucketLifecycleRequest) – Request parameters for DeleteBucketLifecycle operation.
Returns:: Response result for DeleteBucketLifecycle operation.
Return type:: DeleteBucketLifecycleResult

delete_bucket_logging(request: DeleteBucketLoggingRequest, **kwargs) → DeleteBucketLoggingResult[source]¶

Disables the logging feature for a bucket.

Parameters:: request (DeleteBucketLoggingRequest) – Request parameters for DeleteBucketLogging operation.
Returns:: Response result for DeleteBucketLogging operation.
Return type:: DeleteBucketLoggingResult

delete_bucket_policy(request: DeleteBucketPolicyRequest, **kwargs) → DeleteBucketPolicyResult[source]¶

Deletes a policy for a bucket.

Parameters:: request (DeleteBucketPolicyRequest) – Request parameters for DeleteBucketPolicy operation.
Returns:: Response result for DeleteBucketPolicy operation.
Return type:: DeleteBucketPolicyResult

delete_bucket_public_access_block(request: DeleteBucketPublicAccessBlockRequest, **kwargs) → DeleteBucketPublicAccessBlockResult[source]¶

Deletes the Block Public Access configurations of a bucket.

Parameters:: request (DeleteBucketPublicAccessBlockRequest) – Request parameters for DeleteBucketPublicAccessBlock operation.
Returns:: Response result for DeleteBucketPublicAccessBlock operation.
Return type:: DeleteBucketPublicAccessBlockResult

delete_bucket_replication(request: DeleteBucketReplicationRequest, **kwargs) → DeleteBucketReplicationResult[source]¶

Disables data replication for a bucket and deletes the data replication rule configured for the bucket. After you call this operation, all operations performed on the source bucket are not synchronized to the destination bucket.

Parameters:: request (DeleteBucketReplicationRequest) – Request parameters for DeleteBucketReplication operation.
Returns:: Response result for DeleteBucketReplication operation.
Return type:: DeleteBucketReplicationResult

delete_bucket_tags(request: DeleteBucketTagsRequest, **kwargs) → DeleteBucketTagsResult[source]¶

Deletes tags configured for a bucket.

Parameters:: request (DeleteBucketTagsRequest) – Request parameters for DeleteBucketTags operation.
Returns:: Response result for DeleteBucketTags operation.
Return type:: DeleteBucketTagsResult

delete_bucket_website(request: DeleteBucketWebsiteRequest, **kwargs) → DeleteBucketWebsiteResult[source]¶

Disables the static website hosting mode and deletes the redirection rules for a bucket.

Parameters:: request (DeleteBucketWebsiteRequest) – Request parameters for DeleteBucketWebsite operation.
Returns:: Response result for DeleteBucketWebsite operation.
Return type:: DeleteBucketWebsiteResult

delete_cname(request: DeleteCnameRequest, **kwargs) → DeleteCnameResult[source]¶

Deletes a CNAME record that is mapped to a bucket.

Parameters:: request (DeleteCnameRequest) – Request parameters for DeleteCname operation.
Returns:: Response result for DeleteCname operation.
Return type:: DeleteCnameResult

delete_multiple_objects(request: DeleteMultipleObjectsRequest, **kwargs) → DeleteMultipleObjectsResult[source]¶

Deletes multiple objects from a bucket.

Parameters:: request (DeleteMultipleObjectsRequest) – Request parameters for DeleteMultipleObjects operation.
Returns:: Response result for DeleteMultipleObjects operation.
Return type:: DeleteMultipleObjectsResult

delete_object(request: DeleteObjectRequest, **kwargs) → DeleteObjectResult[source]¶

Deletes an object.

Parameters:: request (DeleteObjectRequest) – Request parameters for DeleteObject operation.
Returns:: Response result for DeleteObject operation.
Return type:: DeleteObjectResult

delete_object_tagging(request: DeleteObjectTaggingRequest, **kwargs) → DeleteObjectTaggingResult[source]¶

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

delete_public_access_block(request: DeletePublicAccessBlockRequest, **kwargs) → DeletePublicAccessBlockResult[source]¶

Deletes the Block Public Access configurations of OSS resources.

Parameters:: request (DeletePublicAccessBlockRequest) – Request parameters for DeletePublicAccessBlock operation.
Returns:: Response result for DeletePublicAccessBlock operation.
Return type:: DeletePublicAccessBlockResult

delete_style(request: DeleteStyleRequest, **kwargs) → DeleteStyleResult[source]¶

Deletes an image style from a bucket.

Parameters:: request (DeleteStyleRequest) – Request parameters for DeleteStyle operation.
Returns:: Response result for DeleteStyle operation.
Return type:: DeleteStyleResult

delete_user_defined_log_fields_config(request: DeleteUserDefinedLogFieldsConfigRequest, **kwargs) → DeleteUserDefinedLogFieldsConfigResult[source]¶

Deletes the custom configurations of the user_defined_log_fields field in the real-time logs of a bucket.

Parameters:: request (DeleteUserDefinedLogFieldsConfigRequest) – Request parameters for DeleteUserDefinedLogFieldsConfig operation.
Returns:: Response result for DeleteUserDefinedLogFieldsConfig operation.
Return type:: DeleteUserDefinedLogFieldsConfigResult

describe_regions(request: DescribeRegionsRequest, **kwargs) → DescribeRegionsResult[source]¶

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

do_meta_query(request: DoMetaQueryRequest, **kwargs) → DoMetaQueryResult[source]¶

Queries the objects in a bucket that meet the specified conditions by using the data indexing feature. The information about the objects is listed based on the specified fields and sorting methods.

Parameters:: request (DoMetaQueryRequest) – Request parameters for DoMetaQuery operation.
Returns:: Response result for DoMetaQuery operation.
Return type:: DoMetaQueryResult

downloader(**kwargs) → Downloader[source]¶

Args:

Returns:: _description_
Return type:: Downloader

extend_bucket_worm(request: ExtendBucketWormRequest, **kwargs) → ExtendBucketWormResult[source]¶

Extends the retention period of objects in a bucket for which a retention policy is locked.

Parameters:: request (ExtendBucketWormRequest) – Request parameters for ExtendBucketWorm operation.
Returns:: Response result for ExtendBucketWorm operation.
Return type:: ExtendBucketWormResult

get_access_point(request: GetAccessPointRequest, **kwargs) → GetAccessPointResult[source]¶

Queries the information about an access point.

Parameters:: request (GetAccessPointRequest) – Request parameters for GetAccessPoint operation.
Returns:: Response result for GetAccessPoint operation.
Return type:: GetAccessPointResult

get_access_point_policy(request: GetAccessPointPolicyRequest, **kwargs) → GetAccessPointPolicyResult[source]¶

Queries the configurations of an access point policy.

Parameters:: request (GetAccessPointPolicyRequest) – Request parameters for GetAccessPointPolicy operation.
Returns:: Response result for GetAccessPointPolicy operation.
Return type:: GetAccessPointPolicyResult

get_access_point_public_access_block(request: GetAccessPointPublicAccessBlockRequest, **kwargs) → GetAccessPointPublicAccessBlockResult[source]¶

Queries the Block Public Access configurations of an access point.

Parameters:: request (GetAccessPointPublicAccessBlockRequest) – Request parameters for GetAccessPointPublicAccessBlock operation.
Returns:: Response result for GetAccessPointPublicAccessBlock operation.
Return type:: GetAccessPointPublicAccessBlockResult

get_bucket_access_monitor(request: GetBucketAccessMonitorRequest, **kwargs) → GetBucketAccessMonitorResult[source]¶

Queries the access tracking status of a bucket.

Parameters:: request (GetBucketAccessMonitorRequest) – Request parameters for GetBucketAccessMonitor operation.
Returns:: Response result for GetBucketAccessMonitor operation.
Return type:: GetBucketAccessMonitorResult

get_bucket_acl(request: GetBucketAclRequest, **kwargs) → GetBucketAclResult[source]¶

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

get_bucket_archive_direct_read(request: GetBucketArchiveDirectReadRequest, **kwargs) → GetBucketArchiveDirectReadResult[source]¶

Queries whether real-time access of Archive objects is enabled for a bucket.

Parameters:: request (GetBucketArchiveDirectReadRequest) – Request parameters for GetBucketArchiveDirectRead operation.
Returns:: Response result for GetBucketArchiveDirectRead operation.
Return type:: GetBucketArchiveDirectReadResult

get_bucket_cors(request: GetBucketCorsRequest, **kwargs) → GetBucketCorsResult[source]¶

Queries the cross-origin resource sharing (CORS) rules that are configured for a bucket.

Parameters:: request (GetBucketCorsRequest) – Request parameters for GetBucketCors operation.
Returns:: Response result for GetBucketCors operation.
Return type:: GetBucketCorsResult

get_bucket_data_redundancy_transition(request: GetBucketDataRedundancyTransitionRequest, **kwargs) → GetBucketDataRedundancyTransitionResult[source]¶

Queries the redundancy type conversion tasks of a bucket.

Parameters:: request (GetBucketDataRedundancyTransitionRequest) – Request parameters for GetBucketDataRedundancyTransition operation.
Returns:: Response result for GetBucketDataRedundancyTransition operation.
Return type:: GetBucketDataRedundancyTransitionResult

get_bucket_encryption(request: GetBucketEncryptionRequest, **kwargs) → GetBucketEncryptionResult[source]¶

Queries the encryption rules configured for a bucket.

Parameters:: request (GetBucketEncryptionRequest) – Request parameters for GetBucketEncryption operation.
Returns:: Response result for GetBucketEncryption operation.
Return type:: GetBucketEncryptionResult

get_bucket_https_config(request: GetBucketHttpsConfigRequest, **kwargs) → GetBucketHttpsConfigResult[source]¶

Queries the Transport Layer Security (TLS) version configurations of a bucket.

Parameters:: request (GetBucketHttpsConfigRequest) – Request parameters for GetBucketHttpsConfig operation.
Returns:: Response result for GetBucketHttpsConfig operation.
Return type:: GetBucketHttpsConfigResult

get_bucket_info(request: GetBucketInfoRequest, **kwargs) → GetBucketInfoResult[source]¶

GetBucketInfo Queries information about a bucket.

Parameters:: request (GetBucketInfoRequest) – Request parameters for GetBucketInfo operation.
Returns:: Response result for GetBucketInfo operation.
Return type:: GetBucketInfoResult

get_bucket_inventory(request: GetBucketInventoryRequest, **kwargs) → GetBucketInventoryResult[source]¶

Queries the inventories that are configured for a bucket.

Parameters:: request (GetBucketInventoryRequest) – Request parameters for GetBucketInventory operation.
Returns:: Response result for GetBucketInventory operation.
Return type:: GetBucketInventoryResult

get_bucket_lifecycle(request: GetBucketLifecycleRequest, **kwargs) → GetBucketLifecycleResult[source]¶

Queries the lifecycle rules configured for a bucket. Only the owner of a bucket has the permissions to query the lifecycle rules configured for the bucket.

Parameters:: request (GetBucketLifecycleRequest) – Request parameters for GetBucketLifecycle operation.
Returns:: Response result for GetBucketLifecycle operation.
Return type:: GetBucketLifecycleResult

get_bucket_location(request: GetBucketLocationRequest, **kwargs) → GetBucketLocationResult[source]¶

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

get_bucket_logging(request: GetBucketLoggingRequest, **kwargs) → GetBucketLoggingResult[source]¶

Queries the configurations of access log collection of a bucket. Only the owner of a bucket can query the configurations of access log collection of the bucket.

Parameters:: request (GetBucketLoggingRequest) – Request parameters for GetBucketLogging operation.
Returns:: Response result for GetBucketLogging operation.
Return type:: GetBucketLoggingResult

get_bucket_policy(request: GetBucketPolicyRequest, **kwargs) → GetBucketPolicyResult[source]¶

Queries the policies configured for a bucket.

Parameters:: request (GetBucketPolicyRequest) – Request parameters for GetBucketPolicy operation.
Returns:: Response result for GetBucketPolicy operation.
Return type:: GetBucketPolicyResult

get_bucket_policy_status(request: GetBucketPolicyStatusRequest, **kwargs) → GetBucketPolicyStatusResult[source]¶

Checks whether the current bucket policy allows public access.

Parameters:: request (GetBucketPolicyStatusRequest) – Request parameters for GetBucketPolicyStatus operation.
Returns:: Response result for GetBucketPolicyStatus operation.
Return type:: GetBucketPolicyStatusResult

get_bucket_public_access_block(request: GetBucketPublicAccessBlockRequest, **kwargs) → GetBucketPublicAccessBlockResult[source]¶

Queries the Block Public Access configurations of a bucket.

Parameters:: request (GetBucketPublicAccessBlockRequest) – Request parameters for GetBucketPublicAccessBlock operation.
Returns:: Response result for GetBucketPublicAccessBlock operation.
Return type:: GetBucketPublicAccessBlockResult

get_bucket_referer(request: GetBucketRefererRequest, **kwargs) → GetBucketRefererResult[source]¶

Queries the hotlink protection configurations for a bucket.

Parameters:: request (GetBucketRefererRequest) – Request parameters for GetBucketReferer operation.
Returns:: Response result for GetBucketReferer operation.
Return type:: GetBucketRefererResult

get_bucket_replication(request: GetBucketReplicationRequest, **kwargs) → GetBucketReplicationResult[source]¶

Queries the data replication rules configured for a bucket.

Parameters:: request (GetBucketReplicationRequest) – Request parameters for GetBucketReplication operation.
Returns:: Response result for GetBucketReplication operation.
Return type:: GetBucketReplicationResult

get_bucket_replication_location(request: GetBucketReplicationLocationRequest, **kwargs) → GetBucketReplicationLocationResult[source]¶

Queries the regions in which available destination buckets reside. You can determine the region of the destination bucket to which the data in the source bucket are replicated based on the returned response.

Parameters:: request (GetBucketReplicationLocationRequest) – Request parameters for GetBucketReplicationLocation operation.
Returns:: Response result for GetBucketReplicationLocation operation.
Return type:: GetBucketReplicationLocationResult

get_bucket_replication_progress(request: GetBucketReplicationProgressRequest, **kwargs) → GetBucketReplicationProgressResult[source]¶

Queries the information about the data replication process of a bucket.

Parameters:: request (GetBucketReplicationProgressRequest) – Request parameters for GetBucketReplicationProgress operation.
Returns:: Response result for GetBucketReplicationProgress operation.
Return type:: GetBucketReplicationProgressResult

get_bucket_request_payment(request: GetBucketRequestPaymentRequest, **kwargs) → GetBucketRequestPaymentResult[source]¶

Queries pay-by-requester configurations for a bucket.

Parameters:: request (GetBucketRequestPaymentRequest) – Request parameters for GetBucketRequestPayment operation.
Returns:: Response result for GetBucketRequestPayment operation.
Return type:: GetBucketRequestPaymentResult

get_bucket_resource_group(request: GetBucketResourceGroupRequest, **kwargs) → GetBucketResourceGroupResult[source]¶

Queries the ID of the resource group to which a bucket belongs.

Parameters:: request (GetBucketResourceGroupRequest) – Request parameters for GetBucketResourceGroup operation.
Returns:: Response result for GetBucketResourceGroup operation.
Return type:: GetBucketResourceGroupResult

get_bucket_stat(request: GetBucketStatRequest, **kwargs) → GetBucketStatResult[source]¶

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

get_bucket_tags(request: GetBucketTagsRequest, **kwargs) → GetBucketTagsResult[source]¶

Queries the tags of a bucket.

Parameters:: request (GetBucketTagsRequest) – Request parameters for GetBucketTags operation.
Returns:: Response result for GetBucketTags operation.
Return type:: GetBucketTagsResult

get_bucket_transfer_acceleration(request: GetBucketTransferAccelerationRequest, **kwargs) → GetBucketTransferAccelerationResult[source]¶

Queries the transfer acceleration configurations of a bucket.

Parameters:: request (GetBucketTransferAccelerationRequest) – Request parameters for GetBucketTransferAcceleration operation.
Returns:: Response result for GetBucketTransferAcceleration operation.
Return type:: GetBucketTransferAccelerationResult

get_bucket_versioning(request: GetBucketVersioningRequest, **kwargs) → GetBucketVersioningResult[source]¶

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

get_bucket_website(request: GetBucketWebsiteRequest, **kwargs) → GetBucketWebsiteResult[source]¶

Queries the static website hosting status and redirection rules configured for a bucket.

Parameters:: request (GetBucketWebsiteRequest) – Request parameters for GetBucketWebsite operation.
Returns:: Response result for GetBucketWebsite operation.
Return type:: GetBucketWebsiteResult

get_bucket_worm(request: GetBucketWormRequest, **kwargs) → GetBucketWormResult[source]¶

Queries the retention policy configured for a bucket.

Parameters:: request (GetBucketWormRequest) – Request parameters for GetBucketWorm operation.
Returns:: Response result for GetBucketWorm operation.
Return type:: GetBucketWormResult

get_cname_token(request: GetCnameTokenRequest, **kwargs) → GetCnameTokenResult[source]¶

Queries the created CNAME tokens.

Parameters:: request (GetCnameTokenRequest) – Request parameters for GetCnameToken operation.
Returns:: Response result for GetCnameToken operation.
Return type:: GetCnameTokenResult

get_meta_query_status(request: GetMetaQueryStatusRequest, **kwargs) → GetMetaQueryStatusResult[source]¶

Queries the information about the metadata index library of a bucket.

Parameters:: request (GetMetaQueryStatusRequest) – Request parameters for GetMetaQueryStatus operation.
Returns:: Response result for GetMetaQueryStatus operation.
Return type:: GetMetaQueryStatusResult

get_object(request: GetObjectRequest, **kwargs) → GetObjectResult[source]¶

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

get_object_acl(request: GetObjectAclRequest, **kwargs) → GetObjectAclResult[source]¶

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

get_object_meta(request: GetObjectMetaRequest, **kwargs) → GetObjectMetaResult[source]¶

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

get_object_tagging(request: GetObjectTaggingRequest, **kwargs) → GetObjectTaggingResult[source]¶

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

get_object_to_file(request: GetObjectRequest, filepath: str, **kwargs) → GetObjectResult[source]¶

get object to file

Parameters:

request (models.GetObjectRequest) – _description_
filepath (str) – _description_

Returns:

_description_

Return type:

models.GetObjectResult

get_public_access_block(request: GetPublicAccessBlockRequest, **kwargs) → GetPublicAccessBlockResult[source]¶

Queries the Block Public Access configurations of OSS resources.

Parameters:: request (GetPublicAccessBlockRequest) – Request parameters for GetPublicAccessBlock operation.
Returns:: Response result for GetPublicAccessBlock operation.
Return type:: GetPublicAccessBlockResult

get_style(request: GetStyleRequest, **kwargs) → GetStyleResult[source]¶

Queries the information about an image style of a bucket.

Parameters:: request (GetStyleRequest) – Request parameters for GetStyle operation.
Returns:: Response result for GetStyle operation.
Return type:: GetStyleResult

get_symlink(request: GetSymlinkRequest, **kwargs) → GetSymlinkResult[source]¶

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

get_user_defined_log_fields_config(request: GetUserDefinedLogFieldsConfigRequest, **kwargs) → GetUserDefinedLogFieldsConfigResult[source]¶

Queries the custom configurations of the user_defined_log_fields field in the real-time logs of a bucket.

Parameters:: request (GetUserDefinedLogFieldsConfigRequest) – Request parameters for GetUserDefinedLogFieldsConfig operation.
Returns:: Response result for GetUserDefinedLogFieldsConfig operation.
Return type:: GetUserDefinedLogFieldsConfigResult

head_object(request: HeadObjectRequest, **kwargs) → HeadObjectResult[source]¶

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

initiate_bucket_worm(request: InitiateBucketWormRequest, **kwargs) → InitiateBucketWormResult[source]¶

Creates a retention policy.

Parameters:: request (InitiateBucketWormRequest) – Request parameters for InitiateBucketWorm operation.
Returns:: Response result for InitiateBucketWorm operation.
Return type:: InitiateBucketWormResult

initiate_multipart_upload(request: InitiateMultipartUploadRequest, **kwargs) → InitiateMultipartUploadResult[source]¶

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

invoke_operation(op_input: OperationInput, **kwargs) → OperationOutput[source]¶

invoke operation

Parameters:: op_input (OperationInput) – _description_
Returns:: _description_
Return type:: OperationOutput

is_bucket_exist(bucket: str, request_payer: str | None = None, **kwargs) → bool[source]¶

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

is_object_exist(bucket: str, key: str, version_id: str | None = None, request_payer: str | None = None, **kwargs) → bool[source]¶

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

list_access_points(request: ListAccessPointsRequest, **kwargs) → ListAccessPointsResult[source]¶

Queries the information about user-level or bucket-level access points.

Parameters:: request (ListAccessPointsRequest) – Request parameters for ListAccessPoints operation.
Returns:: Response result for ListAccessPoints operation.
Return type:: ListAccessPointsResult

list_bucket_data_redundancy_transition(request: ListBucketDataRedundancyTransitionRequest, **kwargs) → ListBucketDataRedundancyTransitionResult[source]¶

Lists all redundancy type conversion tasks of a bucket.

Parameters:: request (ListBucketDataRedundancyTransitionRequest) – Request parameters for ListBucketDataRedundancyTransition operation.
Returns:: Response result for ListBucketDataRedundancyTransition operation.
Return type:: ListBucketDataRedundancyTransitionResult

list_bucket_inventory(request: ListBucketInventoryRequest, **kwargs) → ListBucketInventoryResult[source]¶

Queries all inventories in a bucket at a time.

Parameters:: request (ListBucketInventoryRequest) – Request parameters for ListBucketInventory operation.
Returns:: Response result for ListBucketInventory operation.
Return type:: ListBucketInventoryResult

list_buckets(request: ListBucketsRequest, **kwargs) → ListBucketsResult[source]¶

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

list_buckets_paginator(**kwargs) → ListBucketsPaginator[source]¶

Creates a paginator for ListBuckets

Returns:: a paginator for ListBuckets
Return type:: ListBucketsPaginator

list_cname(request: ListCnameRequest, **kwargs) → ListCnameResult[source]¶

Queries all CNAME records that are mapped to a bucket.

Parameters:: request (ListCnameRequest) – Request parameters for ListCname operation.
Returns:: Response result for ListCname operation.
Return type:: ListCnameResult

list_multipart_uploads(request: ListMultipartUploadsRequest, **kwargs) → ListMultipartUploadsResult[source]¶

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

list_multipart_uploads_paginator(**kwargs) → ListMultipartUploadsPaginator[source]¶

Creates a paginator for ListMultipartUploads

Returns:: a paginator for ListMultipartUploads
Return type:: ListMultipartUploadsPaginator

list_object_versions(request: ListObjectVersionsRequest, **kwargs) → ListObjectVersionsResult[source]¶

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

list_object_versions_paginator(**kwargs) → ListObjectVersionsPaginator[source]¶

Creates a paginator for ListObjectVersions

Returns:: a paginator for ListObjectVersions
Return type:: ListObjectVersionsPaginator

list_objects(request: ListObjectsRequest, **kwargs) → ListObjectsResult[source]¶

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

list_objects_paginator(**kwargs) → ListObjectsPaginator[source]¶

Creates a paginator for ListObjects

Returns:: a paginator for ListObjects
Return type:: ListObjectsPaginator

list_objects_v2(request: ListObjectsV2Request, **kwargs) → ListObjectsV2Result[source]¶

Lists all objects in a bucket.

Parameters:: request (ListObjectsV2Request) – Request parameters for ListObjectsV2 operation.
Returns:: Response result for ListObjectsV2 operation.
Return type:: ListObjectsV2Result

list_objects_v2_paginator(**kwargs) → ListObjectsV2Paginator[source]¶

Creates a paginator for ListObjectsV2

Returns:: a paginator for ListObjectsV2
Return type:: ListObjectsV2Paginator

list_parts(request: ListPartsRequest, **kwargs) → ListPartsResult[source]¶

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

list_parts_paginator(**kwargs) → ListPartsPaginator[source]¶

Creates a paginator for ListParts

Returns:: a paginator for ListParts
Return type:: ListPartsPaginator

list_style(request: ListStyleRequest, **kwargs) → ListStyleResult[source]¶

Queries all image styles that are created for a bucket.

Parameters:: request (ListStyleRequest) – Request parameters for ListStyle operation.
Returns:: Response result for ListStyle operation.
Return type:: ListStyleResult

list_user_data_redundancy_transition(request: ListUserDataRedundancyTransitionRequest, **kwargs) → ListUserDataRedundancyTransitionResult[source]¶

Lists all redundancy type conversion tasks of a user.

Parameters:: request (ListUserDataRedundancyTransitionRequest) – Request parameters for ListUserDataRedundancyTransition operation.
Returns:: Response result for ListUserDataRedundancyTransition operation.
Return type:: ListUserDataRedundancyTransitionResult

open_file(bucket: str, key: str, version_id: str | None = None, request_payer: str | None = None, **kwargs) → ReadOnlyFile[source]¶

Opens the named file for reading.

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 object.
request_payer (str, optional) – To indicate that the requester is aware that the request and data download will incur costs

Returns:

_description_

Return type:

ReadOnlyFile

open_meta_query(request: OpenMetaQueryRequest, **kwargs) → OpenMetaQueryResult[source]¶

Enables metadata management for a bucket. After you enable the metadata management feature for a bucket, Object Storage Service (OSS) creates a metadata index library for the bucket and creates metadata indexes for all objects in the bucket. After the metadata index library is created, OSS continues to perform quasi-real-time scans on incremental objects in the bucket and creates metadata indexes for the incremental objects.

Parameters:: request (OpenMetaQueryRequest) – Request parameters for OpenMetaQuery operation.
Returns:: Response result for OpenMetaQuery operation.
Return type:: OpenMetaQueryResult

option_object(request: OptionObjectRequest, **kwargs) → OptionObjectResult[source]¶

Determines whether to send a cross-origin request. Before a cross-origin request is sent, the browser sends a preflight OPTIONS request that includes a specific origin, HTTP method, and header information to Object Storage Service (OSS) to determine whether to send the cross-origin request.

Parameters:: request (OptionObjectRequest) – Request parameters for OptionObject operation.
Returns:: Response result for OptionObject operation.
Return type:: OptionObjectResult

Generates the presigned URL. If you do not specify expires or expiration, the pre-signed URL uses 15 minutes as default.

Parameters:

request (PresignRequest) – Request parameters for presign operation.
expires (datetime.timedelta, optional) – The expiration duration for the presigned url.
expiration (datetime.datetime, optional) – The expiration time for the presigned url.

Returns:

Response result for presign operation.

Return type:

PresignResult

process_object(request: ProcessObjectRequest, **kwargs) → ProcessObjectResult[source]¶

Applies process on the specified image file.

Parameters:: request (ProcessObjectRequest) – Request parameters for ProcessObject operation.
Returns:: Response result for ProcessObject operation.
Return type:: ProcessObjectResult

put_access_point_policy(request: PutAccessPointPolicyRequest, **kwargs) → PutAccessPointPolicyResult[source]¶

Configures an access point policy.

Parameters:: request (PutAccessPointPolicyRequest) – Request parameters for PutAccessPointPolicy operation.
Returns:: Response result for PutAccessPointPolicy operation.
Return type:: PutAccessPointPolicyResult

put_access_point_public_access_block(request: PutAccessPointPublicAccessBlockRequest, **kwargs) → PutAccessPointPublicAccessBlockResult[source]¶

Enables or disables Block Public Access for an access point.

Parameters:: request (PutAccessPointPublicAccessBlockRequest) – Request parameters for PutAccessPointPublicAccessBlock operation.
Returns:: Response result for PutAccessPointPublicAccessBlock operation.
Return type:: PutAccessPointPublicAccessBlockResult

put_bucket(request: PutBucketRequest, **kwargs) → PutBucketResult[source]¶

Creates a bucket.

Parameters:: request (PutBucketRequest) – Request parameters for PutBucket operation.
Returns:: Response result for PutBucket operation.
Return type:: PutBucketResult

put_bucket_access_monitor(request: PutBucketAccessMonitorRequest, **kwargs) → PutBucketAccessMonitorResult[source]¶

Modifies the access tracking status of a bucket.

Parameters:: request (PutBucketAccessMonitorRequest) – Request parameters for PutBucketAccessMonitor operation.
Returns:: Response result for PutBucketAccessMonitor operation.
Return type:: PutBucketAccessMonitorResult

put_bucket_acl(request: PutBucketAclRequest, **kwargs) → PutBucketAclResult[source]¶

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

put_bucket_archive_direct_read(request: PutBucketArchiveDirectReadRequest, **kwargs) → PutBucketArchiveDirectReadResult[source]¶

Enables or disables real-time access of Archive objects for a bucket.

Parameters:: request (PutBucketArchiveDirectReadRequest) – Request parameters for PutBucketArchiveDirectRead operation.
Returns:: Response result for PutBucketArchiveDirectRead operation.
Return type:: PutBucketArchiveDirectReadResult

put_bucket_cors(request: PutBucketCorsRequest, **kwargs) → PutBucketCorsResult[source]¶

Configures cross-origin resource sharing (CORS) rules for a bucket.

Parameters:: request (PutBucketCorsRequest) – Request parameters for PutBucketCors operation.
Returns:: Response result for PutBucketCors operation.
Return type:: PutBucketCorsResult

put_bucket_encryption(request: PutBucketEncryptionRequest, **kwargs) → PutBucketEncryptionResult[source]¶

Configures encryption rules for a bucket.

Parameters:: request (PutBucketEncryptionRequest) – Request parameters for PutBucketEncryption operation.
Returns:: Response result for PutBucketEncryption operation.
Return type:: PutBucketEncryptionResult

put_bucket_https_config(request: PutBucketHttpsConfigRequest, **kwargs) → PutBucketHttpsConfigResult[source]¶

Enables or disables Transport Layer Security (TLS) version management for a bucket.

Parameters:: request (PutBucketHttpsConfigRequest) – Request parameters for PutBucketHttpsConfig operation.
Returns:: Response result for PutBucketHttpsConfig operation.
Return type:: PutBucketHttpsConfigResult

put_bucket_inventory(request: PutBucketInventoryRequest, **kwargs) → PutBucketInventoryResult[source]¶

Configures an inventory for a bucket.

Parameters:: request (PutBucketInventoryRequest) – Request parameters for PutBucketInventory operation.
Returns:: Response result for PutBucketInventory operation.
Return type:: PutBucketInventoryResult

put_bucket_lifecycle(request: PutBucketLifecycleRequest, **kwargs) → PutBucketLifecycleResult[source]¶

Configures a lifecycle rule for a bucket. After you configure a lifecycle rule for a bucket, Object Storage Service (OSS) automatically deletes the objects that match the rule or converts the storage type of the objects based on the point in time that is specified in the lifecycle rule.

Parameters:: request (PutBucketLifecycleRequest) – Request parameters for PutBucketLifecycle operation.
Returns:: Response result for PutBucketLifecycle operation.
Return type:: PutBucketLifecycleResult

put_bucket_logging(request: PutBucketLoggingRequest, **kwargs) → PutBucketLoggingResult[source]¶

Enables logging for a bucket. After you enable logging for a bucket, Object Storage Service (OSS) generates logs every hour based on the defined naming rule and stores the logs as objects in the specified destination bucket.

Parameters:: request (PutBucketLoggingRequest) – Request parameters for PutBucketLogging operation.
Returns:: Response result for PutBucketLogging operation.
Return type:: PutBucketLoggingResult

put_bucket_policy(request: PutBucketPolicyRequest, **kwargs) → PutBucketPolicyResult[source]¶

Configures a policy for a bucket.

Parameters:: request (PutBucketPolicyRequest) – Request parameters for PutBucketPolicy operation.
Returns:: Response result for PutBucketPolicy operation.
Return type:: PutBucketPolicyResult

put_bucket_public_access_block(request: PutBucketPublicAccessBlockRequest, **kwargs) → PutBucketPublicAccessBlockResult[source]¶

Enables or disables Block Public Access for a bucket.

Parameters:: request (PutBucketPublicAccessBlockRequest) – Request parameters for PutBucketPublicAccessBlock operation.
Returns:: Response result for PutBucketPublicAccessBlock operation.
Return type:: PutBucketPublicAccessBlockResult

put_bucket_referer(request: PutBucketRefererRequest, **kwargs) → PutBucketRefererResult[source]¶

Configures a Referer whitelist for an Object Storage Service (OSS) bucket. You can specify whether to allow the requests whose Referer field is empty or whose query strings are truncated.

Parameters:: request (PutBucketRefererRequest) – Request parameters for PutBucketReferer operation.
Returns:: Response result for PutBucketReferer operation.
Return type:: PutBucketRefererResult

put_bucket_replication(request: PutBucketReplicationRequest, **kwargs) → PutBucketReplicationResult[source]¶

Configures data replication rules for a bucket. Object Storage Service (OSS) supports cross-region replication (CRR) and same-region replication (SRR).

Parameters:: request (PutBucketReplicationRequest) – Request parameters for PutBucketReplication operation.
Returns:: Response result for PutBucketReplication operation.
Return type:: PutBucketReplicationResult

put_bucket_request_payment(request: PutBucketRequestPaymentRequest, **kwargs) → PutBucketRequestPaymentResult[source]¶

Enables pay-by-requester for a bucket.

Parameters:: request (PutBucketRequestPaymentRequest) – Request parameters for PutBucketRequestPayment operation.
Returns:: Response result for PutBucketRequestPayment operation.
Return type:: PutBucketRequestPaymentResult

put_bucket_resource_group(request: PutBucketResourceGroupRequest, **kwargs) → PutBucketResourceGroupResult[source]¶

Modifies the ID of the resource group to which a bucket belongs.

Parameters:: request (PutBucketResourceGroupRequest) – Request parameters for PutBucketResourceGroup operation.
Returns:: Response result for PutBucketResourceGroup operation.
Return type:: PutBucketResourceGroupResult

put_bucket_rtc(request: PutBucketRtcRequest, **kwargs) → PutBucketRtcResult[source]¶

Enables or disables the Replication Time Control (RTC) feature for existing cross-region replication (CRR) rules.

Parameters:: request (PutBucketRtcRequest) – Request parameters for PutBucketRtc operation.
Returns:: Response result for PutBucketRtc operation.
Return type:: PutBucketRtcResult

put_bucket_tags(request: PutBucketTagsRequest, **kwargs) → PutBucketTagsResult[source]¶

Adds tags to or modifies the existing tags of a bucket.

Parameters:: request (PutBucketTagsRequest) – Request parameters for PutBucketTags operation.
Returns:: Response result for PutBucketTags operation.
Return type:: PutBucketTagsResult

put_bucket_transfer_acceleration(request: PutBucketTransferAccelerationRequest, **kwargs) → PutBucketTransferAccelerationResult[source]¶

Configures transfer acceleration for a bucket. After you enable transfer acceleration for a bucket, the object access speed is accelerated for users worldwide. The transfer acceleration feature is applicable to scenarios where data needs to be transferred over long geographical distances. This feature can also be used to download or upload objects that are gigabytes or terabytes in size.

Parameters:: request (PutBucketTransferAccelerationRequest) – Request parameters for PutBucketTransferAcceleration operation.
Returns:: Response result for PutBucketTransferAcceleration operation.
Return type:: PutBucketTransferAccelerationResult

put_bucket_versioning(request: PutBucketVersioningRequest, **kwargs) → PutBucketVersioningResult[source]¶

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

put_bucket_website(request: PutBucketWebsiteRequest, **kwargs) → PutBucketWebsiteResult[source]¶

Enables the static website hosting mode for a bucket and configures redirection rules for the bucket.

Parameters:: request (PutBucketWebsiteRequest) – Request parameters for PutBucketWebsite operation.
Returns:: Response result for PutBucketWebsite operation.
Return type:: PutBucketWebsiteResult

put_cname(request: PutCnameRequest, **kwargs) → PutCnameResult[source]¶

Maps a CNAME record to a bucket.

Parameters:: request (PutCnameRequest) – Request parameters for PutCname operation.
Returns:: Response result for PutCname operation.
Return type:: PutCnameResult

put_object(request: PutObjectRequest, **kwargs) → PutObjectResult[source]¶

Uploads objects.

Parameters:: request (PutObjectRequest) – Request parameters for PutObject operation.
Returns:: Response result for PutObject operation.
Return type:: PutObjectResult

put_object_acl(request: PutObjectAclRequest, **kwargs) → PutObjectAclResult[source]¶

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

put_object_from_file(request: PutObjectRequest, filepath: str, **kwargs) → PutObjectResult[source]¶

put object from file

Parameters:

request (models.PutObjectRequest) – _description_
filepath (str) – _description_

Returns:

_description_

Return type:

models.PutObjectResult

put_object_tagging(request: PutObjectTaggingRequest, **kwargs) → PutObjectTaggingResult[source]¶

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

put_public_access_block(request: PutPublicAccessBlockRequest, **kwargs) → PutPublicAccessBlockResult[source]¶

Enables or disables Block Public Access for Object Storage Service (OSS) resources.

Parameters:: request (PutPublicAccessBlockRequest) – Request parameters for PutPublicAccessBlock operation.
Returns:: Response result for PutPublicAccessBlock operation.
Return type:: PutPublicAccessBlockResult

put_style(request: PutStyleRequest, **kwargs) → PutStyleResult[source]¶

Adds an image style to a bucket. An image style contains one or more image processing parameters.

Parameters:: request (PutStyleRequest) – Request parameters for PutStyle operation.
Returns:: Response result for PutStyle operation.
Return type:: PutStyleResult

put_symlink(request: PutSymlinkRequest, **kwargs) → PutSymlinkResult[source]¶

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

put_user_defined_log_fields_config(request: PutUserDefinedLogFieldsConfigRequest, **kwargs) → PutUserDefinedLogFieldsConfigResult[source]¶

Customizes the user_defined_log_fields field in real-time logs by adding custom request headers or query parameters to the field for subsequent analysis of requests.

Parameters:: request (PutUserDefinedLogFieldsConfigRequest) – Request parameters for PutUserDefinedLogFieldsConfig operation.
Returns:: Response result for PutUserDefinedLogFieldsConfig operation.
Return type:: PutUserDefinedLogFieldsConfigResult

restore_object(request: RestoreObjectRequest, **kwargs) → RestoreObjectResult[source]¶

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

upload_part(request: UploadPartRequest, **kwargs) → UploadPartResult[source]¶

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

upload_part_copy(request: UploadPartCopyRequest, **kwargs) → UploadPartCopyResult[source]¶

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

uploader(**kwargs) → Uploader[source]¶

Returns:: _description_
Return type:: Uploader

alibabacloud_oss_v2.config module¶

Bases: object

Configuration for client.

Parameters:

region (str, required) – The region in which the bucket is located.
endpoint (str, optional) – The domain names that other services can use to access OSS.
credentials_provider (CredentialsProvider, optional) – The credentials provider to use when signing requests.
connect_timeout (int|float, optional) – The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 10 seconds.
readwrite_timeout (int|float, optional) – The time in seconds till a timeout exception is thrown when attempting to read from a connection. The default is 20 seconds.
retry_max_attempts (int, optional) – Specifies the maximum number attempts an API client will call an operation that fails with a retryable error.
retryer (Retryer, optional) – Guides how HTTP requests should be retried in case of recoverable failures.
http_client (HttpClient, optional) – The HTTP client to invoke API calls with.
use_cname (bool, optional) – If the endpoint is s CName, set this flag to true
use_path_style (bool, optional) – Allows you to enable the client to use path-style addressing, i.e., https://oss-cn-hangzhou.aliyuncs.com/bucket/key.
signature_version (str, optional) – The signature version when signing requests. Valid values v4, v1
disable_ssl (bool, optional) – Forces the endpoint to be resolved as HTTP.
insecure_skip_verify (bool, optional) – Skip server certificate verification.
enabled_redirect (bool, optional) – Enable http redirect or not. Default is disable
use_dualstack_endpoint (bool, optional) – Dual-stack endpoints are provided in some regions. This allows an IPv4 client and an IPv6 client to access a bucket by using the same endpoint. Set this to True to use a dual-stack endpoint for the requests.
use_accelerate_endpoint (bool, optional) – OSS provides the transfer acceleration feature to accelerate date transfers of data uploads and downloads across countries and regions. Set this to True to use a accelerate endpoint for the requests.
use_internal_endpoint (bool, optional) – You can use an internal endpoint to communicate between Alibaba Cloud services located within the same region over the internal network. You are not charged for the traffic generated over the internal network. Set this to True to use a internal endpoint for the requests.
proxy_host – (str, optional): The proxy setting.
disable_upload_crc64_check – (bool, optional): Check data integrity of uploads via the crc64 by default. This feature takes effect for put_object, append_object, upload_part, uploader.upload_from and uploader.upload_file Set this to true to disable this feature.
disable_download_crc64_check – (bool, optional): Check data integrity of uploads via the crc64 by default. This feature only takes effect for downloader.download_file, get_object_to_file. Set this to true to disable this feature.
additional_headers – (List[str], optional): Additional signable headers.
user_agent – (str, optional): The optional user specific identifier appended to the User-Agent header.

alibabacloud_oss_v2.config.load_default() → Config[source]¶: Using the SDK’s default configuration

alibabacloud_oss_v2.crc module¶

crc utils

class alibabacloud_oss_v2.crc.Crc64(init_crc: int)[source]¶

Bases: object

Compute a CRC based on the ECMA-182 standard.

Create a new crc64 hash instance.

static combine(crc1, crc2, size) → int[source]¶

Parameters:

crc1 (_type_) – _description_
crc2 (_type_) – _description_
size (_type_) – _description_

Returns:

_description_

Return type:

int

digest()[source]¶: Return the digest of the bytes passed to the update() method so far.

hexdigest()[source]¶: Return digest() as hexadecimal string.

reset()[source]¶: Resets the hash object to its initial state.

sum64()[source]¶: Return CRC64 value as int.

update(data) → None[source]¶: Update the current CRC value using the string specified as the data parameter.

write(data: bytes)[source]¶: Update the current CRC value using the string specified as the data parameter.

alibabacloud_oss_v2.crc.gf2_matrix_square(square, mat)[source]¶

alibabacloud_oss_v2.crc.gf2_matrix_times(mat, vec)[source]¶

alibabacloud_oss_v2.crc.mkCombineFun(poly, initCrc=-1, rev=True, xorOut=0)[source]¶

alibabacloud_oss_v2.defaults module¶

alibabacloud_oss_v2.downloader module¶

Downloader for handling objects for downloads.

class alibabacloud_oss_v2.downloader.DownloadAPIClient[source]¶

Bases: ABC

Abstract base class for downloader client.

abstract get_object(request: GetObjectRequest, **kwargs) → GetObjectResult[source]¶: Queries an object. To call this operation, you must have read permissions on the object.

abstract head_object(request: HeadObjectRequest, **kwargs) → HeadObjectResult[source]¶: Queries information about the object in a bucket.

exception alibabacloud_oss_v2.downloader.DownloadError(**kwargs)[source]¶

Bases: BaseError

Download Error.

fmt = 'download failed, {path}, {error}.'¶

unwrap() → Exception[source]¶: returns the detail error

class alibabacloud_oss_v2.downloader.DownloadResult(written: int | None)[source]¶

Bases: object

download result

class alibabacloud_oss_v2.downloader.Downloader(client: DownloadAPIClient, **kwargs: Any)[source]¶

Bases: object

Downloader for handling objects for downloads.

client (DownloadAPIClient): A agent that implements the HeadObject and GetObject api. downloader_options (DownloaderOptions, optional): optional.

download_file(request: GetObjectRequest, filepath: str, **kwargs: Any) → DownloadResult[source]¶

download file

Parameters:

request (models.GetObjectRequest) – _description_
file_path (str) – _description_

Returns:

_description_

Return type:

DownloadResult

download_to(request: GetObjectRequest, writer: IO[bytes], **kwargs: Any) → DownloadResult[source]¶

download to

Parameters:

request (models.GetObjectRequest) – _description_
writer (IO[bytes]) – _description_
options (Optional[DownloaderOptions], optional) – _description_. Defaults to None.

Returns:

_description_

Return type:

DownloadResult

Bases: object

downloader options

alibabacloud_oss_v2.encryption_client module¶

Encryption Client

class alibabacloud_oss_v2.encryption_client.EncryptionClient(client: Client, master_cipher: MasterCipher, decrypt_master_ciphers: List[MasterCipher] | None = None)[source]¶

Bases: object

Encryption Client

abort_multipart_upload(request: AbortMultipartUploadRequest, **kwargs) → AbortMultipartUploadResult[source]¶

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

Parameters:: request (AbortMultipartUploadRequest) – Request parameters for AbortMultipartUpload operation.
Returns:: Reponse result for AbortMultipartUpload operation.
Return type:: AbortMultipartUploadResult

complete_multipart_upload(request: CompleteMultipartUploadRequest, **kwargs) → CompleteMultipartUploadResult[source]¶

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:: Reponse result for CompleteMultipartUpload operation.
Return type:: CompleteMultipartUploadResult

get_object(request: GetObjectRequest, **kwargs) → GetObjectResult[source]¶

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

Parameters:: request (GetObjectRequest) – Request parameters for GetObject operation.
Returns:: Reponse result for GetObject operation.
Return type:: GetObjectResult

head_object(request: HeadObjectRequest, **kwargs) → HeadObjectResult[source]¶

Queries information about the object in a bucket.

Parameters:: request (HeadObjectRequest) – Request parameters for HeadObject operation.
Returns:: Reponse result for HeadObject operation.
Return type:: HeadObjectResult

initiate_multipart_upload(request: InitiateMultipartUploadRequest, **kwargs) → InitiateMultipartUploadResult[source]¶

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:: Reponse result for InitiateMultipartUpload operation.
Return type:: InitiateMultipartUploadResult

list_parts(request: ListPartsRequest, **kwargs) → ListPartsResult[source]¶

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

Parameters:: request (ListPartsRequest) – Request parameters for ListParts operation.
Returns:: Reponse result for ListParts operation.
Return type:: ListPartsResult

put_object(request: PutObjectRequest, **kwargs) → PutObjectResult[source]¶

Uploads objects.

Parameters:: request (PutObjectRequest) – Request parameters for PutObject operation.
Returns:: Reponse result for PutObject operation.
Return type:: PutObjectResult

unwrap() → Client[source]¶

Returns:: _description_
Return type:: Client

upload_part(request: UploadPartRequest, **kwargs) → UploadPartResult[source]¶

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:: Reponse result for UploadPart operation.
Return type:: UploadPartResult

class alibabacloud_oss_v2.encryption_client.EncryptionMultiPartContext(content_cipher: ContentCipher, data_size: int, part_size: int)[source]¶

Bases: object

EncryptionMultiPartContext save encryption or decryption information

is_valid() → bool[source]¶: is valid

alibabacloud_oss_v2.endpoints module¶

alibabacloud_oss_v2.endpoints.add_scheme(endpoint: str, disable_ssl: bool) → str[source]¶: Add scheme to endpoint if not exist

alibabacloud_oss_v2.endpoints.from_region(region: str, disable_ssl: bool, etype: str) → str[source]¶: builds endpoint from region, ssl and endpoint type

alibabacloud_oss_v2.endpoints.is_ip(hostname: str)[source]¶: Check whether the host name is an IP address.

alibabacloud_oss_v2.exceptions module¶

exception information

exception alibabacloud_oss_v2.exceptions.BaseError(**kwargs)[source]¶

Bases: Exception

The base exception class for oss sdk exceptions.

Variables:: msg – The descriptive message associated with the error.

fmt = 'An unspecified error occurred'¶

exception alibabacloud_oss_v2.exceptions.BucketNameInvalidError(**kwargs)[source]¶

Bases: BaseError

Param Invalid Error.

fmt = 'Bucket name is invalid, got {name}.'¶

exception alibabacloud_oss_v2.exceptions.CredentialsBaseError(**kwargs)[source]¶

Bases: BaseError

The base exception class for oss sdk exceptions.

exception alibabacloud_oss_v2.exceptions.CredentialsEmptyError(**kwargs)[source]¶

Bases: CredentialsBaseError

The access key or access key secret associated with a credentials is not exist.

fmt = 'Credentials is null or empty'¶

exception alibabacloud_oss_v2.exceptions.CredentialsFetchError(**kwargs)[source]¶

Bases: CredentialsBaseError

Fetch Credentials error.

fmt = 'Fetch Credentials raised an exception: {error}'¶

exception alibabacloud_oss_v2.exceptions.DeserializationError(**kwargs)[source]¶

Bases: BaseError

Raised if an error is encountered during deserialization.

fmt = 'Deserialization raised an exception: {error}'¶

exception alibabacloud_oss_v2.exceptions.FileNotExist(**kwargs)[source]¶

Bases: BaseError

File not exists.

fmt = 'File not exists, {filepath}'¶

exception alibabacloud_oss_v2.exceptions.FileNotReadable(**kwargs)[source]¶

Bases: BaseError

File is not readable.

fmt = 'File is not readable, {filepath}'¶

exception alibabacloud_oss_v2.exceptions.InconsistentError(**kwargs)[source]¶

Bases: BaseError

crc check Error.

fmt = 'crc is inconsistent, client {client_crc}, server {server_crc}'¶

exception alibabacloud_oss_v2.exceptions.MD5UnavailableError(**kwargs)[source]¶

Bases: BaseError

MD5 Unavailable Error.

fmt = 'This system does not support MD5 generation.'¶

exception alibabacloud_oss_v2.exceptions.ObjectNameInvalidError(**kwargs)[source]¶

Bases: BaseError

Param Invalid Error.

fmt = 'Object name is invalid.'¶

exception alibabacloud_oss_v2.exceptions.OperationError(**kwargs)[source]¶

Bases: BaseError

Operation Error.

fmt = 'operation error {name}: {error}.'¶

unwrap() → Exception[source]¶: returns the detail error

exception alibabacloud_oss_v2.exceptions.ParamInvalidError(**kwargs)[source]¶

Bases: BaseError

Param Invalid Error.

fmt = 'invalid field, {field}.'¶

exception alibabacloud_oss_v2.exceptions.ParamNullError(**kwargs)[source]¶

Bases: BaseError

Param Null Error.

fmt = 'null field, {field}.'¶

exception alibabacloud_oss_v2.exceptions.ParamNullOrEmptyError(**kwargs)[source]¶

Bases: BaseError

Param Null or Empty Error.

fmt = 'null or empty field, {field}.'¶

exception alibabacloud_oss_v2.exceptions.ParamRequiredError(**kwargs)[source]¶

Bases: BaseError

Param Required Error.

fmt = 'missing required field, {field}.'¶

exception alibabacloud_oss_v2.exceptions.PresignExpirationError(**kwargs)[source]¶

Bases: BaseError

Presign Expiration Error.

fmt = 'expires should be not greater than 604800(seven days)'¶

exception alibabacloud_oss_v2.exceptions.RequestError(**kwargs)[source]¶

Bases: BaseError

An error occurred while attempt to make a request to the service. No request was sent.

fmt = 'request error: {error}.'¶

unwrap() → Exception[source]¶: returns the detail error

exception alibabacloud_oss_v2.exceptions.ResponseError(**kwargs)[source]¶

Bases: BaseError

The request was sent, but the client failed to understand the response. The connection may have timed out. These errors can be retried for idempotent or safe operations

fmt = 'response error: {error}.'¶

unwrap() → Exception[source]¶: returns the detail error

exception alibabacloud_oss_v2.exceptions.ResponseNotReadError(**kwargs)[source]¶

Bases: BaseError

Response Not ReadError.

fmt = 'You have not read in the bytes for the response. Call .read() on the response first.'¶

exception alibabacloud_oss_v2.exceptions.SerializationError(**kwargs)[source]¶

Bases: BaseError

Raised if an error is encountered during serialization.

fmt = 'Serialization raised an exception: {error}'¶

exception alibabacloud_oss_v2.exceptions.ServiceError(**kwargs)[source]¶

Bases: BaseError

The exception class for error from oss service.

fmt = 'Error returned by Service.\n Http Status Code: {status_code}.\n Error Code: {code}.\n Request Id: {request_id}.\n Message: {message}.\n EC: {ec}.\n Timestamp: {timestamp}.\n Request Endpoint: {request_target}.'¶

exception alibabacloud_oss_v2.exceptions.StreamClosedError(**kwargs)[source]¶

Bases: BaseError

Stream Closed Error.

fmt = 'The content for response can no longer be read or streamed.'¶

exception alibabacloud_oss_v2.exceptions.StreamConsumedError(**kwargs)[source]¶

Bases: BaseError

Stream Consumed Error.

fmt = 'You have likely already consumed this stream, so it can not be accessed anymore.'¶

alibabacloud_oss_v2.filelike module¶

class alibabacloud_oss_v2.filelike.AppendFileAPIClient[source]¶

Bases: ABC

Abstract base class for append file client.

abstract append_object(request: AppendObjectRequest, **kwargs) → AppendObjectResult[source]¶: Uploads an object by appending the object to an existing object. Objects created by using the AppendObject operation are appendable objects.

abstract head_object(request: HeadObjectRequest, **kwargs) → HeadObjectResult[source]¶: Queries information about the object in a bucket.

class alibabacloud_oss_v2.filelike.AppendOnlyFile(client: AppendFileAPIClient, bucket: str, key: str, request_payer: str | None = None, create_parameter: AppendObjectRequest | None = None)[source]¶

Bases: object

AppendOnlyFile opens or creates the named file for appending

client (AppendFileAPIClient, required): A agent that sends the request. bucket (str, required): The name of the bucket. key (str, required): The name of the object. request_payer (str, optional): To indicate that the requester is aware that the request and data download will incur costs create_parameter (AppendObjectRequest, optional): The parameters when the object is first generated, supports below

CacheControl, ContentEncoding, Expires, ContentType, ContentType, Metadata,SSE’s parameters, Acl, StorageClass, Tagging. If the object exists, ignore this parameters

close() → None[source]¶: Close the file.

property closed: bool¶: True if the file descriptor will be closed by close().

flush() → None[source]¶: Flush write buffers.

property mode: str¶: String giving the file mode

property name: str¶: String giving the file in oss path

tell() → int[source]¶: Return an int indicating the current stream position.

writable() → bool[source]¶: True if file was opened in a write mode.

write(b)[source]¶: Write bytes b to file, return number written.

write_from(b: str | bytes | Iterable[bytes] | IO[str] | IO[bytes])[source]¶: Write any data to file, return number written.

exception alibabacloud_oss_v2.filelike.CancelTask[source]¶

Bases: Exception

Exception raised by cancel prefetch task.

class alibabacloud_oss_v2.filelike.OpenFileAPIClient[source]¶

Bases: ABC

Abstract base class for open file client.

abstract get_object(request: GetObjectRequest, **kwargs) → GetObjectResult[source]¶: Queries an object. To call this operation, you must have read permissions on the object.

abstract head_object(request: HeadObjectRequest, **kwargs) → HeadObjectResult[source]¶: Queries information about the object in a bucket.

exception alibabacloud_oss_v2.filelike.PathError(**kwargs)[source]¶

Bases: BaseError

PathError records an error and the operation and file path that caused it.

fmt = 'path error {op} {path}: {error}.'¶

unwrap() → Exception[source]¶: returns the detail error

class alibabacloud_oss_v2.filelike.ReadOnlyFile(client: OpenFileAPIClient, bucket: str, key: str, version_id: str | None = None, request_payer: str | None = None, **kwargs)[source]¶

Bases: object

ReadOnlyFile opens the named file for reading.

client (OpenFileAPIClient, required): A agent that sends the request. 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 object. request_payer (str, optional): To indicate that the requester is aware that the request and data download will incur costs

close() → None[source]¶: Close the file.

property closed: bool¶: True if the file descriptor will be closed by close().

property mode: str¶: String giving the file mode

property name: str¶: String giving the file in oss path

read(n=None)[source]¶: Read and return up to n bytes, where n is an int. Return an empty bytes object at EOF.

readable()[source]¶: True if file was opened in a read mode.

readall()[source]¶: Read until EOF

readinto(b)[source]¶: Read bytes into a pre-allocated bytes-like object b. Returns an int representing the number of bytes read (0 for EOF)

seek(pos, whence=0)[source]¶

Move to new file position.

Argument offset is a byte count. Optional argument whence defaults to SEEK_SET or 0 (offset from start of file, offset should be >= 0); other values are SEEK_CUR or 1 (move relative to current position, positive or negative), and SEEK_END or 2 (move relative to end of file, usually negative, although many platforms allow seeking beyond the end of a file).

seekable()[source]¶: True if file supports random-access.

tell()[source]¶: Return an int indicating the current stream position.

alibabacloud_oss_v2.io_utils module¶

utils for stream wrapper

class alibabacloud_oss_v2.io_utils.LimitReader(reader: IO[bytes], n: int)[source]¶

Bases: object

limit reader information

read(n: int = -1) → AnyStr[source]¶: read data

class alibabacloud_oss_v2.io_utils.ReadAtReader(reader: IO[bytes])[source]¶

Bases: object

A IO that implements read_at

close() → None[source]¶

property closed: bool¶

fileno() → int[source]¶: file no

flush() → None[source]¶

isatty() → bool[source]¶: is atty

property mode: str¶

property name: str¶

read(n: int = -1) → AnyStr[source]¶

read_at(off: int, n: int = -1) → AnyStr[source]¶: read at

readable() → bool[source]¶: read able

readline(limit: int = -1) → AnyStr[source]¶: read line

readlines(hint: int = -1) → List[source]¶: read lines

seek(offset: int, whence: int = 0) → int[source]¶

seekable() → bool[source]¶: seek able

tell() → int[source]¶

class alibabacloud_oss_v2.io_utils.SectionReader(reader: ReadAtReader, off: int, n: int)[source]¶

Bases: object

A SectionReader that reads from r starting at offset off and stops with EOF after n bytes

read(n: int = -1) → AnyStr[source]¶

read_at(off: int, n: int = -1) → AnyStr[source]¶: read at

readable() → bool[source]¶: read able

seek(offset: int, whence: int = 0) → int[source]¶

seekable() → bool[source]¶: seek able

tell() → int[source]¶

class alibabacloud_oss_v2.io_utils.StreamBodyDiscarder(stream: StreamBody, discard: int)[source]¶

Bases: StreamBody

stream body discarder information

close() → None[source]¶: 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.

iter_bytes(**kwargs: Any) → Iterator[bytes][source]¶

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

Returns:: An iterator of bytes from the stream
Return type:: Iterator[str]

read() → bytes[source]¶

Read the stream’s bytes.

Returns:: The read in bytes
Return type:: bytes

class alibabacloud_oss_v2.io_utils.StreamBodyReader(response: HttpResponse)[source]¶

Bases: StreamBody

A StreamBodyReader that convert HttpResponse type to StreamBody type.

close() → None[source]¶: 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.

iter_bytes(**kwargs: Any) → Iterator[bytes][source]¶

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

Returns:: An iterator of bytes from the stream
Return type:: Iterator[str]

read() → bytes[source]¶

Read the stream’s bytes.

Returns:: The read in bytes
Return type:: bytes

class alibabacloud_oss_v2.io_utils.TeeIterator[source]¶

Bases: object

A Iterator that writes to w what it reads from source

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

Converts source to TeeIterator

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 Iterator that writes to w what it reads from source

Return type:

TeeIterator

reset() → None[source]¶: Resets the buffer to the marked position. The marked position

seekable()[source]¶: Is there a file pointer offset

alibabacloud_oss_v2.io_utils.is_seekable_io(fileobj)[source]¶: is seekable io

alibabacloud_oss_v2.io_utils.rename_file(current_filename, new_filename)[source]¶

alibabacloud_oss_v2.paginator module¶

Paginator for list operation.

class alibabacloud_oss_v2.paginator.ListBucketsAPIClient[source]¶

Bases: ABC

Abstract base class for list_buckets client.

abstract list_buckets(request: ListBucketsRequest, **kwargs) → ListBucketsResult[source]¶: Lists all buckets that belong to your Alibaba Cloud account.

class alibabacloud_oss_v2.paginator.ListBucketsPaginator(client: ListBucketsAPIClient, **kwargs: Any)[source]¶

Bases: object

A paginator for ListBuckets

client (ListBucketsAPIClient): A agent that sends the request. limit (int, optional): The maximum number of items in the response.

iter_page(request: ListBucketsRequest, **kwargs: Any) → Iterator[ListBucketsResult][source]¶

Iterates over the buckets.

Parameters:

request (models.ListBucketsRequest) – The request for the ListBuckets operation.
limit (int, optional) – The maximum number of items in the response.

Yields:

Iterator[models.ListBucketsResult] – An iterator of ListBucketsResult from the response

class alibabacloud_oss_v2.paginator.ListMultipartUploadsAPIClient[source]¶

Bases: ABC

Abstract base class for list_multipart_uploads client.

abstract list_multipart_uploads(request: ListMultipartUploadsRequest, **kwargs) → ListMultipartUploadsResult[source]¶: Lists all multipart upload tasks in progress. The tasks are not completed or canceled.

class alibabacloud_oss_v2.paginator.ListMultipartUploadsPaginator(client: ListMultipartUploadsAPIClient, **kwargs: Any)[source]¶

Bases: object

A paginator for ListMultipartUploads

client (ListMultipartUploadsAPIClient): A agent that sends the request. limit (int, optional): The maximum number of items in the response.

iter_page(request: ListMultipartUploadsRequest, **kwargs: Any) → Iterator[ListMultipartUploadsResult][source]¶

Iterates over the objects.

Parameters:

request (models.ListMultipartUploadsRequest) – The request for the ListMultipartUploads operation.
limit (int, optional) – The maximum number of items in the response.

Yields:

Iterator[models.ListMultipartUploadsResult] – An iterator of ListMultipartUploadsResult from the response

class alibabacloud_oss_v2.paginator.ListObjectVersionsAPIClient[source]¶

Bases: ABC

Abstract base class for list_object_versions client.

abstract list_object_versions(request: ListObjectVersionsRequest, **kwargs) → ListObjectVersionsResult[source]¶: Lists the versions of all objects in a bucket, including delete markers.

class alibabacloud_oss_v2.paginator.ListObjectVersionsPaginator(client: ListObjectVersionsAPIClient, **kwargs: Any)[source]¶

Bases: object

A paginator for ListObjectVersions

client (ListObjectVersionsAPIClient): A agent that sends the request. limit (int, optional): The maximum number of items in the response.

iter_page(request: ListObjectVersionsRequest, **kwargs: Any) → Iterator[ListObjectVersionsResult][source]¶

Iterates over the object versions.

Parameters:

request (models.ListObjectVersionsRequest) – The request for the ListObjectVersions operation.
limit (int, optional) – The maximum number of items in the response.

Yields:

Iterator[models.ListObjectVersionsResult] – An iterator of ListObjectVersionsResult from the response

class alibabacloud_oss_v2.paginator.ListObjectsAPIClient[source]¶

Bases: ABC

Abstract base class for list_objects client.

abstract list_objects(request: ListObjectsRequest, **kwargs) → ListObjectsResult[source]¶: Lists information about all objects in an Object Storage Service (OSS) bucket.

class alibabacloud_oss_v2.paginator.ListObjectsPaginator(client: ListObjectsAPIClient, **kwargs: Any)[source]¶

Bases: object

A paginator for ListObjects

client (ListObjectsAPIClient): A agent that sends the request. limit (int, optional): The maximum number of items in the response.

iter_page(request: ListObjectsRequest, **kwargs: Any) → Iterator[ListObjectsResult][source]¶

Iterates over the objects.

Parameters:

request (models.ListObjectsRequest) – The request for the ListObjects operation.
limit (int, optional) – The maximum number of items in the response.

Yields:

Iterator[models.ListObjectsResult] – An iterator of ListObjectsResult from the response

class alibabacloud_oss_v2.paginator.ListObjectsV2APIClient[source]¶

Bases: ABC

Abstract base class for list_objects_v2 client.

abstract list_objects_v2(request: ListObjectsV2Request, **kwargs) → ListObjectsV2Result[source]¶: Lists information about all objects in an Object Storage Service (OSS) bucket.

class alibabacloud_oss_v2.paginator.ListObjectsV2Paginator(client: ListObjectsV2APIClient, **kwargs: Any)[source]¶

Bases: object

A paginator for ListObjectsV2

client (ListObjectsV2APIClient): A agent that sends the request. limit (int, optional): The maximum number of items in the response.

iter_page(request: ListObjectsV2Request, **kwargs: Any) → Iterator[ListObjectsV2Result][source]¶

Iterates over the objects with v2.

Parameters:

request (models.ListObjectsV2Request) – The request for the ListObjectsV2 operation.
limit (int, optional) – The maximum number of items in the response.

Yields:

Iterator[models.ListObjectsV2Result] – An iterator of ListObjectsV2Result from the response

class alibabacloud_oss_v2.paginator.ListPartsAPIClient[source]¶

Bases: ABC

Abstract base class for list_parts client.

abstract list_parts(request: ListPartsRequest, **kwargs) → ListPartsResult[source]¶: Lists all parts that are uploaded by using a specified upload ID.

class alibabacloud_oss_v2.paginator.ListPartsPaginator(client: ListPartsAPIClient, **kwargs: Any)[source]¶

Bases: object

A paginator for ListParts

client (_SyncClientImpl): A agent that sends the request. limit (int, optional): The maximum number of items in the response.

iter_page(request: ListPartsRequest, **kwargs: Any) → Iterator[ListPartsResult][source]¶

Iterates over the parts.

Parameters:

request (models.ListPartsRequest) – The request for the ListParts operation.
limit (int, optional) – The maximum number of items in the response.

Yields:

Iterator[models.ListPartsResult] – An iterator of ListPartsResult from the response

alibabacloud_oss_v2.presigner module¶

APIs for presign operation.

class alibabacloud_oss_v2.presigner.PresignResult(method: str | None = None, url: str | None = None, expiration: datetime | None = None, signed_headers: MutableMapping | None = None)[source]¶

Bases: object

The result for the presign operation.

Parameters:

method (str, optional) – The HTTP method, which corresponds to the operation. For example, the HTTP method of the GetObject operation is GET.
url (str, optional) – The pre-signed URL.
expiration (datetime.datetime, optional) – The time when the pre-signed URL expires.
signed_headers (MutableMapping, optional) – The request headers specified in the request. For example, if Content-Type is specified for PutObject, Content-Type is returned.

presign synchronously

Parameters:

client (_SyncClientImpl) – A agent that sends the request.
request (PresignRequest) – The request for the Presign operation.
expires (datetime.timedelta, optional) – The expiration duration for the generated presign url.
expiration (datetime.datetime, optional) – The expiration time for the generated presign url.

Returns:

The result for the Presign operation.

Return type:

PresignResult

alibabacloud_oss_v2.progress module¶

Progress for upload, download and copy

class alibabacloud_oss_v2.progress.Progress(progress_fn, total: int | None)[source]¶

Bases: object

reset()[source]¶

write(s: bytes)[source]¶

alibabacloud_oss_v2.serde module¶

Serializer & Deserializer for models

class alibabacloud_oss_v2.serde.Model(**kwargs: Any)[source]¶

Bases: object

Mixin for all client request body/response body models to support serialization and deserialization.

class alibabacloud_oss_v2.serde.RequestModel(**kwargs: Any)[source]¶

Bases: Model

request body models to support serialization.

class alibabacloud_oss_v2.serde.ResultModel(**kwargs: Any)[source]¶

Bases: Model

response body models to support deserialization.

alibabacloud_oss_v2.serde.copy_request(dst: RequestModel, src: RequestModel)[source]¶

copy request

Parameters:

dst (RequestModel) – _description_
src (RequestModel) – _description_

alibabacloud_oss_v2.serde.deserialize_boolean(val: str)[source]¶

Deserialize string into a boolean value

For strings, the value for True/False is case insensitive

alibabacloud_oss_v2.serde.deserialize_httptime(date_time: str) → datetime[source]¶: Deserialize http datetime formatted string into Datetime object.

alibabacloud_oss_v2.serde.deserialize_iso(date_time: str) → datetime[source]¶: Deserialize ISO-8601 formatted string into Datetime object.

alibabacloud_oss_v2.serde.deserialize_output(result: Model, op_output: OperationOutput, custom_deserializer: List[Any] | None = None) → Model[source]¶

deserialize output

Parameters:

result (Model) – _description_
op_output (OperationOutput) – _description_
custom_deserializer (Optional[List[Any]]) – _description_

Returns:

_description_

Return type:

Any

alibabacloud_oss_v2.serde.deserialize_output_discardbody(result: Model, op_output: OperationOutput) → Model[source]¶

deserialize output discardbody

Parameters:

result (Model) – _description_
op_output (OperationOutput) – _description_

Returns:

_description_

Return type:

Any

alibabacloud_oss_v2.serde.deserialize_output_headers(result: Model, op_output: OperationOutput) → Model[source]¶

deserialize output headers

Parameters:

result (Model) – _description_
op_output (OperationOutput) – _description_

Returns:

_description_

Return type:

Any

alibabacloud_oss_v2.serde.deserialize_output_xmlbody(result: Model, op_output: OperationOutput) → Model[source]¶

deserialize output xmlbody

Parameters:

result (Model) – _description_
op_output (OperationOutput) – _description_

Returns:

_description_

Return type:

Any

alibabacloud_oss_v2.serde.deserialize_unixtime(date_time: str) → datetime[source]¶: Deserialize a datetime from a POSIX timestamp into Datetime object.

alibabacloud_oss_v2.serde.deserialize_xml(xml_data: Any, obj: Any, expect_tag: str | None = None) → None[source]¶: deserialize xml

alibabacloud_oss_v2.serde.serialize_httptime(value: datetime) → str[source]¶

Serialize Datetime object into http time formatted string

Parameters:: value (datetime.datetime) – value to be serialized
Returns:: http time formatted string, e.g Thu, 15 May 2014 11:18:32 GMT
Return type:: str

alibabacloud_oss_v2.serde.serialize_input(request: Model, op_input: OperationInput, custom_serializer: List[Any] | None = None) → OperationInput[source]¶

serialize input

Parameters:

request (Model) – _description_
op_input (OperationInput) – _description_
custom_serializer (Optional[List[Any]]) – _description_

Raises:

exceptions.SerializationError – _description_
exceptions.ParamRequiredError – _description_

Returns:

_description_

Return type:

_type_

alibabacloud_oss_v2.serde.serialize_iso_date(value: datetime) → str[source]¶

Serialize Date object into ISO-8601 formatted string

Parameters:: value (datetime.datetime) – value to be serialized
Returns:: ISO-8601 formatted string, eg 2014-05-15T00:00:00.000Z
Return type:: str

alibabacloud_oss_v2.serde.serialize_isotime(value: datetime) → str[source]¶

Serialize Datetime object into ISO-8601 formatted string

Parameters:: value (datetime.datetime) – value to be serialized
Returns:: ISO-8601 formatted string, e.g 2014-05-15T11:18:32.000Z
Return type:: str

alibabacloud_oss_v2.serde.serialize_unixtime(value: datetime) → str[source]¶

Serialize Datetime object into unix time formatted string

Parameters:: value (datetime.datetime) – value to be serialized
Returns:: http time formatted string, e.g 1702743657
Return type:: str

alibabacloud_oss_v2.serde.serialize_xml(obj, root: str | None = None) → Any[source]¶

serialize xml

Parameters:

model (Model) – _description_
root (Optional[str], optional) – _description_. Defaults to None.

Returns:

_description_

Return type:

bytes

alibabacloud_oss_v2.serde_utils module¶

utils for api only

alibabacloud_oss_v2.serde_utils.add_content_md5(_: Model, op_input: OperationInput) → OperationInput[source]¶: Add content-md5 when it does not exist.

alibabacloud_oss_v2.serde_utils.add_content_type(_: Model, op_input: OperationInput) → OperationInput[source]¶: Add content-type based on the file suffix when it does not exist.

alibabacloud_oss_v2.serde_utils.add_crc_checker(_: Model, op_input: OperationInput) → OperationInput[source]¶: Add crc writer and crc checker.

alibabacloud_oss_v2.serde_utils.add_process_action(request: Model, op_input: OperationInput) → OperationInput[source]¶: Add process parameter to body.

alibabacloud_oss_v2.serde_utils.add_progress(request: Model, op_input: OperationInput) → OperationInput[source]¶: Add progress writer when progress_fn is set.

alibabacloud_oss_v2.serde_utils.deserialize_encode_type(result: Model, _: OperationOutput) → Model[source]¶: do url decode

alibabacloud_oss_v2.serde_utils.deserialize_process_body(result: Model, op_output: OperationOutput) → Model[source]¶

deserialize process body

Parameters:

result (Model) – _description_
op_output (OperationOutput) – _description_

Returns:

_description_

Return type:

Any

alibabacloud_oss_v2.serde_utils.encode_copy_source(request: CopyObjectRequest | UploadPartCopyRequest) → str[source]¶: encode copy source parameter

alibabacloud_oss_v2.serde_utils.serialize_delete_objects(request: Model, op_input: OperationInput) → OperationInput[source]¶: serialize to Delete XML string

alibabacloud_oss_v2.types module¶

Type Information

class alibabacloud_oss_v2.types.Credentials(access_key_id: str, access_key_secret: str, security_token: str | None = None, expiration: datetime | None = None)[source]¶

Bases: object

Holds the credentials needed to authenticate requests.

Parameters:

access_key_id (str) – The access key id of the credentials.
access_key_secret (str) – The access key secret of the credentials.
security_token (str) – The security token of the credentials.
expiration (datetime.datetime) – The token’s expiration time in utc.

has_keys() → bool[source]¶

Check whether the credentials keys are set.

Return type:: bool
Returns:: True if the credentials keys are set.

is_expired() → bool[source]¶

Check whether the credentials have expired.

Return type:: bool
Returns:: True if the credentials have expired.

class alibabacloud_oss_v2.types.CredentialsProvider[source]¶

Bases: ABC

Abstract base class for CredentialsProvider.

abstract get_credentials() → Credentials[source]¶

Retrieve the credentials.

Return type:: Credentials
Returns:: a Credentials instance if it successfully retrieved the value.

class alibabacloud_oss_v2.types.HttpClient[source]¶

Bases: ABC

Abstract base class for HTTP client.

abstract close() → None[source]¶: Close the session if it is not externally owned.

abstract open() → None[source]¶: Assign new session if one does not already exist.

abstract send(request: HttpRequest, **kwargs: Any) → HttpResponse[source]¶

Sends an HTTP request and returns an HTTP response.

An error is returned if caused by client policy (such as CheckRedirect), or failure to speak HTTP (such as a network connectivity problem). A non-2xx status code doesn’t cause an error.

Parameters:: request (Any) – the http request sent to server.
Return type:: httpResponse
Returns:: The response object.

Bases: object

A HttpRequest represents an HTTP request received by a server or to be sent by a client.

It should be passed to your client’s send method.

Parameters:

method (str) – HTTP method (GET, HEAD, etc.)
url (str) – The url for your request
headers (mapping) – HTTP headers you want in your request. Your input should be a mapping of header name to header value.
params (mapping) – Query parameters to be mapped into your URL. Your input should be a mapping of query name to query value(s).
body (str or bytes or iterable[bytes] or IO[str] or IO[bytes]) – The request’s body.

class alibabacloud_oss_v2.types.HttpResponse[source]¶

Bases: _HttpResponseBase

Abstract base class for a HttpResponse, the response from an HTTP request.

abstract close() → None[source]¶: close the response

abstract iter_bytes(**kwargs: Any) → Iterator[bytes][source]¶

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

Returns:: An iterator of bytes from the response
Return type:: Iterator[str]

abstract read() → bytes[source]¶

Read the response’s bytes.

Returns:: The read in bytes
Return type:: bytes

Bases: object

Operation Input

Bases: object

Operation Output

class alibabacloud_oss_v2.types.Retryer[source]¶

Bases: ABC

Abstract base class for Retryer.

abstract is_error_retryable(error: Exception) → bool[source]¶

Check whether the error is retryable.

Parameters:: error (Exception) – the error meets
Return type:: bool
Returns:: True if the error is retryable.

abstract max_attempts() → int[source]¶

Retrieve max attempts.

Return type:: int
Returns:: max attempts.

abstract retry_delay(attempt: int, error: Exception) → float[source]¶

Returns the delay that should be used before retrying the attempt.

Parameters:

attempt (int) – current retry attempt
error (Exception) – the error meets

Return type:

float

Returns:

delay duration in second.

class alibabacloud_oss_v2.types.Signer[source]¶

Bases: ABC

Abstract base class for Signer.

abstract sign(signing_ctx: SigningContext) → None[source]¶

sign HTTP requests.

Parameters:: signing_ctx (SigningContext) – the signing context

Bases: object

SigningContext is the signing context.

class alibabacloud_oss_v2.types.StreamBody[source]¶

Bases: ABC

Abstract base class for a StreamBody.

abstract close() → None[source]¶: close the stream

abstract property content: bytes¶

Content of the stream, in bytes.

Return type:: bytes
Returns:: The stream’s content in bytes.

abstract property is_closed: bool¶

Whether the stream has been closed yet.

Return type:: bool
Returns:: Whether the stream has been closed yet.

abstract property is_stream_consumed: bool¶

Whether the stream has been consumed.

Return type:: bool
Returns:: Whether the stream has been consumed.

abstract iter_bytes(**kwargs: Any) → Iterator[bytes][source]¶

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

Returns:: An iterator of bytes from the stream
Return type:: Iterator[str]

abstract read() → bytes[source]¶

Read the stream’s bytes.

Returns:: The read in bytes
Return type:: bytes

alibabacloud_oss_v2.uploader module¶

Uploader for handling objects for uploads.

class alibabacloud_oss_v2.uploader.UploadAPIClient[source]¶

Bases: ABC

Abstract base class for uploader client.

abstract abort_multipart_upload(request: AbortMultipartUploadRequest, **kwargs) → AbortMultipartUploadResult[source]¶: Cancels a multipart upload task and deletes the parts uploaded in the task.

abstract complete_multipart_upload(request: CompleteMultipartUploadRequest, **kwargs) → CompleteMultipartUploadResult[source]¶: Completes the multipart upload task of an object after all parts of the object are uploaded.

abstract head_object(request: HeadObjectRequest, **kwargs) → HeadObjectResult[source]¶: Queries information about the object in a bucket.

abstract initiate_multipart_upload(request: InitiateMultipartUploadRequest, **kwargs) → InitiateMultipartUploadResult[source]¶: Initiates a multipart upload task before you can upload data in parts to Object Storage Service (OSS).

abstract list_parts(request: ListPartsRequest, **kwargs) → ListPartsResult[source]¶: Lists all parts that are uploaded by using a specified upload ID.

abstract put_object(request: PutObjectRequest, **kwargs) → PutObjectResult[source]¶: Uploads objects.

abstract upload_part(request: UploadPartRequest, **kwargs) → UploadPartResult[source]¶: Call the UploadPart interface to upload data in blocks (parts) based on the specified Object name and uploadId.

exception alibabacloud_oss_v2.uploader.UploadError(**kwargs)[source]¶

Bases: BaseError

Upload Error.

fmt = 'upload failed, {upload_id}, {path}, {error}.'¶

unwrap() → Exception[source]¶: returns the detail error

class alibabacloud_oss_v2.uploader.UploadResult(upload_id: str | None = None, etag: str | None = None, version_id: str | None = None, hash_crc64: str | None = None)[source]¶

Bases: object

upload result

class alibabacloud_oss_v2.uploader.Uploader(client: UploadAPIClient, **kwargs: Any)[source]¶

Bases: object

Uploader for handling objects for uploads.

client (UploadAPIClient): A agent that implements the PutObject and Multipart Upload api.

upload_file(request: PutObjectRequest, filepath: str, **kwargs: Any) → UploadResult[source]¶

upload file

Parameters:

request (models.PutObjectRequest) – _description_
filepath (str) – _description_

Returns:

_description_

Return type:

UploadResult

upload_from(request: PutObjectRequest, reader: IO[bytes], **kwargs: Any) → UploadResult[source]¶

upload from

Parameters:

request (models.PutObjectRequest) – _description_
reader (IO[bytes]) – _description_

Returns:

_description_

Return type:

UploadResult

Bases: object

uploader options

alibabacloud_oss_v2.utils module¶

utils for sdk

alibabacloud_oss_v2.utils.ensure_boolean(val)[source]¶: Ensures a boolean value if a string or boolean is provided For strings, the value for True/False is case insensitive

alibabacloud_oss_v2.utils.escape_xml_value(s: str) → str[source]¶: escapeXml EscapeString writes to p the properly escaped XML equivalent of the plain text data s

alibabacloud_oss_v2.utils.get_default_user_agent() → str[source]¶: Returns the default user agent string

alibabacloud_oss_v2.utils.guess_content_length(body: Any) → int | None[source]¶: Guess the content length of body

alibabacloud_oss_v2.utils.guess_content_type(name: str, default: str) → str[source]¶: Guess the type of a file based on its name

alibabacloud_oss_v2.utils.is_fileobj(obj: Any) → bool[source]¶: Tests if this object has seek and tell method Returns True if it is a file object, else False

alibabacloud_oss_v2.utils.is_seekable(obj: Any) → bool[source]¶: Tests if this object supports Seek method Returns True is suppurts seek, else False

alibabacloud_oss_v2.utils.lowercase_dict(original)[source]¶: Copies the given dictionary ensuring all keys are lowercase strings.

alibabacloud_oss_v2.utils.merge_dicts(dict1, dict2, append_lists=False)[source]¶

Given two dict, merge the second dict into the first. The dicts can have arbitrary nesting.

Parameters:

dict1 (Dict) – the first dict.
dict2 (Dict) – the second dict.
append_lists (bool, optional) – If true, instead of clobbering a list with the new
value
list. (append all of the new values onto the original)

alibabacloud_oss_v2.utils.parse_content_length(headers: MutableMapping[str, str]) → int[source]¶: Parses the length from the content length header

alibabacloud_oss_v2.utils.parse_content_range(content_range: str) → Tuple[int, int, int][source]¶: Parses the content range header accepts bytes 22-33/42 and bytes 22-33/* format

alibabacloud_oss_v2.utils.parse_http_range(range_header: str) → Tuple[int, int][source]¶: Parses the range header It only accepts single ranges.

alibabacloud_oss_v2.utils.safety_bool(value: bool | None) → bool[source]¶: Returns bool value if the value is not None. Returns False if the value is None.

alibabacloud_oss_v2.utils.safety_int(value: int | None) → int[source]¶: Returns int value if the value is not None. Returns 0 if the value is None.

alibabacloud_oss_v2.utils.safety_str(value: str | None) → str[source]¶: Returns str value if the value is not None. Returns a emtpy str if the value is None.

alibabacloud_oss_v2.validation module¶

validation for sdk

alibabacloud_oss_v2.validation.is_valid_bucket_name(name: str) → bool[source]¶: Checks if the name is valid

alibabacloud_oss_v2.validation.is_valid_endpoint(endpoint: str)[source]¶: Checks if the endpoint is valid

alibabacloud_oss_v2.validation.is_valid_object_name(name: str) → bool[source]¶: Checks if the name is valid

alibabacloud_oss_v2.validation.is_valid_range(value: str) → bool[source]¶: Checks if the range is valid

alibabacloud_oss_v2.validation.is_valid_region(region: str)[source]¶: Checks if the region is valid

alibabacloud_oss_v2 package¶

Subpackages¶

Submodules¶

alibabacloud_oss_v2.checkpoint module¶

alibabacloud_oss_v2.client module¶

alibabacloud_oss_v2.config module¶

alibabacloud_oss_v2.crc module¶

alibabacloud_oss_v2.defaults module¶

alibabacloud_oss_v2.downloader module¶

alibabacloud_oss_v2.encryption_client module¶

alibabacloud_oss_v2.endpoints module¶

alibabacloud_oss_v2.exceptions module¶

alibabacloud_oss_v2.filelike module¶

alibabacloud_oss_v2.io_utils module¶

alibabacloud_oss_v2.paginator module¶

alibabacloud_oss_v2.presigner module¶

alibabacloud_oss_v2.progress module¶

alibabacloud_oss_v2.serde module¶

alibabacloud_oss_v2.serde_utils module¶

alibabacloud_oss_v2.types module¶

alibabacloud_oss_v2.uploader module¶

alibabacloud_oss_v2.utils module¶

alibabacloud_oss_v2.validation module¶

Module contents¶

Table of Contents

This Page