alibabacloud_oss_v2.models package

Submodules

alibabacloud_oss_v2.models.access_point module

class alibabacloud_oss_v2.models.access_point.AccessPoint(network_origin: str | None = None, vpc_configuration: AccessPointVpcConfiguration | None = None, status: str | None = None, bucket: str | None = None, access_point_name: str | None = None, alias: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the information about an access point.

network_origin (str, optional): The network origin of the access point. vpc_configuration (AccessPointVpcConfiguration, optional): The container that stores the information about the VPC. status (str, optional): The status of the access point. bucket (str, optional): The name of the bucket for which the access point is configured. access_point_name (str, optional): The name of the access point. alias (str, optional): The alias of the access point.

class alibabacloud_oss_v2.models.access_point.AccessPointVpcConfiguration(vpc_id: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the information about the VPC.

vpc_id (str, optional): The ID of the VPC that is required only when the NetworkOrigin parameter is set to vpc.

class alibabacloud_oss_v2.models.access_point.CreateAccessPointConfiguration(access_point_name: str | None = None, network_origin: str | None = None, vpc_configuration: AccessPointVpcConfiguration | None = None, **kwargs: Any)

Bases: Model

The container that stores the information about an access point.

access_point_name (str, optional): The name of the access point. The name of the access point must meet the following naming rules:* The name must be unique in a region of your Alibaba Cloud account.* The name cannot end with -ossalias.* The name can contain only lowercase letters, digits, and hyphens (-). It cannot start or end with a hyphen (-).* The name must be 3 to 19 characters in length. network_origin (str, optional): The network origin of the access point. vpc_configuration (AccessPointVpcConfiguration, optional): The container that stores the information about the VPC.

class alibabacloud_oss_v2.models.access_point.CreateAccessPointRequest(bucket: str = None, create_access_point_configuration: CreateAccessPointConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the CreateAccessPoint operation.

bucket (str, required): The name of the bucket. create_access_point_configuration (CreateAccessPointConfiguration, optional): The container of the request body.

class alibabacloud_oss_v2.models.access_point.CreateAccessPointResult(access_point_arn: str | None = None, alias: str | None = None, **kwargs: Any)

Bases: ResultModel

The request for the CreateAccessPoint operation.

access_point_arn (str, optional): The Alibaba Cloud Resource Name (ARN) of the access point. alias (str, optional): The alias of the access point.

class alibabacloud_oss_v2.models.access_point.DeleteAccessPointPolicyRequest(bucket: str = None, access_point_name: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteAccessPointPolicy operation.

bucket (str, required): The name of the bucket. access_point_name (str, required): The name of the access point.

class alibabacloud_oss_v2.models.access_point.DeleteAccessPointPolicyResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteAccessPointPolicy operation.

class alibabacloud_oss_v2.models.access_point.DeleteAccessPointRequest(bucket: str = None, access_point_name: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteAccessPoint operation.

bucket (str, required): The name of the bucket. access_point_name (str, required): The name of the access point.

class alibabacloud_oss_v2.models.access_point.DeleteAccessPointResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteAccessPoint operation.

class alibabacloud_oss_v2.models.access_point.Endpoints(public_endpoint: str | None = None, internal_endpoint: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the network origin information about the access point.

public_endpoint (str, optional): The public endpoint of the access point. internal_endpoint (str, optional): 接入点的内网Endpoint。

class alibabacloud_oss_v2.models.access_point.GetAccessPointPolicyRequest(bucket: str = None, access_point_name: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetAccessPointPolicy operation.

bucket (str, required): The name of the bucket. access_point_name (str, required): The name of the access point.

class alibabacloud_oss_v2.models.access_point.GetAccessPointPolicyResult(body: str | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetAccessPointPolicy operation.

body (io.ReadCloser, optional): <no value>

class alibabacloud_oss_v2.models.access_point.GetAccessPointRequest(bucket: str = None, access_point_name: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetAccessPoint operation.

bucket (str, required): The name of the bucket. access_point_name (str, required): The name of the access point.

class alibabacloud_oss_v2.models.access_point.GetAccessPointResult(account_id: str | None = None, network_origin: str | None = None, access_point_arn: str | None = None, status: str | None = None, creation_date: str | None = None, access_point_name: str | None = None, bucket: str | None = None, endpoints: Endpoints | None = None, public_access_block_configuration: PublicAccessBlockConfiguration | None = None, vpc_configuration: AccessPointVpcConfiguration | None = None, alias: str | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetAccessPoint operation.

account_id (str, optional): The ID of the Alibaba Cloud account for which the access point is configured. network_origin (str, optional): The network origin of the access point. Valid values: vpc and internet. vpc: You can only use the specified VPC ID to access the access point. internet: You can use public endpoints and internal endpoints to access the access point. access_point_arn (str, optional): The ARN of the access point. status (str, optional): The status of the access point. creation_date (str, optional): 接入点创建时间。 access_point_name (str, optional): The name of the access point. bucket (str, optional): The name of the bucket for which the access point is configured. endpoints (Endpoints, optional): The container that stores the network origin information about the access point. public_access_block_configuration (PublicAccessBlockConfiguration, optional): 保存接入点阻止公共访问的配置 vpc_configuration (AccessPointVpcConfiguration, optional): The container that stores the information about the VPC. alias (str, optional): The alias of the access point.

class alibabacloud_oss_v2.models.access_point.ListAccessPointsRequest(bucket: str = None, max_keys: int | None = None, continuation_token: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ListAccessPoints operation.

bucket (str, required): The name of the bucket. max_keys (int, optional): The maximum number of access points that can be returned. Valid values:* For user-level access points: (0,1000].* For bucket-level access points: (0,100]. continuation_token (str, optional): The token from which the listing operation starts. You must specify the value of NextContinuationToken that is obtained from the previous query as the value of continuation-token.

class alibabacloud_oss_v2.models.access_point.ListAccessPointsResult(access_points: List[AccessPoint] | None = None, max_keys: int | None = None, is_truncated: bool | None = None, next_continuation_token: str | None = None, account_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The request for the ListAccessPoints operation.

access_points (List[AccessPoint], optional): The container that stores the information about all access point. max_keys (int, optional): The maximum number of results set for this enumeration operation. is_truncated (str, bool): Indicates whether the returned list is truncated. Valid values: * true: indicates that not all results are returned. * false: indicates that all results are returned. next_continuation_token (str, optional): Indicates that this ListAccessPoints request does not return all results that can be listed. You can use NextContinuationToken to continue obtaining list results. account_id (str, optional): The ID of the Alibaba Cloud account to which the access point belongs.

class alibabacloud_oss_v2.models.access_point.PublicAccessBlockConfiguration(block_public_access: bool | None = None, **kwargs: Any)

Bases: Model

The container in which the Block Public Access configurations are stored.

block_public_access (bool, optional): Specifies whether to enable Block Public Access.true: enables Block Public Access.false (default): disables Block Public Access.

class alibabacloud_oss_v2.models.access_point.PutAccessPointPolicyRequest(bucket: str | None = None, access_point_name: str | None = None, body: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutAccessPointPolicy operation.

bucket (str, optional): The name of the bucket. access_point_name (str, optional): The name of the access point. body (str, optional): The configurations of the access point policy.

class alibabacloud_oss_v2.models.access_point.PutAccessPointPolicyResult(**kwargs: Any)

Bases: ResultModel

The request for the PutAccessPointPolicy operation.

alibabacloud_oss_v2.models.access_point_public_access_block module

class alibabacloud_oss_v2.models.access_point_public_access_block.DeleteAccessPointPublicAccessBlockRequest(bucket: str | None = None, access_point_name: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteAccessPointPublicAccessBlock operation.

bucket (str, optional): The name of the bucket. access_point_name (str, optional): The name of the access point.

class alibabacloud_oss_v2.models.access_point_public_access_block.DeleteAccessPointPublicAccessBlockResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteAccessPointPublicAccessBlock operation.

class alibabacloud_oss_v2.models.access_point_public_access_block.GetAccessPointPublicAccessBlockRequest(bucket: str | None = None, access_point_name: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the GetAccessPointPublicAccessBlock operation.

bucket (str, optional): The name of the bucket. access_point_name (str, optional): The name of the access point.

class alibabacloud_oss_v2.models.access_point_public_access_block.GetAccessPointPublicAccessBlockResult(public_access_block_configuration: PublicAccessBlockConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetAccessPointPublicAccessBlock operation.

public_access_block_configuration (PublicAccessBlockConfiguration, optional): The container in which the Block Public Access configurations are stored.

class alibabacloud_oss_v2.models.access_point_public_access_block.PublicAccessBlockConfiguration(block_public_access: bool | None = None, **kwargs: Any)

Bases: Model

The container in which the Block Public Access configurations are stored.

block_public_access (bool, optional): Specifies whether to enable Block Public Access.true: enables Block Public Access.false (default): disables Block Public Access.

class alibabacloud_oss_v2.models.access_point_public_access_block.PutAccessPointPublicAccessBlockRequest(bucket: str = None, access_point_name: str = None, public_access_block_configuration: PublicAccessBlockConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutAccessPointPublicAccessBlock operation.

bucket (str, required): The name of the bucket. access_point_name (str, required): The name of the access point. public_access_block_configuration (PublicAccessBlockConfiguration, optional): The request body.

class alibabacloud_oss_v2.models.access_point_public_access_block.PutAccessPointPublicAccessBlockResult(**kwargs: Any)

Bases: ResultModel

The request for the PutAccessPointPublicAccessBlock operation.

alibabacloud_oss_v2.models.bucket_access_monitor module

class alibabacloud_oss_v2.models.bucket_access_monitor.AccessMonitorConfiguration(status: str | AccessMonitorStatusType | None = None, **kwargs: Any)

Bases: Model

The container that stores access monitor configuration.

status (str | AccessMonitorStatusType, optional): The access tracking status of the bucket. Valid values:- Enabled: Access tracking is enabled.- Disabled: Access tracking is disabled.

class alibabacloud_oss_v2.models.bucket_access_monitor.AccessMonitorStatusType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

A short description of struct

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class alibabacloud_oss_v2.models.bucket_access_monitor.GetBucketAccessMonitorRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketAccessMonitor operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_access_monitor.GetBucketAccessMonitorResult(access_monitor_configuration: AccessMonitorConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketAccessMonitor operation.

access_monitor_configuration (AccessMonitorConfiguration, optional): The container that stores access monitor configuration.

class alibabacloud_oss_v2.models.bucket_access_monitor.PutBucketAccessMonitorRequest(bucket: str = None, access_monitor_configuration: AccessMonitorConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketAccessMonitor operation.

bucket (str, required): The name of the bucket. access_monitor_configuration (AccessMonitorConfiguration, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_access_monitor.PutBucketAccessMonitorResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketAccessMonitor operation.

alibabacloud_oss_v2.models.bucket_archive_direct_read module

class alibabacloud_oss_v2.models.bucket_archive_direct_read.ArchiveDirectReadConfiguration(enabled: bool | None = None, **kwargs: Any)

Bases: Model

The container that stores the configurations for real-time access of Archive objects.

enabled (bool, optional): Specifies whether to enable real-time access of Archive objects for a bucket. Valid values:- true- false

class alibabacloud_oss_v2.models.bucket_archive_direct_read.GetBucketArchiveDirectReadRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketArchiveDirectRead operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_archive_direct_read.GetBucketArchiveDirectReadResult(archive_direct_read_configuration: ArchiveDirectReadConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketArchiveDirectRead operation.

archive_direct_read_configuration (ArchiveDirectReadConfiguration, optional): The container that stores the configurations for real-time access of Archive objects.

class alibabacloud_oss_v2.models.bucket_archive_direct_read.PutBucketArchiveDirectReadRequest(bucket: str = None, archive_direct_read_configuration: ArchiveDirectReadConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketArchiveDirectRead operation.

bucket (str, required): The name of the bucket. archive_direct_read_configuration (ArchiveDirectReadConfiguration, optional): The request body.

class alibabacloud_oss_v2.models.bucket_archive_direct_read.PutBucketArchiveDirectReadResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketArchiveDirectRead operation.

alibabacloud_oss_v2.models.bucket_basic module

Models for bucket basic operation APIs

class alibabacloud_oss_v2.models.bucket_basic.AccessControlList(acl: str | None = None, **kwargs: Any)

Bases: Model

Store ACL information.

acl (str, optional): The access control list (ACL) of the object.

class alibabacloud_oss_v2.models.bucket_basic.BucketInfo(name: str | None = None, access_monitor: str | None = None, location: str | None = None, creation_date: datetime | None = None, extranet_endpoint: str | None = None, intranet_endpoint: str | None = None, acl: str | None = None, data_redundancy_type: str | None = None, owner: Owner | None = None, storage_class: str | None = None, resource_group_id: str | None = None, sse_rule: SSERule | None = None, versioning: str | None = None, transfer_acceleration: str | None = None, cross_region_replication: str | None = None, bucket_policy: BucketPolicy | None = None, comment: str | None = None, block_public_access: bool | None = None, **kwargs: Any)

Bases: Model

BucketInfo defines Bucket information.

name (str, optional): The name of the bucket. access_monitor (str, optional): Indicates whether access tracking is enabled for the bucket. location (str, optional): The region in which the bucket is located. creation_date (datetime, optional): The time when the bucket is created. The time is in UTC. extranet_endpoint (str, optional): The public endpoint that is used to access the bucket over the Internet. intranet_endpoint (str, optional): The internal endpoint that is used to access the bucket from Elastic acl (str, optional): The container that stores the access control list (ACL) information about the bucket. data_redundancy_type (str, optional): The disaster recovery type of the bucket. owner (Owner, optional): The container that stores information about the bucket owner. storage_class (str, optional): The storage class of the bucket. resource_group_id (str, optional): The ID of the resource group to which the bucket belongs. sse_rule (SSERule, optional): The container that stores the server-side encryption method. versioning (str, optional): Indicates whether versioning is enabled for the bucket. transfer_acceleration (str, optional): Indicates whether transfer acceleration is enabled for the bucket. cross_region_replication (str, optional): Indicates whether cross-region replication (CRR) is enabled for the bucket. bucket_policy (BucketPolicy, optional): The container that stores the logs. comment (str, optional): Annotation information. block_public_access (bool, optional): Obtain configuration information for Bucket to block public access.

class alibabacloud_oss_v2.models.bucket_basic.BucketPolicy(log_bucket: str | None = None, log_prefix: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the logs.

log_bucket (str, optional): The name of the bucket that stores the logs.

and specify the CMK ID. In other cases, an empty value is returned.

log_prefix (str, optional): The directory in which logs are stored.

class alibabacloud_oss_v2.models.bucket_basic.CommonPrefix(prefix: str | None = None, **kwargs: Any)

Bases: Model

If the Delimiter parameter is specified in the request, the response contains the CommonPrefixes parameter. The objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in the CommonPrefixes parameter.

prefix (str, optional): The prefix contained in the returned object names.

class alibabacloud_oss_v2.models.bucket_basic.CreateBucketConfiguration(storage_class: str | None = None, data_redundancy_type: str | None = None, **kwargs: Any)

Bases: Model

The configuration information for the bucket.

storage_class (str, optional): The storage class of the bucket. data_redundancy_type (str, optional): The redundancy type of the bucket.

class alibabacloud_oss_v2.models.bucket_basic.DeleteBucketRequest(bucket: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucket operation.

bucket (str, required): The name of the bucket to create.

class alibabacloud_oss_v2.models.bucket_basic.DeleteBucketResult(**kwargs: Any)

Bases: ResultModel

The result for the DeleteBucket operation.

class alibabacloud_oss_v2.models.bucket_basic.DeleteMarkerProperties(key: str | None = None, version_id: str | None = None, is_latest: bool | None = None, last_modified: datetime | None = None, owner: Owner | None = None, **kwargs: Any)

Bases: Model

The container that stores delete markers.

key (str, optional): The name of the object. version_id (str, optional): The version ID of the object. is_latest (bool, optional): Indicates whether the version is the current version. last_modified (datetime, optional): The time when the returned objects were last modified. owner (str, optional): The container that stores information about the bucket owner.

class alibabacloud_oss_v2.models.bucket_basic.GetBucketAclRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketAcl operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_basic.GetBucketAclResult(owner: Owner | None = None, acl: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the GetBucketAcl operation.

owner (str, optional): The container that stores information about the bucket owner. acl (str, optional): The access control list (ACL) of the object.

class alibabacloud_oss_v2.models.bucket_basic.GetBucketInfoRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketInfoRequest operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_basic.GetBucketInfoResult(bucket_info: BucketInfo | None = None, **kwargs: Any)

Bases: ResultModel

The result for the GetBucketInfoResult operation.

bucket_info (BucketInfo, optional): BucketInfo defines Bucket information.

class alibabacloud_oss_v2.models.bucket_basic.GetBucketLocationRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketLocation operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_basic.GetBucketLocationResult(location: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the GetBucketLocation operation.

location (str, optional): The region in which the bucket is located.

class alibabacloud_oss_v2.models.bucket_basic.GetBucketStatRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketStat operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_basic.GetBucketStatResult(storage: int | None = None, object_count: int | None = None, multi_part_upload_count: int | None = None, live_channel_count: int | None = None, last_modified_time: int | None = None, standard_storage: int | None = None, standard_object_count: int | None = None, infrequent_access_storage: int | None = None, infrequent_access_real_storage: int | None = None, infrequent_access_object_count: int | None = None, archive_storage: int | None = None, archive_real_storage: int | None = None, archive_object_count: int | None = None, cold_archive_storage: int | None = None, cold_archive_real_storage: int | None = None, cold_archive_object_count: int | None = None, deep_cold_archive_storage: int | None = None, deep_cold_archive_real_storage: int | None = None, deep_cold_archive_object_count: int | None = None, delete_marker_count: int | None = None, **kwargs: Any)

Bases: ResultModel

The result for the GetBucketStat operation.

storage (int, optional): The total actual storage capacity of the bucket, measured in bytes. object_count (int, optional): The total number of objects in the bucket. multi_part_upload_count (int, optional): The number of Multipart Uploads in the Bucket that have been initialized but not yet completed (Complete) or aborted (Abort). live_channel_count (int, optional): The number of live channels in the bucket. last_modified_time (int, optional): The time point at which the stored information is obtained, in the format of a timestamp and in seconds. standard_storage (int, optional): The storage capacity of standard storage types, measured in bytes. standard_object_count (int, optional): The number of standard storage type objects. infrequent_access_storage (int, optional): The billing storage capacity of low-frequency storage type, in bytes. infrequent_access_real_storage (int, optional): The actual storage capacity of low-frequency storage types, in bytes. infrequent_access_object_count (int, optional): The number of low-frequency storage type objects. archive_storage (int, optional): The billing storage capacity of archive storage type, in bytes. archive_object_count (int, optional): The actual storage capacity of the archive storage type, in bytes. cold_archive_storage (int, optional): The number of objects of archive storage type. cold_archive_real_storage (int, optional): The billing storage capacity of cold archive storage type, in bytes. cold_archive_object_count (int, optional): The actual storage capacity of the cold archive storage type, in bytes. deep_cold_archive_storage (int, optional): The billing storage capacity of deep cold archive storage type, in bytes. deep_cold_archive_real_storage (int, optional): The actual storage capacity of the deep cold archive storage type, in bytes. deep_cold_archive_object_count (int, optional): The number of objects of the deep cold archive storage type. delete_marker_count (int, optional): Delete the count of marker

class alibabacloud_oss_v2.models.bucket_basic.GetBucketVersioningRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketVersioning operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_basic.GetBucketVersioningResult(version_status: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the GetBucketVersioning operation.

version_status (str, optional): The versioning state of the bucket. Valid values: Enabled,Suspended

class alibabacloud_oss_v2.models.bucket_basic.ListObjectVersionsRequest(bucket: str = None, delimiter: str | None = None, key_marker: str | None = None, version_id_marker: str | None = None, max_keys: int | None = None, prefix: str | None = None, encoding_type: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ListObjectVersions operation.

bucket (str, required): The name of the bucket. delimiter (str, optional): The character that is used to group objects by name.

If you specify the delimiter parameter in the request, the response contains the CommonPrefixes parameter. The objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in CommonPrefixes.

key_marker (str, optional): Specifies that objects whose names are alphabetically after the value of the key-marker parameter are returned.

This parameter can be specified together with version-id-marker. By default, this parameter is left empty.

version_id_marker (str, optional): Specifies that the versions created before the version specified by version-id-marker for the object

whose name is specified by key-marker are returned by creation time in descending order. By default, if this parameter is not specified, the results are returned from the latest version of the object whose name is alphabetically after the value of key-marker.

max_keys (int, optional): The maximum number of objects that you want to return.

If the list operation cannot be complete at a time, because the max-keys parameter is specified, the NextMarker element is included in the response as the marker for the next list operation.

prefix (str, optional): The prefix that the names of the returned objects must contain. encoding_type (str, optional): The encoding type of the content in the response. Valid value: url request_payer (str, optional): To indicate that the requester is aware that the request

and data download will incur costs

class alibabacloud_oss_v2.models.bucket_basic.ListObjectVersionsResult(name: str | None = None, key_marker: str | None = None, next_key_marker: str | None = None, version_id_marker: str | None = None, next_version_id_marker: str | None = None, prefix: str | None = None, max_keys: int | None = None, delimiter: str | None = None, is_truncated: bool | None = None, encoding_type: str | None = None, version: List[ObjectVersionProperties] | None = None, delete_marker: List[DeleteMarkerProperties] | None = None, common_prefixes: List[CommonPrefix] | None = None, **kwargs: Any)

Bases: ResultModel

The result for the ListObjectVersions operation.

name (str, optional): The name of the bucket. key_marker (str, optional): Indicates the object from which the ListObjectVersions (GetBucketVersions) operation starts. next_key_marker (str, optional): If not all results are returned for the request, the NextKeyMarker parameter is included

in the response to indicate the key-marker value of the next ListObjectVersions (GetBucketVersions) request.

version_id_marker (str, optional): The version from which the ListObjectVersions (GetBucketVersions) operation starts. next_version_id_marker (str, optional): If not all results are returned for the request, the NextVersionIdMarker parameter is included in

the response to indicate the version-id-marker value of the next ListObjectVersions (GetBucketVersions) request.

prefix (str, optional): The prefix contained in the returned object names. max_keys (int, optional): The maximum number of returned objects in the response. delimiter (str, optional): The character that is used to group objects by name. is_truncated (bool, optional): Indicates whether the returned results are truncated.

true indicates that not all results are returned this time. false indicates that all results are returned this time.

encoding_type (str, optional): The encoding type of the content in the response. version ([ObjectVersionProperties], optional): The container that stores the versions of objects, excluding delete markers. delete_marker ([DeleteMarkerProperties], optional): The container that stores delete markers. common_prefixes ([CommonPrefix], optional): If the Delimiter parameter is specified in the request,

the response contains the CommonPrefixes element.

class alibabacloud_oss_v2.models.bucket_basic.ListObjectsRequest(bucket: str = None, delimiter: str | None = None, encoding_type: str | None = None, marker: str | None = None, max_keys: int | None = None, prefix: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ListObjects operation.

bucket (str, required): The name of the bucket to create. delimiter (str, optional): The character that is used to group objects by name.

If you specify the delimiter parameter in the request, the response contains the CommonPrefixes parameter. The objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in CommonPrefixes.

encoding_type (str, optional): The encoding type of the content in the response. Valid value: url marker (str, optional): The name of the object after which the ListObjects (GetBucket) operation starts.

If this parameter is specified, objects whose names are alphabetically greater than the marker value are returned.

max_keys (int, optional): The maximum number of objects that you want to return.

If the list operation cannot be complete at a time, because the max-keys parameter is specified, the NextMarker element is included in the response as the marker for the next list operation.

prefix (str, optional): The prefix that the names of the returned objects must contain. request_payer (str, optional): To indicate that the requester is aware that the request

and data download will incur costs

class alibabacloud_oss_v2.models.bucket_basic.ListObjectsResult(name: str | None = None, prefix: str | None = None, marker: str | None = None, max_keys: int | None = None, delimiter: str | None = None, is_truncated: bool | None = None, next_marker: str | None = None, encoding_type: str | None = None, contents: List[ObjectProperties] | None = None, common_prefixes: List[CommonPrefix] | None = None, **kwargs: Any)

Bases: ResultModel

The result for the ListObjects operation.

name (str, optional): The name of the bucket. prefix (str, optional): The prefix contained in the returned object names. marker (str, optional): The name of the object after which the list operation begins. max_keys (int, optional): The maximum number of returned objects in the response. delimiter (str, optional): The character that is used to group objects by name. is_truncated (bool, optional): Indicates whether the returned results are truncated.

true indicates that not all results are returned this time. false indicates that all results are returned this time.

next_marker (str, optional): The position from which the next list operation starts. encoding_type (str, optional): The encoding type of the content in the response. contents ([ObjectProperties], optional): The container that stores the metadata of the returned objects. common_prefixes ([CommonPrefix], optional): If the Delimiter parameter is specified in the request,

the response contains the CommonPrefixes element.

class alibabacloud_oss_v2.models.bucket_basic.ListObjectsV2Request(bucket: str = None, delimiter: str | None = None, start_after: str | None = None, encoding_type: str | None = None, continuation_token: str | None = None, max_keys: int | None = None, prefix: str | None = None, fetch_owner: bool | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ListObjectsV2 operation.

bucket (str, required): The name of the bucket. delimiter (str, optional): The character that is used to group objects by name.

If you specify the delimiter parameter in the request, the response contains the CommonPrefixes parameter. The objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in CommonPrefixes.

start_after (str, optional): Set to return objects in alphabetical order starting from start after. encoding_type (str, optional): The encoding type of the content in the response. Valid value: url continuation_token (str, optional): The specified List operation needs to start from this token.

You can obtain this token from the NextContinuationToken in the ListObjectiesV2 (GetBucketV2) result.

max_keys (int, optional): The maximum number of objects that you want to return.

If the list operation cannot be complete at a time, because the max-keys parameter is specified, the NextMarker element is included in the response as the marker for the next list operation.

prefix (str, optional): The prefix that the names of the returned objects must contain. fetch_owner (str, optional): Specify whether to include owner information in the return result.

Legitimate values: true, false

request_payer (str, optional): To indicate that the requester is aware that the request

and data download will incur costs

class alibabacloud_oss_v2.models.bucket_basic.ListObjectsV2Result(name: str | None = None, prefix: str | None = None, continuation_token: str | None = None, max_keys: int | None = None, delimiter: str | None = None, is_truncated: bool | None = None, next_continuation_token: str | None = None, encoding_type: str | None = None, contents: List[ObjectProperties] | None = None, common_prefixes: List[CommonPrefix] | None = None, start_after: str | None = None, key_count: int | None = None, **kwargs: Any)

Bases: ResultModel

The result for the ListObjectsV2 operation.

name (str, optional): The name of the bucket. prefix (str, optional): The prefix contained in the returned object names. continuation_token (str, optional): The name of the object after which the list operation begins. max_keys (int, optional): The maximum number of returned objects in the response. delimiter (str, optional): The character that is used to group objects by name. is_truncated (bool, optional): Indicates whether the returned results are truncated.

true indicates that not all results are returned this time. false indicates that all results are returned this time.

next_continuation_token (str, optional): The position from which the next list operation starts. encoding_type (str, optional): The encoding type of the content in the response. contents ([ObjectProperties], optional): The container that stores the metadata of the returned objects. common_prefixes ([CommonPrefix], optional): If the Delimiter parameter is specified in the request,

the response contains the CommonPrefixes element.

start_after (str, optional): If the StartAfter parameter is specified in the request,

the StartAfter element will be included in the returned response.

key_count (int, optional): The number of keys returned in this request. If a delimiter is specified,

KeyCount is the sum of the elements of Key and Commonprefixes.

class alibabacloud_oss_v2.models.bucket_basic.ObjectProperties(key: str | None = None, object_type: str | None = None, size: int | None = None, etag: str | None = None, last_modified: datetime | None = None, storage_class: str | None = None, owner: Owner | None = None, restore_info: str | None = None, transition_time: str | None = None, **kwargs: Any)

Bases: Model

Stores the metadata of the object.

key (str, optional): The name of the object. object_type (str, optional): The type of the object.

Valid values: Normal, Multipart and Appendable

size (int, optional): The size of the returned object. Unit: bytes. etag (str, optional): The entity tag (ETag). An ETag is created when an object is created to

identify the content of the object.

last_modified (datetime, optional): The time when the returned objects were last modified. storage_class (str, optional): The storage class of the object. owner (str, optional): The container that stores information about the bucket owner. restore_info (Owner, optional): The restoration status of the object. transition_time (str): The time when the storage class of the object is converted to Cold Archive or Deep Cold Archive based on lifecycle rules.

class alibabacloud_oss_v2.models.bucket_basic.ObjectVersionProperties(key: str | None = None, version_id: str | None = None, is_latest: bool | None = None, object_type: str | None = None, size: int | None = None, etag: str | None = None, last_modified: datetime | None = None, storage_class: str | None = None, owner: Owner | None = None, restore_info: str | None = None, transition_time: str | None = None, **kwargs: Any)

Bases: Model

Stores the metadata of the object version.

key (str, optional): The name of the object. version_id (str, optional): The version ID of the object. is_latest (bool, optional): Indicates whether the version is the current version. object_type (str, optional): The type of the object.

Valid values: Normal, Multipart and Appendable

size (int, optional): The size of the returned object. Unit: bytes. etag (str, optional): The entity tag (ETag). An ETag is created when an object is created to

identify the content of the object.

last_modified (datetime, optional): The time when the returned objects were last modified. storage_class (str, optional): The storage class of the object. owner (str, optional): The container that stores information about the bucket owner. restore_info (Owner, optional): The restoration status of the object. transition_time (str): The time when the storage class of the object is converted to Cold Archive or Deep Cold Archive based on lifecycle rules.

class alibabacloud_oss_v2.models.bucket_basic.Owner(id: str | None = None, display_name: str | None = None, **kwargs: Any)

Bases: Model

Stores information about the bucket owner.

id (str, optional): The ID of the bucket owner. display_name (str, optional): The name of the object owner..

class alibabacloud_oss_v2.models.bucket_basic.PutBucketAclRequest(bucket: str = None, acl: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketAcl operation.

bucket (str, required): The name of the bucket. acl (str, optional): The access control list (ACL) of the object.

class alibabacloud_oss_v2.models.bucket_basic.PutBucketAclResult(**kwargs: Any)

Bases: ResultModel

The result for the PutBucketAcl operation.

class alibabacloud_oss_v2.models.bucket_basic.PutBucketRequest(bucket: str = None, acl: str | None = None, resource_group_id: str | None = None, create_bucket_configuration: CreateBucketConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucket operation.

bucket (str, required): The name of the bucket to create. acl (str, optional): The access control list (ACL) of the bucket. resource_group_id (str, optional): The ID of the resource group. create_bucket_configuration (CreateBucketConfiguration, optional):

The configuration information for the bucket.

class alibabacloud_oss_v2.models.bucket_basic.PutBucketResult(**kwargs: Any)

Bases: ResultModel

The result for the PutBucket operation.

class alibabacloud_oss_v2.models.bucket_basic.PutBucketVersioningRequest(bucket: str = None, versioning_configuration: VersioningConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketVersioning operation.

bucket (str, required): The name of the bucket. versioning_configuration (VersioningConfiguration, optional): A container for storing version control status.

class alibabacloud_oss_v2.models.bucket_basic.PutBucketVersioningResult(**kwargs: Any)

Bases: ResultModel

The result for the PutBucketVersioning operation.

class alibabacloud_oss_v2.models.bucket_basic.SSERule(kms_master_key_id: str | None = None, sse_algorithm: str | None = None, kms_data_encryption: str | None = None, **kwargs: Any)

Bases: Model

Information on server-side encryption methods.

kms_master_key_id (str, optional): The customer master key (CMK) ID in use. A valid value is returned only if you set SSEAlgorithm to KMS

and specify the CMK ID. In other cases, an empty value is returned.

sse_algorithm (str, optional): The server-side encryption method that is used by default. kms_data_encryption (str, optional): Object’s encryption algorithm. If this element is not included in the response,

it indicates that the object is using the AES256 encryption algorithm. This option is only valid if the SSEAlgorithm value is KMS.

class alibabacloud_oss_v2.models.bucket_basic.VersioningConfiguration(status: str | None = None, **kwargs: Any)

Bases: Model

The versioning state of the bucket. Valid values: Enabled,Suspended.

status (str, optional): The versioning state of the bucket. Valid values: Enabled,Suspended

alibabacloud_oss_v2.models.bucket_cname module

class alibabacloud_oss_v2.models.bucket_cname.BucketCnameConfiguration(cname: Cname | None = None, **kwargs: Any)

Bases: Model

The container that stores the CNAME record.

cname (Cname, optional): The container that stores the CNAME information.

class alibabacloud_oss_v2.models.bucket_cname.CertificateConfiguration(certificate: str | None = None, private_key: str | None = None, previous_cert_id: str | None = None, force: bool | None = None, delete_certificate: bool | None = None, cert_id: str | None = None, **kwargs: Any)

Bases: Model

The container for which the certificate is configured.

certificate (str, optional): The public key of the certificate. private_key (str, optional): The private key of the certificate. previous_cert_id (str, optional): The ID of the certificate. If the Force parameter is not set to true, the OSS server checks whether the value of the Force parameter matches the current certificate ID. If the value does not match the certificate ID, an error is returned.noticeIf you do not specify the PreviousCertId parameter when you bind a certificate, you must set the Force parameter to true./notice force (bool, optional): Specifies whether to overwrite the certificate. Valid values:- true: overwrites the certificate.- false: does not overwrite the certificate. delete_certificate (bool, optional): Specifies whether to delete the certificate. Valid values:- true: deletes the certificate.- false: does not delete the certificate. cert_id (str, optional): The ID of the certificate.

class alibabacloud_oss_v2.models.bucket_cname.Cname(domain: str | None = None, certificate_configuration: CertificateConfiguration | None = None, **kwargs: Any)

Bases: Model

The container that stores the CNAME information.

domain (str, optional): The custom domain name. certificate_configuration (CertificateConfiguration, optional): The container for which the certificate is configured.

class alibabacloud_oss_v2.models.bucket_cname.CnameCertificate(fingerprint: str | None = None, valid_start_date: str | None = None, valid_end_date: str | None = None, type: str | None = None, cert_id: str | None = None, status: str | None = None, creation_date: str | None = None, **kwargs: Any)

Bases: Model

The information about the certificate.

fingerprint (str, optional): The signature of the certificate. valid_start_date (str, optional): The time when the certificate takes effect. valid_end_date (str, optional): The time when the certificate expires. type (str, optional): The source of the certificate.Valid values:* CAS * Upload cert_id (str, optional): The ID of the certificate. status (str, optional): The status of the certificate.Valid values:* Enabled * Disabled creation_date (str, optional): The time when the certificate was bound.

class alibabacloud_oss_v2.models.bucket_cname.CnameInfo(domain: str | None = None, last_modified: str | None = None, status: str | None = None, certificate: CnameCertificate | None = None, **kwargs: Any)

Bases: Model

The information about the CNAME records.

domain (str, optional): The custom domain name. last_modified (str, optional): The time when the custom domain name was mapped. status (str, optional): The status of the domain name. Valid values:* Enabled* Disabled certificate (CnameCertificate, optional): The container in which the certificate information is stored.

class alibabacloud_oss_v2.models.bucket_cname.CnameToken(cname: str | None = None, token: str | None = None, expire_time: str | None = None, bucket: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the CNAME token.

cname (str, optional): The name of the CNAME record that is mapped to the bucket. token (str, optional): The CNAME token that is returned by OSS. expire_time (str, optional): The time when the CNAME token expires. bucket (str, optional): The name of the bucket to which the CNAME record is mapped.

class alibabacloud_oss_v2.models.bucket_cname.CreateCnameTokenRequest(bucket: str = None, bucket_cname_configuration: BucketCnameConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the CreateCnameToken operation.

bucket (str, required): The name of the bucket. bucket_cname_configuration (BucketCnameConfiguration, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_cname.CreateCnameTokenResult(cname_token: CnameToken | None = None, **kwargs: Any)

Bases: ResultModel

The request for the CreateCnameToken operation.

cname_token (CnameToken, optional): The container in which the CNAME token is stored.

class alibabacloud_oss_v2.models.bucket_cname.DeleteCnameRequest(bucket: str = None, bucket_cname_configuration: BucketCnameConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteCname operation.

bucket (str, required): The name of the bucket. bucket_cname_configuration (BucketCnameConfiguration, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_cname.DeleteCnameResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteCname operation.

class alibabacloud_oss_v2.models.bucket_cname.GetCnameTokenRequest(bucket: str = None, cname: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetCnameToken operation.

bucket (str, required): The name of the bucket. cname (str, required): The name of the CNAME record that is mapped to the bucket.

class alibabacloud_oss_v2.models.bucket_cname.GetCnameTokenResult(cname_token: CnameToken | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetCnameToken operation.

cname_token (CnameToken, optional): The container in which the CNAME token is stored.

class alibabacloud_oss_v2.models.bucket_cname.ListCnameRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the ListCname operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_cname.ListCnameResult(cnames: List[CnameInfo] | None = None, bucket: str | None = None, owner: str | None = None, **kwargs: Any)

Bases: ResultModel

The request for the ListCname operation.

cnames (List[CnameInfo], optional): The container that is used to store the information about all CNAME records. bucket (str, optional): The name of the bucket to which the CNAME records you want to query are mapped. owner (str, optional): The name of the bucket owner.

class alibabacloud_oss_v2.models.bucket_cname.PutCnameRequest(bucket: str = None, bucket_cname_configuration: BucketCnameConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutCname operation.

bucket (str, required): The name of the bucket. bucket_cname_configuration (BucketCnameConfiguration, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_cname.PutCnameResult(**kwargs: Any)

Bases: ResultModel

The request for the PutCname operation.

alibabacloud_oss_v2.models.bucket_cors module

class alibabacloud_oss_v2.models.bucket_cors.CORSConfiguration(cors_rules: List[CORSRule] | None = None, response_vary: bool | None = None, **kwargs: Any)

Bases: Model

The container that stores CORS configuration.

cors_rules (List[CORSRule], optional): The container that stores CORS rules. Up to 10 rules can be configured for a bucket. response_vary (bool, optional): Indicates whether the Vary: Origin header was returned. Default value: false.- true: The Vary: Origin header is returned regardless whether the request is a cross-origin request or whether the cross-origin request succeeds.- false: The Vary: Origin header is not returned.

class alibabacloud_oss_v2.models.bucket_cors.CORSRule(allowed_origins: List[str] | None = None, allowed_methods: List[str] | None = None, allowed_headers: List[str] | None = None, expose_headers: List[str] | None = None, max_age_seconds: int | None = None, **kwargs: Any)

Bases: Model

The container that stores the CORS rules.Up to 10 CORS rules can be configured for a bucket. The XML message body in a request can be up to 16 KB in size.

allowed_origins (List[str], optional): The origins from which cross-origin requests are allowed. allowed_methods (List[str], optional): The methods that you can use in cross-origin requests. allowed_headers (List[str], optional): Specifies whether the headers specified by Access-Control-Request-Headers in the OPTIONS preflight request are allowed. Each header specified by Access-Control-Request-Headers must match the value of an AllowedHeader element. You can use only one asterisk (*) as the wildcard character. expose_headers (List[str], optional): The response headers for allowed access requests from applications, such as an XMLHttpRequest object in JavaScript. The asterisk (*) wildcard character is not supported. max_age_seconds (int, optional): The period of time within which the browser can cache the response to an OPTIONS preflight request for the specified resource. Unit: seconds.You can specify only one MaxAgeSeconds element in a CORS rule.

class alibabacloud_oss_v2.models.bucket_cors.DeleteBucketCorsRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketCors operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_cors.DeleteBucketCorsResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketCors operation.

class alibabacloud_oss_v2.models.bucket_cors.GetBucketCorsRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketCors operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_cors.GetBucketCorsResult(cors_configuration: CORSConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketCors operation.

cors_configuration (CORSConfiguration, optional): The container that stores CORS configuration.

class alibabacloud_oss_v2.models.bucket_cors.OptionObjectRequest(bucket: str = None, key: str = None, origin: str | None = None, access_control_request_method: str | None = None, access_control_request_headers: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the OptionObject operation.

bucket (str, required): The name of the bucket. key (str, required): The full path of the object. origin (str, optional): The origin of the request. It is used to identify a cross-origin request. You can specify only one Origin header in a cross-origin request. By default, this header is left empty. access_control_request_method (str, optional): The method to be used in the actual cross-origin request. You can specify only one Access-Control-Request-Method header in a cross-origin request. By default, this header is left empty. access_control_request_headers (str, optional): The custom headers to be sent in the actual cross-origin request. You can configure multiple custom headers in a cross-origin request. Custom headers are separated by commas (,). By default, this header is left empty.

class alibabacloud_oss_v2.models.bucket_cors.OptionObjectResult(access_control_allow_origin: str | None = None, access_control_allow_methods: str | None = None, access_control_allow_headers: str | None = None, access_control_expose_headers: str | None = None, access_control_max_age: int | None = None, **kwargs: Any)

Bases: ResultModel

The request for the OptionObject operation.

access_control_allow_origin (str, optional): <no value> access_control_allow_methods (str, optional): <no value> access_control_allow_headers (str, optional): <no value> access_control_expose_headers (str, optional): <no value> access_control_max_age (int, optional): <no value>

class alibabacloud_oss_v2.models.bucket_cors.PutBucketCorsRequest(bucket: str = None, cors_configuration: CORSConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketCors operation.

bucket (str, required): The name of the bucket. cors_configuration (CORSConfiguration, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_cors.PutBucketCorsResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketCors operation.

alibabacloud_oss_v2.models.bucket_data_redundancy_transition module

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.BucketDataRedundancyTransition(bucket: str | None = None, task_id: str | None = None, status: str | None = None, create_time: str | None = None, start_time: str | None = None, end_time: str | None = None, process_percentage: int | None = None, estimated_remaining_time: int | None = None, **kwargs: Any)

Bases: Model

The container in which the redundancy type conversion task is stored.

bucket (str, optional): The name of the bucket. task_id (str, optional): The ID of the redundancy type conversion task. The ID can be used to view and delete the redundancy type conversion task. status (str, optional): The state of the redundancy type change task. Valid values:QueueingProcessingFinished. create_time (str, optional): The time when the redundancy type change task was created. start_time (str, optional): The time when the redundancy type change task was performed. This element is available when the task is in the Processing or Finished state. end_time (str, optional): The time when the redundancy type change task was finished. This element is available when the task is in the Finished state. process_percentage (str, optional): The progress of the redundancy type change task in percentage. Valid values: 0 to 100. This element is available when the task is in the Processing or Finished state. estimated_remaining_time (str, optional): The estimated period of time that is required for the redundancy type change task. Unit: hours. This element is available when the task is in the Processing or Finished state.

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.CreateBucketDataRedundancyTransitionRequest(bucket: str = None, target_redundancy_type: str = None, **kwargs: Any)

Bases: RequestModel

The request for the CreateBucketDataRedundancyTransition operation.

bucket (str, required): The name of the bucket. target_redundancy_type (str, required): The redundancy type to which you want to convert the bucket. You can only convert the redundancy type of a bucket from LRS to ZRS.

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.CreateBucketDataRedundancyTransitionResult(bucket_data_redundancy_transition: BucketDataRedundancyTransition | None = None, **kwargs: Any)

Bases: ResultModel

The request for the CreateBucketDataRedundancyTransition operation.

bucket_data_redundancy_transition (BucketDataRedundancyTransition, optional): The container in which the redundancy type conversion task is stored.

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.DeleteBucketDataRedundancyTransitionRequest(bucket: str = None, redundancy_transition_taskid: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketDataRedundancyTransition operation.

bucket (str, required): The name of the bucket. redundancy_transition_taskid (str, required): The ID of the redundancy type change task.

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.DeleteBucketDataRedundancyTransitionResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketDataRedundancyTransition operation.

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.GetBucketDataRedundancyTransitionRequest(bucket: str = None, redundancy_transition_taskid: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketDataRedundancyTransition operation.

bucket (str, required): The name of the bucket. redundancy_transition_taskid (str, required): The ID of the redundancy change task.

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.GetBucketDataRedundancyTransitionResult(bucket_data_redundancy_transition: BucketDataRedundancyTransition | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketDataRedundancyTransition operation.

bucket_data_redundancy_transition (BucketDataRedundancyTransition, optional): The container for a specific redundancy type change task.

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.ListBucketDataRedundancyTransition(bucket_data_redundancy_transition: List[BucketDataRedundancyTransition] | None = None, is_truncated: bool | None = None, next_continuation_token: str | None = None, **kwargs: Any)

Bases: Model

The container for listed redundancy type change tasks.

bucket_data_redundancy_transition (List[BucketDataRedundancyTransition], optional): The container in which the redundancy type conversion task is stored. is_truncated (bool, optional): Specifies whether to list all inventory tasks configured for the bucket.Valid values: true and false- The value of false indicates that all inventory tasks configured for the bucket are listed.- The value of true indicates that not all inventory tasks configured for the bucket are listed. To list the next page of inventory configurations, set the continuation-token parameter in the next request to the value of the NextContinuationToken header in the response to the current request. next_continuation_token (str, optional): If the value of IsTruncated in the response is true and value of this header is not null, set the continuation-token parameter in the next request to the value of this header.

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.ListBucketDataRedundancyTransitionRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the ListBucketDataRedundancyTransition operation.

bucket (str, required):

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.ListBucketDataRedundancyTransitionResult(list_bucket_data_redundancy_transition: ListBucketDataRedundancyTransition | None = None, **kwargs: Any)

Bases: ResultModel

The request for the ListBucketDataRedundancyTransition operation.

list_bucket_data_redundancy_transition (ListBucketDataRedundancyTransition, optional): The container for listed redundancy type change tasks.

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.ListUserDataRedundancyTransitionRequest(max_keys: int | None = None, continuation_token: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ListUserDataRedundancyTransitionRequest operation.

max_keys (int, optional): The maximum number of access points that can be returned. Valid values:* For user-level access points: (0,1000].* For bucket-level access points: (0,100]. continuation_token (str, optional): The token from which the listing operation starts. You must specify the value of NextContinuationToken that is obtained from the previous query as the value of continuation-token.

class alibabacloud_oss_v2.models.bucket_data_redundancy_transition.ListUserDataRedundancyTransitionResult(list_bucket_data_redundancy_transition: ListBucketDataRedundancyTransition | None = None, **kwargs: Any)

Bases: ResultModel

The request for the ListUserDataRedundancyTransitionRequest operation.

list_bucket_data_redundancy_transition (ListBucketDataRedundancyTransition, optional): The container for listed redundancy type change tasks.

alibabacloud_oss_v2.models.bucket_encryption module

class alibabacloud_oss_v2.models.bucket_encryption.ApplyServerSideEncryptionByDefault(kms_master_key_id: str | None = None, kms_data_encryption: str | None = None, sse_algorithm: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the default server-side encryption method.

kms_master_key_id (str, optional): The CMK ID that is specified when SSEAlgorithm is set to KMS and a specified CMK is used for encryption. In other cases, leave this parameter empty. kms_data_encryption (str, optional): The algorithm that is used to encrypt objects. If this parameter is not specified, objects are encrypted by using AES256. This parameter is valid only when SSEAlgorithm is set to KMS. Valid value: SM4. sse_algorithm (str, optional): The default server-side encryption method. Valid values: KMS, AES256, and SM4. You are charged when you call API operations to encrypt or decrypt data by using CMKs managed by KMS. For more information, see [Billing of KMS](~~52608~~). If the default server-side encryption method is configured for the destination bucket and ReplicaCMKID is configured in the CRR rule:* If objects in the source bucket are not encrypted, they are encrypted by using the default encryption method of the destination bucket after they are replicated.* If objects in the source bucket are encrypted by using SSE-KMS or SSE-OSS, they are encrypted by using the same method after they are replicated.For more information, see [Use data replication with server-side encryption](~~177216~~).

class alibabacloud_oss_v2.models.bucket_encryption.DeleteBucketEncryptionRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketEncryption operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_encryption.DeleteBucketEncryptionResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketEncryption operation.

class alibabacloud_oss_v2.models.bucket_encryption.GetBucketEncryptionRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketEncryption operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_encryption.GetBucketEncryptionResult(server_side_encryption_rule: ServerSideEncryptionRule | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketEncryption operation.

server_side_encryption_rule (ServerSideEncryptionRule, optional): The container that stores server-side encryption rules.

class alibabacloud_oss_v2.models.bucket_encryption.PutBucketEncryptionRequest(bucket: str = None, server_side_encryption_rule: ServerSideEncryptionRule | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketEncryption operation.

bucket (str, required): The name of the bucket. server_side_encryption_rule (ServerSideEncryptionRule, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_encryption.PutBucketEncryptionResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketEncryption operation.

class alibabacloud_oss_v2.models.bucket_encryption.ServerSideEncryptionRule(apply_server_side_encryption_by_default: ApplyServerSideEncryptionByDefault | None = None, **kwargs: Any)

Bases: Model

The container that stores server-side encryption rules.

apply_server_side_encryption_by_default (ApplyServerSideEncryptionByDefault, optional): The container that stores the default server-side encryption method.

alibabacloud_oss_v2.models.bucket_https_config module

class alibabacloud_oss_v2.models.bucket_https_config.GetBucketHttpsConfigRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketHttpsConfig operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_https_config.GetBucketHttpsConfigResult(https_configuration: HttpsConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketHttpsConfig operation.

https_configuration (HttpsConfiguration, optional): The container that stores HTTPS configurations.

class alibabacloud_oss_v2.models.bucket_https_config.HttpsConfiguration(tls: TLS | None = None, **kwargs: Any)

Bases: Model

The container that stores Transport Layer Security (TLS) version configurations.

tls (TLS, optional): The container that stores TLS version configurations.

class alibabacloud_oss_v2.models.bucket_https_config.PutBucketHttpsConfigRequest(bucket: str = None, https_configuration: HttpsConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketHttpsConfig operation.

bucket (str, required): This name of the bucket. https_configuration (HttpsConfiguration, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_https_config.PutBucketHttpsConfigResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketHttpsConfig operation.

class alibabacloud_oss_v2.models.bucket_https_config.TLS(enable: bool | None = None, tls_versions: List[str] | None = None, **kwargs: Any)

Bases: Model

The container that stores TLS version configurations.

enable (bool, optional): Specifies whether to enable TLS version management for the bucket.Valid values:*true *false tls_versions (List[str], optional): The TLS versions.

alibabacloud_oss_v2.models.bucket_inventory module

class alibabacloud_oss_v2.models.bucket_inventory.DeleteBucketInventoryRequest(bucket: str = None, inventory_id: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketInventory operation.

bucket (str, required): The name of the bucket. inventory_id (str, required): The name of the inventory that you want to delete.

class alibabacloud_oss_v2.models.bucket_inventory.DeleteBucketInventoryResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketInventory operation.

class alibabacloud_oss_v2.models.bucket_inventory.GetBucketInventoryRequest(bucket: str = None, inventory_id: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketInventory operation.

bucket (str, required): The name of the bucket. inventory_id (str, required): The name of the inventory to be queried.

class alibabacloud_oss_v2.models.bucket_inventory.GetBucketInventoryResult(inventory_configuration: InventoryConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketInventory operation.

inventory_configuration (InventoryConfiguration, optional): The inventory task configured for a bucket.

class alibabacloud_oss_v2.models.bucket_inventory.InventoryConfiguration(included_object_versions: str | None = None, optional_fields: OptionalFields | None = None, id: str | None = None, is_enabled: bool | None = None, destination: InventoryDestination | None = None, schedule: InventorySchedule | None = None, filter: InventoryFilter | None = None, **kwargs: Any)

Bases: Model

The container that stores the configurations of the inventory.

included_object_versions (str, optional): Specifies whether to include the version information about the objects in inventory lists. Valid values:* All: The information about all versions of the objects is exported.* Current: Only the information about the current versions of the objects is exported. optional_fields (OptionalFields, optional): The container that stores the configuration fields in inventory lists. id (str, optional): The name of the inventory. The name must be unique in the bucket. is_enabled (bool, optional): Specifies whether to enable the bucket inventory feature. Valid values:* true* false destination (InventoryDestination, optional): The container that stores the exported inventory lists. schedule (InventorySchedule, optional): The container that stores information about the frequency at which inventory lists are exported. filter (InventoryFilter, optional): The container that stores the prefix used to filter objects. Only objects whose names contain the specified prefix are included in the inventory.

class alibabacloud_oss_v2.models.bucket_inventory.InventoryDestination(oss_bucket_destination: InventoryOSSBucketDestination | None = None, **kwargs: Any)

Bases: Model

The container that stores information about exported inventory lists.

oss_bucket_destination (InventoryOSSBucketDestination, optional): The container that stores information about the bucket in which exported inventory lists are stored.

class alibabacloud_oss_v2.models.bucket_inventory.InventoryEncryption(sse_kms: SSEKMS | None = None, sse_oss: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the encryption method of exported inventory lists.

sse_kms (SSEKMS, optional): The container that stores the customer master key (CMK) used for SSE-KMS encryption. sse_oss (str, optional): The container that stores information about the SSE-OSS encryption method.

class alibabacloud_oss_v2.models.bucket_inventory.InventoryFilter(lower_size_bound: int | None = None, upper_size_bound: int | None = None, storage_class: str | None = None, prefix: str | None = None, last_modify_begin_time_stamp: int | None = None, last_modify_end_time_stamp: int | None = None, **kwargs: Any)

Bases: Model

The container that stores the prefix used to filter objects. Only objects whose names contain the specified prefix are included in the inventory.

lower_size_bound (int, optional): The minimum size of the specified object. Unit: B.Valid values: [0 B, 48.8 TB] upper_size_bound (int, optional): The maximum size of the specified object. Unit: B.Valid values: (0 B, 48.8 TB] storage_class (str, optional): The storage class of the object. You can specify multiple storage classes.Valid values:StandardIAArchiveColdArchiveAll prefix (str, optional): The prefix that is specified in the inventory. last_modify_begin_time_stamp (int, optional): The beginning of the time range during which the object was last modified. Unit: seconds.Valid values: [1262275200, 253402271999] last_modify_end_time_stamp (int, optional): The end of the time range during which the object was last modified. Unit: seconds.Valid values: [1262275200, 253402271999]

class alibabacloud_oss_v2.models.bucket_inventory.InventoryFormatType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The format of the exported inventory list

CSV = 'CSV'

class alibabacloud_oss_v2.models.bucket_inventory.InventoryFrequencyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The frequency that inventory lists are exported

DAILY = 'Daily'

WEEKLY = 'Weekly'

class alibabacloud_oss_v2.models.bucket_inventory.InventoryOSSBucketDestination(format: str | InventoryFormatType | None = None, account_id: str | None = None, role_arn: str | None = None, bucket: str | None = None, prefix: str | None = None, encryption: InventoryEncryption | None = None, **kwargs: Any)

Bases: Model

The container that stores information about the bucket in which exported inventory lists are stored.

format (str | InventoryFormatType, optional): The format of exported inventory lists. The exported inventory lists are CSV objects compressed by using GZIP. account_id (str, optional): The ID of the account to which permissions are granted by the bucket owner. role_arn (str, optional): The Alibaba Cloud Resource Name (ARN) of the role that has the permissions to read all objects from the source bucket and write objects to the destination bucket. Format: acs:ram::uid:role/rolename. bucket (str, optional): The name of the bucket in which exported inventory lists are stored. prefix (str, optional): The prefix of the path in which the exported inventory lists are stored. encryption (InventoryEncryption, optional): The container that stores the encryption method of the exported inventory lists.

class alibabacloud_oss_v2.models.bucket_inventory.InventoryOptionalFieldType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

InventoryOptionalFieldType The configuration fields that are included in inventory lists.

ENCRYPTION_STATUS = 'EncryptionStatus'

E_TAG = 'ETag'

IS_MULTIPART_UPLOADED = 'IsMultipartUploaded'

LAST_MODIFIED_DATE = 'LastModifiedDate'

SIZE = 'Size'

STORAGE_CLASS = 'StorageClass'

TRANSITION_TIME = 'TransitionTime'

class alibabacloud_oss_v2.models.bucket_inventory.InventorySchedule(frequency: str | InventoryFrequencyType | None = None, **kwargs: Any)

Bases: Model

Contains the frequency that inventory lists are exported

frequency (str | InventoryFrequencyType, optional): The frequency at which the inventory list is exported. Valid values:- Daily: The inventory list is exported on a daily basis. - Weekly: The inventory list is exported on a weekly basis.

class alibabacloud_oss_v2.models.bucket_inventory.ListBucketInventoryRequest(bucket: str = None, continuation_token: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ListBucketInventory operation.

bucket (str, required): The name of the bucket. continuation_token (str, optional): Specify the start position of the list operation. You can obtain this token from the NextContinuationToken field of last ListBucketInventory’s result.

class alibabacloud_oss_v2.models.bucket_inventory.ListBucketInventoryResult(list_inventory_configurations_result: ListInventoryConfigurationsResult | None = None, **kwargs: Any)

Bases: ResultModel

The request for the ListBucketInventory operation.

list_inventory_configurations_result (ListInventoryConfigurationsResult, optional): The container that stores inventory configuration list.

class alibabacloud_oss_v2.models.bucket_inventory.ListInventoryConfigurationsResult(inventory_configurations: List[InventoryConfiguration] | None = None, is_truncated: bool | None = None, next_continuation_token: str | None = None, **kwargs: Any)

Bases: Model

The container that stores inventory configuration list.

inventory_configurations (List[InventoryConfiguration], optional): The container that stores inventory configurations. is_truncated (bool, optional): Specifies whether to list all inventory tasks configured for the bucket.Valid values: true and false- The value of false indicates that all inventory tasks configured for the bucket are listed.- The value of true indicates that not all inventory tasks configured for the bucket are listed. To list the next page of inventory configurations, set the continuation-token parameter in the next request to the value of the NextContinuationToken header in the response to the current request. next_continuation_token (str, optional): If the value of IsTruncated in the response is true and value of this header is not null, set the continuation-token parameter in the next request to the value of this header.

class alibabacloud_oss_v2.models.bucket_inventory.OptionalFields(fields: List[str | InventoryOptionalFieldType] | None = None, **kwargs: Any)

Bases: Model

The container that stores the configuration fields in inventory lists.

fields (List[Union[str, InventoryOptionalFieldType]], optional): The configuration fields that are included in inventory lists. Available configuration fields:* Size: the size of the object.* LastModifiedDate: the time when the object was last modified.* ETag: the ETag of the object. It is used to identify the content of the object.* StorageClass: the storage class of the object.* IsMultipartUploaded: specifies whether the object is uploaded by using multipart upload.* EncryptionStatus: the encryption status of the object.

class alibabacloud_oss_v2.models.bucket_inventory.PutBucketInventoryRequest(bucket: str = None, inventory_id: str = None, inventory_configuration: InventoryConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketInventory operation.

bucket (str, required): The name of the bucket. inventory_id (str, required): The name of the inventory. inventory_configuration (InventoryConfiguration, optional): Request body schema.

class alibabacloud_oss_v2.models.bucket_inventory.PutBucketInventoryResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketInventory operation.

class alibabacloud_oss_v2.models.bucket_inventory.SSEKMS(key_id: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the customer master key (CMK) used for SSE-KMS encryption.

key_id (str, optional): The ID of the key that is managed by Key Management Service (KMS).

alibabacloud_oss_v2.models.bucket_lifecycle module

class alibabacloud_oss_v2.models.bucket_lifecycle.DeleteBucketLifecycleRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketLifecycle operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_lifecycle.DeleteBucketLifecycleResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketLifecycle operation.

class alibabacloud_oss_v2.models.bucket_lifecycle.GetBucketLifecycleRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketLifecycle operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_lifecycle.GetBucketLifecycleResult(lifecycle_configuration: LifecycleConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketLifecycle operation.

lifecycle_configuration (LifecycleConfiguration, optional): The container that stores the lifecycle rules configured for the bucket.

class alibabacloud_oss_v2.models.bucket_lifecycle.LifecycleConfiguration(rules: List[LifecycleRule] | None = None, **kwargs: Any)

Bases: Model

The container that stores the lifecycle rules configured for the bucket.

rules (List[LifecycleRule], optional): The container that stores the lifecycle rules.

class alibabacloud_oss_v2.models.bucket_lifecycle.LifecycleRule(tags: List[Tag] | None = None, noncurrent_version_expiration: NoncurrentVersionExpiration | None = None, filter: LifecycleRuleFilter | None = None, id: str | None = None, expiration: LifecycleRuleExpiration | None = None, transitions: List[LifecycleRuleTransition] | None = None, noncurrent_version_transitions: List[NoncurrentVersionTransition] | None = None, atime_base: int | None = None, prefix: str | None = None, status: str | None = None, abort_multipart_upload: LifecycleRuleAbortMultipartUpload | None = None, **kwargs: Any)

Bases: Model

The container that stores lifecycle rules.* A lifecycle rule cannot be configured to convert the storage class of objects in an Archive bucket.* The period of time from when the objects expire to when the objects are deleted must be longer than the period of time from when the objects expire to when the storage class of the objects is converted to IA or Archive.

tags (List[Tag], optional): The tag of the objects to which the lifecycle rule applies. You can specify multiple tags. noncurrent_version_expiration (NoncurrentVersionExpiration, optional): The delete operation that you want OSS to perform on the previous versions of the objects that match the lifecycle rule when the previous versions expire. filter (LifecycleRuleFilter, optional): The container that stores the Not parameter that is used to filter objects. id (str, optional): The ID of the lifecycle rule. The ID can contain up to 255 characters. If you do not specify the ID, OSS automatically generates a unique ID for the lifecycle rule. expiration (LifecycleRuleExpiration, optional): The delete operation to perform on objects based on the lifecycle rule. For an object in a versioning-enabled bucket, the delete operation specified by this parameter is performed only on the current version of the object.The period of time from when the objects expire to when the objects are deleted must be longer than the period of time from when the objects expire to when the storage class of the objects is converted to IA or Archive. transitions (List[LifecycleRuleTransition], optional): The conversion of the storage class of objects that match the lifecycle rule when the objects expire. The storage class of the objects can be converted to IA, Archive, and ColdArchive. The storage class of Standard objects in a Standard bucket can be converted to IA, Archive, or Cold Archive. The period of time from when the objects expire to when the storage class of the objects is converted to Archive must be longer than the period of time from when the objects expire to when the storage class of the objects is converted to IA. For example, if the validity period is set to 30 for objects whose storage class is converted to IA after the validity period, the validity period must be set to a value greater than 30 for objects whose storage class is converted to Archive. Either Days or CreatedBeforeDate is required. noncurrent_version_transitions (List[NoncurrentVersionTransition], optional): The conversion of the storage class of previous versions of the objects that match the lifecycle rule when the previous versions expire. The storage class of the previous versions can be converted to IA or Archive. The period of time from when the previous versions expire to when the storage class of the previous versions is converted to Archive must be longer than the period of time from when the previous versions expire to when the storage class of the previous versions is converted to IA. atime_base (int, optional): Timestamp for when access tracking was enabled. prefix (str, optional): The prefix in the names of the objects to which the rule applies. The prefixes specified by different rules cannot overlap.* If Prefix is specified, this rule applies only to objects whose names contain the specified prefix in the bucket.* If Prefix is not specified, this rule applies to all objects in the bucket. status (str, optional): Specifies whether to enable the rule. Valid values:* Enabled: enables the rule. OSS periodically executes the rule.* Disabled: does not enable the rule. OSS ignores the rule. abort_multipart_upload (LifecycleRuleAbortMultipartUpload, optional): The delete operation that you want OSS to perform on the parts that are uploaded in incomplete multipart upload tasks when the parts expire.

class alibabacloud_oss_v2.models.bucket_lifecycle.LifecycleRuleAbortMultipartUpload(days: int | None = None, created_before_date: datetime | None = None, **kwargs: Any)

Bases: Model

The delete operation that you want OSS to perform on the parts that are uploaded in incomplete multipart upload tasks when the parts expire.

days (int, optional): The number of days from when the objects were last modified to when the lifecycle rule takes effect. created_before_date (datetime.datetime, optional): The date based on which the lifecycle rule takes effect. OSS performs the specified operation on data whose last modified date is earlier than this date. Specify the time in the ISO 8601 standard. The time must be at 00:00:00 in UTC.

class alibabacloud_oss_v2.models.bucket_lifecycle.LifecycleRuleExpiration(created_before_date: datetime | None = None, days: int | None = None, expired_object_delete_marker: bool | None = None, **kwargs: Any)

Bases: Model

The delete operation to perform on objects based on the lifecycle rule. For an object in a versioning-enabled bucket, the delete operation specified by this parameter is performed only on the current version of the object.The period of time from when the objects expire to when the objects are deleted must be longer than the period of time from when the objects expire to when the storage class of the objects is converted to IA or Archive.

created_before_date (datetime.datetime, optional): The date based on which the lifecycle rule takes effect. OSS performs the specified operation on data whose last modified date is earlier than this date. The value of this parameter is in the yyyy-MM-ddT00:00:00.000Z format.Specify the time in the ISO 8601 standard. The time must be at 00:00:00 in UTC. days (int, optional): The number of days from when the objects were last modified to when the lifecycle rule takes effect. expired_object_delete_marker (bool, optional): Specifies whether to automatically remove expired delete markers.* true: Expired delete markers are automatically removed. If you set this parameter to true, you cannot specify the Days or CreatedBeforeDate parameter.* false: Expired delete markers are not automatically removed. If you set this parameter to false, you must specify the Days or CreatedBeforeDate parameter.

class alibabacloud_oss_v2.models.bucket_lifecycle.LifecycleRuleFilter(object_size_greater_than: int | None = None, object_size_less_than: int | None = None, filter_not: List[LifecycleRuleNot] | None = None, **kwargs: Any)

Bases: Model

The container that stores the Not parameter that is used to filter objects.

object_size_greater_than (int, optional): This lifecycle rule only applies to files larger than this size. object_size_less_than (int, optional): This lifecycle rule only applies to files smaller than this size. filter_not (List[LifecycleRuleNot], optional): The condition that is matched by objects to which the lifecycle rule does not apply.

class alibabacloud_oss_v2.models.bucket_lifecycle.LifecycleRuleNot(prefix: str | None = None, tag: Tag | None = None, **kwargs: Any)

Bases: Model

The condition that is matched by objects to which the lifecycle rule does not apply.

prefix (str, optional): The prefix in the names of the objects to which the lifecycle rule does not apply. tag (Tag, optional): The tag of the objects to which the lifecycle rule does not apply.

class alibabacloud_oss_v2.models.bucket_lifecycle.LifecycleRuleTransition(created_before_date: datetime | None = None, days: int | None = None, storage_class: str | StorageClassType | None = None, is_access_time: bool | None = None, return_to_std_when_visit: bool | None = None, allow_small_file: bool | None = None, **kwargs: Any)

Bases: Model

The conversion of the storage class of objects that match the lifecycle rule when the objects expire. The storage class of the objects can be converted to IA, Archive, and ColdArchive. The storage class of Standard objects in a Standard bucket can be converted to IA, Archive, or Cold Archive. The period of time from when the objects expire to when the storage class of the objects is converted to Archive must be longer than the period of time from when the objects expire to when the storage class of the objects is converted to IA. For example, if the validity period is set to 30 for objects whose storage class is converted to IA after the validity period, the validity period must be set to a value greater than 30 for objects whose storage class is converted to Archive. Either Days or CreatedBeforeDate is required.

created_before_date (datetime.datetime, optional): The date based on which the lifecycle rule takes effect. OSS performs the specified operation on data whose last modified date is earlier than this date. Specify the time in the ISO 8601 standard. The time must be at 00:00:00 in UTC. days (int, optional): The number of days from when the objects were last modified to when the lifecycle rule takes effect. storage_class (str | StorageClassType, optional): The storage class to which objects are converted. Valid values:* IA* Archive* ColdArchive You can convert the storage class of objects in an IA bucket to only Archive or Cold Archive. is_access_time (bool, optional): Specifies whether the lifecycle rule applies to objects based on their last access time. Valid values:* true: The rule applies to objects based on their last access time.* false: The rule applies to objects based on their last modified time. return_to_std_when_visit (bool, optional): Specifies whether to convert the storage class of non-Standard objects back to Standard after the objects are accessed. This parameter takes effect only when the IsAccessTime parameter is set to true. Valid values:* true: converts the storage class of the objects to Standard.* false: does not convert the storage class of the objects to Standard. allow_small_file (bool, optional): Specifies whether to convert the storage class of objects whose sizes are less than 64 KB to IA, Archive, or Cold Archive based on their last access time. Valid values:* true: converts the storage class of objects that are smaller than 64 KB to IA, Archive, or Cold Archive. Objects that are smaller than 64 KB are charged as 64 KB. Objects that are greater than or equal to 64 KB are charged based on their actual sizes. If you set this parameter to true, the storage fees may increase.* false: does not convert the storage class of an object that is smaller than 64 KB.

class alibabacloud_oss_v2.models.bucket_lifecycle.NoncurrentVersionExpiration(noncurrent_days: int | None = None, **kwargs: Any)

Bases: Model

The delete operation that you want OSS to perform on the previous versions of the objects that match the lifecycle rule when the previous versions expire.

noncurrent_days (int, optional): The number of days from when the objects became previous versions to when the lifecycle rule takes effect.

class alibabacloud_oss_v2.models.bucket_lifecycle.NoncurrentVersionTransition(is_access_time: bool | None = None, return_to_std_when_visit: bool | None = None, allow_small_file: bool | None = None, noncurrent_days: int | None = None, storage_class: str | StorageClassType | None = None, **kwargs: Any)

Bases: Model

The conversion of the storage class of previous versions of the objects that match the lifecycle rule when the previous versions expire. The storage class of the previous versions can be converted to IA or Archive. The period of time from when the previous versions expire to when the storage class of the previous versions is converted to Archive must be longer than the period of time from when the previous versions expire to when the storage class of the previous versions is converted to IA.

is_access_time (bool, optional): Specifies whether the lifecycle rule applies to objects based on their last access time. Valid values:* true: The rule applies to objects based on their last access time.* false: The rule applies to objects based on their last modified time. return_to_std_when_visit (bool, optional): Specifies whether to convert the storage class of non-Standard objects back to Standard after the objects are accessed. This parameter takes effect only when the IsAccessTime parameter is set to true. Valid values:* true: converts the storage class of the objects to Standard.* false: does not convert the storage class of the objects to Standard. allow_small_file (bool, optional): Specifies whether to convert the storage class of objects whose sizes are less than 64 KB to IA, Archive, or Cold Archive based on their last access time. Valid values:* true: converts the storage class of objects that are smaller than 64 KB to IA, Archive, or Cold Archive. Objects that are smaller than 64 KB are charged as 64 KB. Objects that are greater than or equal to 64 KB are charged based on their actual sizes. If you set this parameter to true, the storage fees may increase.* false: does not convert the storage class of an object that is smaller than 64 KB. noncurrent_days (int, optional): The number of days from when the objects became previous versions to when the lifecycle rule takes effect. storage_class (str | StorageClassType, optional): The storage class to which objects are converted. Valid values:* IA* Archive* ColdArchive You can convert the storage class of objects in an IA bucket to only Archive or Cold Archive.

class alibabacloud_oss_v2.models.bucket_lifecycle.PutBucketLifecycleRequest(bucket: str = None, allow_same_action_overlap: str | None = None, lifecycle_configuration: LifecycleConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketLifecycle operation.

bucket (str, required): The name of the bucket. allow_same_action_overlap (str, optional): Specifies whether to allow overlapped prefixes. Valid values:true: Overlapped prefixes are allowed.false: Overlapped prefixes are not allowed. lifecycle_configuration (LifecycleConfiguration, optional): The container of the request body.

class alibabacloud_oss_v2.models.bucket_lifecycle.PutBucketLifecycleResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketLifecycle operation.

alibabacloud_oss_v2.models.bucket_logging module

class alibabacloud_oss_v2.models.bucket_logging.BucketLoggingStatus(logging_enabled: LoggingEnabled | None = None, **kwargs: Any)

Bases: Model

Indicates the container used to store access logging configuration of a bucket.

logging_enabled (LoggingEnabled, optional): Indicates the container used to store access logging information. This element is returned if it is enabled and is not returned if it is disabled.

class alibabacloud_oss_v2.models.bucket_logging.DeleteBucketLoggingRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketLogging operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_logging.DeleteBucketLoggingResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketLogging operation.

class alibabacloud_oss_v2.models.bucket_logging.DeleteUserDefinedLogFieldsConfigRequest(bucket: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteUserDefinedLogFieldsConfig operation.

bucket (str, optional):

class alibabacloud_oss_v2.models.bucket_logging.DeleteUserDefinedLogFieldsConfigResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteUserDefinedLogFieldsConfig operation.

class alibabacloud_oss_v2.models.bucket_logging.GetBucketLoggingRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketLogging operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_logging.GetBucketLoggingResult(bucket_logging_status: BucketLoggingStatus | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketLogging operation.

bucket_logging_status (BucketLoggingStatus, optional): Indicates the container used to store access logging configuration of a bucket.

class alibabacloud_oss_v2.models.bucket_logging.GetUserDefinedLogFieldsConfigRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetUserDefinedLogFieldsConfig operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_logging.GetUserDefinedLogFieldsConfigResult(user_defined_log_fields_configuration: UserDefinedLogFieldsConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetUserDefinedLogFieldsConfig operation.

user_defined_log_fields_configuration (UserDefinedLogFieldsConfiguration, optional): The container for the user-defined logging configuration.

class alibabacloud_oss_v2.models.bucket_logging.LoggingEnabled(target_bucket: str | None = None, target_prefix: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the information about access log collection.

target_bucket (str, optional): The bucket that stores access logs. target_prefix (str, optional): The prefix of the log objects. This parameter can be left empty.

class alibabacloud_oss_v2.models.bucket_logging.LoggingHeaderSet(headers: List[str] | None = None, **kwargs: Any)

Bases: Model

The container that stores the configurations of custom request headers.

headers (List[str], optional): The list of the custom request headers.

class alibabacloud_oss_v2.models.bucket_logging.LoggingParamSet(parameters: List[str] | None = None, **kwargs: Any)

Bases: Model

The container that stores the configurations of custom URL parameters.

parameters (List[str], optional): The list of the custom URL parameters.

class alibabacloud_oss_v2.models.bucket_logging.PutBucketLoggingRequest(bucket: str = None, bucket_logging_status: BucketLoggingStatus | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketLogging operation.

bucket (str, required): The name of the bucket. bucket_logging_status (BucketLoggingStatus, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_logging.PutBucketLoggingResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketLogging operation.

class alibabacloud_oss_v2.models.bucket_logging.PutUserDefinedLogFieldsConfigRequest(bucket: str = None, user_defined_log_fields_configuration: UserDefinedLogFieldsConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutUserDefinedLogFieldsConfig operation.

bucket (str, required): The name of the bucket. user_defined_log_fields_configuration (UserDefinedLogFieldsConfiguration, optional): The container that stores the specified log configurations.

class alibabacloud_oss_v2.models.bucket_logging.PutUserDefinedLogFieldsConfigResult(**kwargs: Any)

Bases: ResultModel

The request for the PutUserDefinedLogFieldsConfig operation.

class alibabacloud_oss_v2.models.bucket_logging.UserDefinedLogFieldsConfiguration(header_set: LoggingHeaderSet | None = None, param_set: LoggingParamSet | None = None, **kwargs: Any)

Bases: Model

The specified field configurations of real-time logs in a bucket.

header_set (HeaderSet, optional): The container that stores the configurations of custom request headers. param_set (ParamSet, optional): The container that stores the configurations of custom URL parameters.

alibabacloud_oss_v2.models.bucket_meta_query module

class alibabacloud_oss_v2.models.bucket_meta_query.CloseMetaQueryRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the CloseMetaQuery operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_meta_query.CloseMetaQueryResult(**kwargs: Any)

Bases: ResultModel

The request for the CloseMetaQuery operation.

class alibabacloud_oss_v2.models.bucket_meta_query.DoMetaQueryRequest(bucket: str = None, meta_query: MetaQuery | None = None, **kwargs: Any)

Bases: RequestModel

The request for the DoMetaQuery operation.

bucket (str, required): The name of the bucket. meta_query (MetaQuery, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_meta_query.DoMetaQueryResult(files: MetaQueryFiles | None = None, aggregations: MetaQueryAggregations | None = None, next_token: str | None = None, **kwargs: Any)

Bases: ResultModel

The request for the DoMetaQuery operation.

files (Files, optional): The list of file information. aggregations (Aggregations, optional): The list of file information. next_token (str, optional): The token that is used for the next query when the total number of objects exceeds the value of MaxResults.The value of NextToken is used to return the unreturned results in the next query.This parameter has a value only when not all objects are returned.

class alibabacloud_oss_v2.models.bucket_meta_query.GetMetaQueryStatusRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetMetaQueryStatus operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_meta_query.GetMetaQueryStatusResult(meta_query_status: MetaQueryStatus | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetMetaQueryStatus operation.

meta_query_status (MetaQueryStatus, optional): The container that stores the metadata information.

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQuery(aggregations: MetaQueryAggregations | None = None, next_token: str | None = None, max_results: int | None = None, query: str | None = None, sort: str | None = None, order: str | MetaQueryOrderType | None = None, **kwargs: Any)

Bases: Model

The container that stores the query conditions.

aggregations (Aggregations, optional): The container that stores the information about aggregate operations. next_token (str, optional): The pagination token used to obtain information in the next request. The object information is returned in alphabetical order starting from the value of NextToken. max_results (int, optional): The maximum number of objects to return. Valid values: 0 to 100. If this parameter is not set or is set to 0, up to 100 objects are returned. query (str, optional): The query conditions. A query condition includes the following elements:* Operation: the operator. Valid values: eq (equal to), gt (greater than), gte (greater than or equal to), lt (less than), lte (less than or equal to), match (fuzzy query), prefix (prefix query), and (AND), or (OR), and not (NOT).* Field: the field name.* Value: the field value.* SubQueries: the subquery conditions. Options that are included in this element are the same as those of simple query. You need to set subquery conditions only when Operation is set to and, or, or not. sort (str, optional): The field based on which the results are sorted. order (str | MetaQueryOrderType, optional): The sort order.

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQueryAggregation(field: str | None = None, operation: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the information about a single aggregate operation.

field (str, optional): operation (str, optional):

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQueryAggregations(aggregations: List[MetaQueryAggregation] | None = None, **kwargs: Any)

Bases: Model

The container that stores the information about aggregate operations.

aggregations (List[Aggregation], optional): The container that stores the information about aggregate operations.

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQueryFile(file_modified_time: str | None = None, etag: str | None = None, server_side_encryption: str | None = None, oss_tagging_count: int | None = None, oss_tagging: MetaQueryOSSTagging | None = None, oss_user_meta: MetaQueryOSSUserMeta | None = None, filename: str | None = None, size: int | None = None, oss_object_type: str | None = None, oss_storage_class: str | None = None, object_acl: str | None = None, oss_crc64: str | None = None, server_side_encryption_customer_algorithm: str | None = None, **kwargs: Any)

Bases: Model

File information.

file_modified_time (str, optional): The time when the object was last modified. etag (str, optional): The ETag of the object. server_side_encryption (str, optional): The server-side encryption algorithm used when the object was created. oss_tagging_count (int, optional): The number of the tags of the object. oss_tagging (OSSTagging, optional): The tags. oss_user_meta (OSSUserMeta, optional): The user metadata items. filename (str, optional): The full path of the object. size (int, optional): The object size. oss_object_type (str, optional): The type of the object.Valid values:

Multipart: The object is uploaded by using multipart upload. Symlink: The object is a symbolic link that was created by calling the PutSymlink operation. Appendable: The object is uploaded by using AppendObject. Normal: The object is uploaded by using PutObject.

oss_storage_class (str, optional): The storage class of the object.Valid values:

Archive: the Archive storage class. ColdArchive: the Cold Archive storage class. IA: the Infrequent Access (IA) storage class. Standard: The Standard storage class

object_acl (str, optional): The access control list (ACL) of the object.Valid values:

default: the ACL of the bucket. private: private. public-read: public-read. public-read-write: public-read-write.

oss_crc64 (str, optional): The CRC-64 value of the object. server_side_encryption_customer_algorithm (str, optional): The server-side encryption of the object.

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQueryFiles(file: MetaQueryFile | None = None, **kwargs: Any)

Bases: Model

The list of file information.

file (File, optional):

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQueryOSSTagging(taggings: List[MetaQueryTagging] | None = None, **kwargs: Any)

Bases: Model

The tags.

taggings (List[MetaQueryTagging], optional): The tags.

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQueryOSSUserMeta(user_metas: List[MetaQueryUserMeta] | None = None, **kwargs: Any)

Bases: Model

The user metadata items.

user_metas (List[UserMeta], optional): The user metadata items.

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQueryOrderType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

A short description of struct

ASC = 'asc'

DESC = 'desc'

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQueryStatus(create_time: str | None = None, update_time: str | None = None, state: str | None = None, phase: str | None = None, meta_query_mode: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the metadata information.

create_time (str, optional): The time when the metadata index library was created. The value follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ss+TIMEZONE format. YYYY-MM-DD indicates the year, month, and day. T indicates the beginning of the time element. HH:mm:ss indicates the hour, minute, and second. TIMEZONE indicates the time zone. update_time (str, optional): The time when the metadata index library was updated. The value follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ss+TIMEZONE format. YYYY-MM-DD indicates the year, month, and day. T indicates the beginning of the time element. HH:mm:ss indicates the hour, minute, and second. TIMEZONE indicates the time zone. state (str, optional): The status of the metadata index library. Valid values:- Ready: The metadata index library is being prepared after it is created.In this case, the metadata index library cannot be used to query data.- Stop: The metadata index library is paused.- Running: The metadata index library is running.- Retrying: The metadata index library failed to be created and is being created again.- Failed: The metadata index library failed to be created.- Deleted: The metadata index library is deleted. phase (str, optional): The scan type. Valid values:- FullScanning: Full scanning is in progress.- IncrementalScanning: Incremental scanning is in progress. meta_query_mode (str, optional): Retrieval modes: basic: Scalar search, semantic: Vector search.

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQueryTagging(key: str | None = None, value: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the tag information.

key (str, optional): The tag key. value (str, optional): The tag value.

class alibabacloud_oss_v2.models.bucket_meta_query.MetaQueryUserMeta(key: str | None = None, value: str | None = None, **kwargs: Any)

Bases: Model

The container that stores user metadata.

key (str, optional): The key of the user metadata item. value (str, optional): The value of the user metadata item.

class alibabacloud_oss_v2.models.bucket_meta_query.OpenMetaQueryRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the OpenMetaQuery operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_meta_query.OpenMetaQueryResult(**kwargs: Any)

Bases: ResultModel

The request for the OpenMetaQuery operation.

alibabacloud_oss_v2.models.bucket_policy module

class alibabacloud_oss_v2.models.bucket_policy.DeleteBucketPolicyRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketPolicy operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_policy.DeleteBucketPolicyResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketPolicy operation.

class alibabacloud_oss_v2.models.bucket_policy.GetBucketPolicyRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketPolicy operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_policy.GetBucketPolicyResult(body: str | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketPolicy operation.

body (io.ReadCloser, optional): <no value>

class alibabacloud_oss_v2.models.bucket_policy.GetBucketPolicyStatusRequest(bucket: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketPolicyStatus operation.

bucket (str, optional): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_policy.GetBucketPolicyStatusResult(policy_status: PolicyStatus | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketPolicyStatus operation.

policy_status (PolicyStatus, optional): The container that stores public access information.

class alibabacloud_oss_v2.models.bucket_policy.PolicyStatus(is_public: bool | None = None, **kwargs: Any)

Bases: Model

The container that stores public access information.

is_public (bool, optional): Indicates whether the current bucket policy allows public access.truefalse

class alibabacloud_oss_v2.models.bucket_policy.PutBucketPolicyRequest(bucket: str = None, body: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketPolicy operation.

bucket (str, required): The name of the bucket. body (str, required): The request parameters.

class alibabacloud_oss_v2.models.bucket_policy.PutBucketPolicyResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketPolicy operation.

alibabacloud_oss_v2.models.bucket_public_access_block module

class alibabacloud_oss_v2.models.bucket_public_access_block.DeleteBucketPublicAccessBlockRequest(bucket: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketPublicAccessBlock operation.

bucket (str, optional): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_public_access_block.DeleteBucketPublicAccessBlockResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketPublicAccessBlock operation.

class alibabacloud_oss_v2.models.bucket_public_access_block.GetBucketPublicAccessBlockRequest(bucket: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketPublicAccessBlock operation.

bucket (str, optional):

class alibabacloud_oss_v2.models.bucket_public_access_block.GetBucketPublicAccessBlockResult(public_access_block_configuration: PublicAccessBlockConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketPublicAccessBlock operation.

public_access_block_configuration (PublicAccessBlockConfiguration, optional): The container in which the Block Public Access configurations are stored.

class alibabacloud_oss_v2.models.bucket_public_access_block.PublicAccessBlockConfiguration(block_public_access: bool | None = None, **kwargs: Any)

Bases: Model

The container in which the Block Public Access configurations are stored.

block_public_access (bool, optional): Specifies whether to enable Block Public Access.true: enables Block Public Access.false (default): disables Block Public Access.

class alibabacloud_oss_v2.models.bucket_public_access_block.PutBucketPublicAccessBlockRequest(bucket: str | None = None, public_access_block_configuration: PublicAccessBlockConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketPublicAccessBlock operation.

bucket (str, optional): The name of the bucket. public_access_block_configuration (PublicAccessBlockConfiguration, optional): Request body.

class alibabacloud_oss_v2.models.bucket_public_access_block.PutBucketPublicAccessBlockResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketPublicAccessBlock operation.

alibabacloud_oss_v2.models.bucket_referer module

class alibabacloud_oss_v2.models.bucket_referer.GetBucketRefererRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketReferer operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_referer.GetBucketRefererResult(referer_configuration: RefererConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketReferer operation.

referer_configuration (RefererConfiguration, optional): The container that stores the hotlink protection configurations.

class alibabacloud_oss_v2.models.bucket_referer.PutBucketRefererRequest(bucket: str = None, referer_configuration: RefererConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketReferer operation.

bucket (str, required): The name of the bucket. referer_configuration (RefererConfiguration, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_referer.PutBucketRefererResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketReferer operation.

class alibabacloud_oss_v2.models.bucket_referer.RefererBlacklist(referers: List[str] | None = None, **kwargs: Any)

Bases: Model

The container that stores the Referer blacklist.

referers (List[str], optional): The addresses in the Referer blacklist.

class alibabacloud_oss_v2.models.bucket_referer.RefererConfiguration(allow_empty_referer: bool | None = None, allow_truncate_query_string: bool | None = None, truncate_path: bool | None = None, referer_list: RefererList | None = None, referer_blacklist: RefererBlacklist | None = None, **kwargs: Any)

Bases: Model

The container that stores the hotlink protection configurations.

allow_empty_referer (bool, optional): Specifies whether to allow a request whose Referer field is empty. Valid values:* true (default)* false allow_truncate_query_string (bool, optional): Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values:* true (default)* false truncate_path (bool, optional): Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values:* true* false referer_list (RefererList, optional): The container that stores the Referer whitelist. ****The PutBucketReferer operation overwrites the existing Referer whitelist with the Referer whitelist specified in RefererList. If RefererList is not specified in the request, which specifies that no Referer elements are included, the operation clears the existing Referer whitelist. referer_blacklist (RefererBlacklist, optional): The container that stores the Referer blacklist.

class alibabacloud_oss_v2.models.bucket_referer.RefererList(referers: List[str] | None = None, **kwargs: Any)

Bases: Model

The container that stores the Referer whitelist. ****The PutBucketReferer operation overwrites the existing Referer whitelist with the Referer whitelist specified in RefererList. If RefererList is not specified in the request, which specifies that no Referer elements are included, the operation clears the existing Referer whitelist.

referers (List[str], optional): The addresses in the Referer whitelist.

alibabacloud_oss_v2.models.bucket_replication module

class alibabacloud_oss_v2.models.bucket_replication.DeleteBucketReplicationRequest(bucket: str = None, replication_rules: ReplicationRules | None = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketReplication operation.

bucket (str, required): The name of the bucket. replication_rules (ReplicationRules, optional): The container of the request body.

class alibabacloud_oss_v2.models.bucket_replication.DeleteBucketReplicationResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketReplication operation.

class alibabacloud_oss_v2.models.bucket_replication.GetBucketReplicationLocationRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketReplicationLocation operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_replication.GetBucketReplicationLocationResult(replication_location: ReplicationLocation | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketReplicationLocation operation.

replication_location (ReplicationLocation, optional): The container that stores the region in which the destination bucket can be located.

class alibabacloud_oss_v2.models.bucket_replication.GetBucketReplicationProgressRequest(bucket: str = None, rule_id: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketReplicationProgress operation.

bucket (str, required): The name of the bucekt. rule_id (str, required): The ID of the data replication rule. You can call the GetBucketReplication operation to query the ID.

class alibabacloud_oss_v2.models.bucket_replication.GetBucketReplicationProgressResult(replication_progress: ReplicationProgress | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketReplicationProgress operation.

replication_progress (ReplicationProgress, optional): The container that is used to store the progress of data replication tasks.

class alibabacloud_oss_v2.models.bucket_replication.GetBucketReplicationRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketReplication operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_replication.GetBucketReplicationResult(replication_configuration: ReplicationConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketReplication operation.

replication_configuration (ReplicationConfiguration, optional): The container that stores data replication configurations.

class alibabacloud_oss_v2.models.bucket_replication.HistoricalObjectReplicationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

DISABLED = 'disabled'

ENABLED = 'enabled'

class alibabacloud_oss_v2.models.bucket_replication.LocationRTCConstraint(locations: List[str] | None = None, **kwargs: Any)

Bases: Model

The container that stores regions in which the RTC can be enabled.

locations (List[str], optional): The regions where RTC is supported.

class alibabacloud_oss_v2.models.bucket_replication.LocationTransferType(location: str | None = None, transfer_types: TransferTypes | None = None, **kwargs: Any)

Bases: Model

The container that stores regions in which the destination bucket can be located with the TransferType information.

location (str, optional): The regions in which the destination bucket can be located. transfer_types (TransferTypes, optional): The container that stores the transfer type.

class alibabacloud_oss_v2.models.bucket_replication.LocationTransferTypeConstraint(location_transfer_types: List[LocationTransferType] | None = None, **kwargs: Any)

Bases: Model

The container that stores regions in which the destination bucket can be located with TransferType specified.

location_transfer_types (List[LocationTransferType], optional): The container that stores regions in which the destination bucket can be located with the TransferType information.

class alibabacloud_oss_v2.models.bucket_replication.PutBucketReplicationRequest(bucket: str = None, replication_configuration: ReplicationConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketReplication operation.

bucket (str, required): The name of the bucket. replication_configuration (ReplicationConfiguration, optional): The container of the request body.

class alibabacloud_oss_v2.models.bucket_replication.PutBucketReplicationResult(replication_rule_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The request for the PutBucketReplication operation.

replication_rule_id (str, optional): <no value>

class alibabacloud_oss_v2.models.bucket_replication.PutBucketRtcRequest(bucket: str = None, rtc_configuration: RtcConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketRtc operation.

bucket (str, required): The name of the bucket. rtc_configuration (RtcConfiguration, optional): The container of the request body.

class alibabacloud_oss_v2.models.bucket_replication.PutBucketRtcResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketRtc operation.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationConfiguration(rules: List[ReplicationRule] | None = None, **kwargs: Any)

Bases: Model

The container that stores data replication configurations.

rules (List[ReplicationRule], optional): The container that stores the data replication rules.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationDestination(bucket: str | None = None, location: str | None = None, transfer_type: str | TransferType | None = None, **kwargs: Any)

Bases: Model

The container that stores the information about the destination bucket.

bucket (str, optional): The destination bucket to which data is replicated. location (str, optional): The region in which the destination bucket is located. transfer_type (str | TransferType, optional): The link that is used to transfer data during data replication. Valid values:* internal (default): the default data transfer link used in OSS.* oss_acc: the transfer acceleration link. You can set TransferType to oss_acc only when you create CRR rules.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationEncryptionConfiguration(replica_kms_key_id: str | None = None, **kwargs: Any)

Bases: Model

replica_kms_key_id (str, optional):

class alibabacloud_oss_v2.models.bucket_replication.ReplicationLocation(locations: List[str] | None = None, location_transfer_type_constraint: LocationTransferTypeConstraint | None = None, locationrtc_constraint: LocationRTCConstraint | None = None, **kwargs: Any)

Bases: Model

The container that stores the region in which the destination bucket can be located.

locations (List[str], optional): The regions in which the destination bucket can be located. location_transfer_type_constraint (LocationTransferTypeConstraint, optional): The container that stores regions in which the destination bucket can be located with TransferType specified. locationrtc_constraint (LocationRTCConstraint, optional): The container that stores regions in which the RTC can be enabled.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationPrefixSet(prefixs: List[str] | None = None, **kwargs: Any)

Bases: Model

The container that stores prefixes. You can specify up to 10 prefixes in each data replication rule.

prefixs (List[str], optional): The prefix that is used to specify the object that you want to replicate. Only objects whose names contain the specified prefix are replicated to the destination bucket.* The value of the Prefix parameter can be up to 1,023 characters in length.* If you specify the Prefix parameter in a data replication rule, OSS synchronizes new data and historical data based on the value of the Prefix parameter.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationProgress(rules: List[ReplicationProgressRule] | None = None, **kwargs: Any)

Bases: Model

The container that is used to store the progress of data replication tasks.

rules (List[ReplicationProgressRule], optional): The container that stores the progress of the data replication task corresponding to each data replication rule.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationProgressInformation(historical_object: str | None = None, new_object: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the progress of the data replication task. This parameter is returned only when the data replication task is in the doing state.

historical_object (str, optional): The percentage of the replicated historical data. This parameter is valid only when HistoricalObjectReplication is set to enabled. new_object (str, optional): The time used to determine whether data is replicated to the destination bucket. Data that is written to the source bucket before the time is replicated to the destination bucket. The value of this parameter is in the GMT format. Example: Thu, 24 Sep 2015 15:39:18 GMT.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationProgressRule(historical_object_replication: str | None = None, progress: ReplicationProgressInformation | None = None, id: str | None = None, prefix_set: ReplicationPrefixSet | None = None, action: str | None = None, destination: ReplicationDestination | None = None, status: str | None = None, **kwargs: Any)

Bases: Model

Information about the progress of the data replication task.

historical_object_replication (str, optional): Specifies whether to replicate historical data that exists before data replication is enabled from the source bucket to the destination bucket.* enabled (default): replicates historical data to the destination bucket.* disabled: ignores historical data and replicates only data uploaded to the source bucket after data replication is enabled for the source bucket. progress (Progress, optional): The container that stores the progress of the data replication task. This parameter is returned only when the data replication task is in the doing state. id (str, optional): The ID of the data replication rule. prefix_set (ReplicationPrefixSet, optional): The container that stores prefixes. You can specify up to 10 prefixes in each data replication rule. action (str, optional): The operations that are synchronized to the destination bucket.* ALL: PUT, DELETE, and ABORT operations are synchronized to the destination bucket.* PUT: Write operations are synchronized to the destination bucket, including PutObject, PostObject, AppendObject, CopyObject, PutObjectACL, InitiateMultipartUpload, UploadPart, UploadPartCopy, and CompleteMultipartUpload. destination (ReplicationDestination, optional): The container that stores the information about the destination bucket. status (str, optional): The status of the data replication task. Valid values:* starting: OSS creates a data replication task after a data replication rule is configured.* doing: The replication rule is effective and the replication task is in progress.* closing: OSS clears a data replication task after the corresponding data replication rule is deleted.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationRule(source_selection_criteria: ReplicationSourceSelectionCriteria | None = None, rtc: ReplicationTimeControl | None = None, destination: ReplicationDestination | None = None, historical_object_replication: str | HistoricalObjectReplicationType | None = None, sync_role: str | None = None, status: str | None = None, encryption_configuration: ReplicationEncryptionConfiguration | None = None, id: str | None = None, prefix_set: ReplicationPrefixSet | None = None, action: str | None = None, **kwargs: Any)

Bases: Model

The data replication rule configuration.

source_selection_criteria (ReplicationSourceSelectionCriteria, optional): The container that specifies other conditions used to filter the source objects that you want to replicate. Filter conditions can be specified only for source objects encrypted by using SSE-KMS. rtc (RTC, optional): The container that stores the status of the RTC feature. destination (ReplicationDestination, optional): The container that stores the information about the destination bucket. historical_object_replication (str | HistoricalObjectReplicationType, optional): Specifies whether to replicate historical data that exists before data replication is enabled from the source bucket to the destination bucket. Valid values:* enabled (default): replicates historical data to the destination bucket.* disabled: does not replicate historical data to the destination bucket. Only data uploaded to the source bucket after data replication is enabled for the source bucket is replicated. sync_role (str, optional): The role that you want to authorize OSS to use to replicate data. If you want to use SSE-KMS to encrypt the objects that are replicated to the destination bucket, you must specify this parameter. status (str, optional): The status of the data replication task. Valid values:* starting: OSS creates a data replication task after a data replication rule is configured.* doing: The replication rule is effective and the replication task is in progress.* closing: OSS clears a data replication task after the corresponding data replication rule is deleted. encryption_configuration (ReplicationEncryptionConfiguration, optional): The encryption configuration for the objects replicated to the destination bucket. If the Status parameter is set to Enabled, you must specify this parameter. id (str, optional): The ID of the rule. prefix_set (ReplicationPrefixSet, optional): The container that stores prefixes. You can specify up to 10 prefixes in each data replication rule. action (str, optional): The operations that can be synchronized to the destination bucket. If you configure Action in a data replication rule, OSS synchronizes new data and historical data based on the specified value of Action. You can set Action to one or more of the following operation types. Valid values:* ALL (default): PUT, DELETE, and ABORT operations are synchronized to the destination bucket.* PUT: Write operations are synchronized to the destination bucket, including PutObject, PostObject, AppendObject, CopyObject, PutObjectACL, InitiateMultipartUpload, UploadPart, UploadPartCopy, and CompleteMultipartUpload.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationRules(ids: List[str] | None = None, **kwargs: Any)

Bases: Model

The container that stores the data replication rule that you want to delete.

ids (List[str], optional): The ID of data replication rules that you want to delete. You can call the GetBucketReplication operation to obtain the ID.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationSourceSelectionCriteria(sse_kms_encrypted_objects: SseKmsEncryptedObjects | None = None, **kwargs: Any)

Bases: Model

The container that specifies other conditions used to filter the source objects that you want to replicate. Filter conditions can be specified only for source objects encrypted by using SSE-KMS.

sse_kms_encrypted_objects (SseKmsEncryptedObjects, optional): The container that is used to filter the source objects that are encrypted by using SSE-KMS. This parameter must be specified if the SourceSelectionCriteria parameter is specified in the data replication rule.

class alibabacloud_oss_v2.models.bucket_replication.ReplicationTimeControl(status: str | None = None, **kwargs: Any)

Bases: Model

The container that stores information about the Replication Time Control (RTC) status.

status (str, optional): Specifies whether to enable RTC.Valid values:* disabled * enabled

class alibabacloud_oss_v2.models.bucket_replication.RtcConfiguration(rtc: ReplicationTimeControl | None = None, id: str | None = None, **kwargs: Any)

Bases: Model

The container that stores Replication Time Control (RTC) configurations.

rtc (RTC, optional): The container that stores the status of RTC. id (str, optional): The ID of the data replication rule for which you want to configure RTC.

class alibabacloud_oss_v2.models.bucket_replication.SseKmsEncryptedObjects(status: str | StatusType | None = None, **kwargs: Any)

Bases: Model

The container that is used to filter the source objects that are encrypted by using SSE-KMS. This parameter must be specified if the SourceSelectionCriteria parameter is specified in the data replication rule.

status (str | StatusType, optional): Specifies whether to replicate objects that are encrypted by using SSE-KMS. Valid values:* Enabled* Disabled

class alibabacloud_oss_v2.models.bucket_replication.StatusType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

A short description of Status

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class alibabacloud_oss_v2.models.bucket_replication.TransferType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The link used to transfer data in CRR

INTERNAL = 'internal'

OSS_ACC = 'oss_acc'

class alibabacloud_oss_v2.models.bucket_replication.TransferTypes(types: List[str] | None = None, **kwargs: Any)

Bases: Model

The container that stores the transfer type.

types (List[str], optional): The data transfer type that is used to transfer data in data replication. Valid values:* internal (default): the default data transfer link used in OSS.* oss_acc: the link in which data transmission is accelerated. You can set TransferType to oss_acc only when you create CRR rules.

alibabacloud_oss_v2.models.bucket_request_payment module

class alibabacloud_oss_v2.models.bucket_request_payment.GetBucketRequestPaymentRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketRequestPayment operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_request_payment.GetBucketRequestPaymentResult(request_payment_configuration: RequestPaymentConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketRequestPayment operation.

request_payment_configuration (RequestPaymentConfiguration, optional): Indicates the container for the payer.

class alibabacloud_oss_v2.models.bucket_request_payment.PutBucketRequestPaymentRequest(bucket: str = None, request_payment_configuration: RequestPaymentConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketRequestPayment operation.

bucket (str, required): The name of the bucket. request_payment_configuration (RequestPaymentConfiguration, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_request_payment.PutBucketRequestPaymentResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketRequestPayment operation.

class alibabacloud_oss_v2.models.bucket_request_payment.RequestPaymentConfiguration(payer: str | None = None, **kwargs: Any)

Bases: Model

Indicates the container for the payer.

payer (str, optional): Indicates who pays the download and request fees.

alibabacloud_oss_v2.models.bucket_resource_group module

class alibabacloud_oss_v2.models.bucket_resource_group.BucketResourceGroupConfiguration(resource_group_id: str | None = None, **kwargs: Any)

Bases: Model

The configurations of the resource group to which the bucket belongs.

resource_group_id (str, optional): The ID of the resource group to which the bucket belongs.

class alibabacloud_oss_v2.models.bucket_resource_group.GetBucketResourceGroupRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketResourceGroup operation.

bucket (str, required): The name of the bucket that you want to query.

class alibabacloud_oss_v2.models.bucket_resource_group.GetBucketResourceGroupResult(bucket_resource_group_configuration: BucketResourceGroupConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketResourceGroup operation.

bucket_resource_group_configuration (BucketResourceGroupConfiguration, optional): The container that stores the ID of the resource group.

class alibabacloud_oss_v2.models.bucket_resource_group.PutBucketResourceGroupRequest(bucket: str | None = None, bucket_resource_group_configuration: BucketResourceGroupConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketResourceGroup operation.

bucket (str, optional): The bucket for which you want to modify the ID of the resource group. bucket_resource_group_configuration (BucketResourceGroupConfiguration, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_resource_group.PutBucketResourceGroupResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketResourceGroup operation.

alibabacloud_oss_v2.models.bucket_style module

class alibabacloud_oss_v2.models.bucket_style.DeleteStyleRequest(bucket: str = None, style_name: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteStyle operation.

bucket (str, required): The name of the bucket. style_name (str, required): The name of the image style.

class alibabacloud_oss_v2.models.bucket_style.DeleteStyleResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteStyle operation.

class alibabacloud_oss_v2.models.bucket_style.GetStyleRequest(bucket: str = None, style_name: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetStyle operation.

bucket (str, required): The name of the bucket. style_name (str, required): The name of the image style.

class alibabacloud_oss_v2.models.bucket_style.GetStyleResult(style: StyleInfo | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetStyle operation.

style (StyleInfo, optional): The container that stores the information about the image style.

class alibabacloud_oss_v2.models.bucket_style.ListStyleRequest(bucket: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ListStyle operation.

bucket (str, optional): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_style.ListStyleResult(style_list: StyleList | None = None, **kwargs: Any)

Bases: ResultModel

The request for the ListStyle operation.

style_list (StyleList, optional): The container that was used to query the information about image styles.

class alibabacloud_oss_v2.models.bucket_style.PutStyleRequest(bucket: str = None, style_name: str = None, category: str | None = None, style: StyleContent | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutStyle operation.

bucket (str, required): The name of the bucket. style_name (str, required): The name of the image style. category (str, optional): The category of the style. style (Style, optional): The container that stores the content information about the image style.

class alibabacloud_oss_v2.models.bucket_style.PutStyleResult(**kwargs: Any)

Bases: ResultModel

The request for the PutStyle operation.

class alibabacloud_oss_v2.models.bucket_style.StyleContent(content: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the content information about the image style.

content (str, optional): The content of the style.

class alibabacloud_oss_v2.models.bucket_style.StyleInfo(name: str | None = None, content: str | None = None, create_time: str | None = None, last_modify_time: str | None = None, category: str | None = None, **kwargs: Any)

Bases: Model

The container that stores style infomration.

name (str, optional): The style name. content (str, optional): The content of the style. create_time (str, optional): The time when the style was created. last_modify_time (str, optional): The time when the style was last modified. category (str, optional): The category of this style。 Invalid value：image、document、video。

class alibabacloud_oss_v2.models.bucket_style.StyleList(styles: List[StyleInfo] | None = None, **kwargs: Any)

Bases: Model

The container that was used to query the information about image styles.

styles (List[StyleInfo], optional): The list of styles.

alibabacloud_oss_v2.models.bucket_tags module

class alibabacloud_oss_v2.models.bucket_tags.DeleteBucketTagsRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketTags operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_tags.DeleteBucketTagsResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketTags operation.

class alibabacloud_oss_v2.models.bucket_tags.GetBucketTagsRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketTags operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_tags.GetBucketTagsResult(tagging: Tagging | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketTags operation.

tagging (Tagging, optional): The container that stores the returned tags of the bucket. If no tags are configured for the bucket, an XML message body is returned in which the Tagging element is empty.

class alibabacloud_oss_v2.models.bucket_tags.PutBucketTagsRequest(bucket: str = None, tagging: Tagging | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketTags operation.

bucket (str, required): The name of the bucket. tagging (Tagging, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_tags.PutBucketTagsResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketTags operation.

class alibabacloud_oss_v2.models.bucket_tags.Tagging(tag_set: TagSet | None = None, **kwargs: Any)

Bases: Model

The container that stores the returned tags of the bucket. If no tags are configured for the bucket, an XML message body is returned in which the Tagging element is empty.

tag_set (TagSet, optional): The container that stores the returned tags of the bucket.

alibabacloud_oss_v2.models.bucket_transfer_acceleration module

class alibabacloud_oss_v2.models.bucket_transfer_acceleration.GetBucketTransferAccelerationRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketTransferAcceleration operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_transfer_acceleration.GetBucketTransferAccelerationResult(transfer_acceleration_configuration: TransferAccelerationConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketTransferAcceleration operation.

transfer_acceleration_configuration (TransferAccelerationConfiguration, optional): The container that stores the transfer acceleration configurations.

class alibabacloud_oss_v2.models.bucket_transfer_acceleration.PutBucketTransferAccelerationRequest(bucket: str = None, transfer_acceleration_configuration: TransferAccelerationConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketTransferAcceleration operation.

bucket (str, required): The name of the bucket. transfer_acceleration_configuration (TransferAccelerationConfiguration, optional): The container of the request body.

class alibabacloud_oss_v2.models.bucket_transfer_acceleration.PutBucketTransferAccelerationResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketTransferAcceleration operation.

class alibabacloud_oss_v2.models.bucket_transfer_acceleration.TransferAccelerationConfiguration(enabled: bool | None = None, **kwargs: Any)

Bases: Model

The container that stores the transfer acceleration configurations.

enabled (bool, optional): Whether the transfer acceleration is enabled for this bucket.

alibabacloud_oss_v2.models.bucket_website module

class alibabacloud_oss_v2.models.bucket_website.DeleteBucketWebsiteRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteBucketWebsite operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_website.DeleteBucketWebsiteResult(**kwargs: Any)

Bases: ResultModel

The request for the DeleteBucketWebsite operation.

class alibabacloud_oss_v2.models.bucket_website.ErrorDocument(key: str | None = None, http_status: int | None = None, **kwargs: Any)

Bases: Model

The container that stores the default 404 page.

key (str, optional): The error page. http_status (int, optional): The HTTP status code returned with the error page.

class alibabacloud_oss_v2.models.bucket_website.GetBucketWebsiteRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketWebsite operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_website.GetBucketWebsiteResult(website_configuration: WebsiteConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketWebsite operation.

website_configuration (WebsiteConfiguration, optional): The containers of the website configuration.

class alibabacloud_oss_v2.models.bucket_website.IndexDocument(suffix: str | None = None, support_sub_dir: bool | None = None, type: int | None = None, **kwargs: Any)

Bases: Model

The container that stores the default homepage.

suffix (str, optional): The default homepage. support_sub_dir (bool, optional): Specifies whether to redirect the access to the default homepage of the subdirectory when the subdirectory is accessed. Valid values:* true: The access is redirected to the default homepage of the subdirectory.* false (default): The access is redirected to the default homepage of the root directory.For example, the default homepage is set to index.html, and bucket.oss-cn-hangzhou.aliyuncs.com/subdir/ is the site that you want to access. If SupportSubDir is set to false, the access is redirected to bucket.oss-cn-hangzhou.aliyuncs.com/index.html. If SupportSubDir is set to true, the access is redirected to bucket.oss-cn-hangzhou.aliyuncs.com/subdir/index.html. type (int, optional): The operation to perform when the default homepage is set, the name of the accessed object does not end with a forward slash (/), and the object does not exist. This parameter takes effect only when SupportSubDir is set to true. It takes effect after RoutingRule but before ErrorFile. For example, the default homepage is set to index.html, bucket.oss-cn-hangzhou.aliyuncs.com/abc is the site that you want to access, and the abc object does not exist. In this case, different operations are performed based on the value of Type.* 0 (default): OSS checks whether the object named abc/index.html, which is in the Object + Forward slash (/) + Homepage format, exists. If the object exists, OSS returns HTTP status code 302 and the Location header value that contains URL-encoded /abc/. The URL-encoded /abc/ is in the Forward slash (/) + Object + Forward slash (/) format. If the object does not exist, OSS returns HTTP status code 404 and continues to check ErrorFile.* 1: OSS returns HTTP status code 404 and the NoSuchKey error code and continues to check ErrorFile.* 2: OSS checks whether abc/index.html exists. If abc/index.html exists, the content of the object is returned. If abc/index.html does not exist, OSS returns HTTP status code 404 and continues to check ErrorFile.

class alibabacloud_oss_v2.models.bucket_website.MirrorHeaders(pass_all: bool | None = None, passs: List[str] | None = None, removes: List[str] | None = None, sets: List[MirrorHeadersSet] | None = None, **kwargs: Any)

Bases: Model

The headers contained in the response that is returned when you use mirroring-based back-to-origin. This parameter takes effect only when the value of RedirectType is Mirror.

pass_all (bool, optional): Specifies whether to pass through all request headers other than the following headers to the origin. This parameter takes effect only when the value of RedirectType is Mirror.* Headers such as content-length, authorization2, authorization, range, and date* Headers that start with oss-, x-oss-, and x-drs-Default value: false.Valid values:* true * false passs (List[str], optional): The headers to pass through to the origin. This parameter takes effect only when the value of RedirectType is Mirror. Each specified header can be up to 1,024 bytes in length and can contain only letters, digits, and hyphens (-). You can specify up to 10 headers. removes (List[str], optional): The headers that are not allowed to pass through to the origin. This parameter takes effect only when the value of RedirectType is Mirror. Each header can be up to 1,024 bytes in length and can contain only letters, digits, and hyphens (-). You can specify up to 10 headers. This parameter is used together with PassAll. sets (List[Set], optional): The headers that are sent to the origin. The specified headers are configured in the data returned by the origin regardless of whether the headers are contained in the request. This parameter takes effect only when the value of RedirectType is Mirror. You can specify up to 10 headers.

class alibabacloud_oss_v2.models.bucket_website.MirrorHeadersSet(key: str | None = None, value: str | None = None, **kwargs: Any)

Bases: Model

The headers that are sent to the origin. The specified headers are configured in the data returned by the origin regardless of whether the headers are contained in the request. This parameter takes effect only when the value of RedirectType is Mirror. You can specify up to 10 headers.

key (str, optional): The key of the header. The key can be up to 1,024 bytes in length and can contain only letters, digits, and hyphens (-). This parameter takes effect only when the value of RedirectType is Mirror. This parameter must be specified if Set is specified. value (str, optional): The value of the header. The value can be up to 1,024 bytes in length and cannot contain `

`. This parameter takes effect only when the value of RedirectType is Mirror. This parameter must be specified if Set is specified.

class alibabacloud_oss_v2.models.bucket_website.PutBucketWebsiteRequest(bucket: str = None, website_configuration: WebsiteConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutBucketWebsite operation.

bucket (str, required): The name of the bucket. website_configuration (WebsiteConfiguration, optional): The request body schema.

class alibabacloud_oss_v2.models.bucket_website.PutBucketWebsiteResult(**kwargs: Any)

Bases: ResultModel

The request for the PutBucketWebsite operation.

class alibabacloud_oss_v2.models.bucket_website.RoutingRule(rule_number: int | None = None, condition: RoutingRuleCondition | None = None, redirect: RoutingRuleRedirect | None = None, **kwargs: Any)

Bases: Model

The container for the redirection rule or mirroring-based back-to-origin rule. You can specify up to 20 rules.

rule_number (int, optional): The sequence number that is used to match and run the redirection rules. OSS matches redirection rules based on this parameter. If a match succeeds, only the rule is run and the subsequent rules are not run. This parameter must be specified if RoutingRule is specified. condition (RoutingRuleCondition, optional): The matching condition. If all of the specified conditions are met, the rule is run. A rule is considered matched only when the rule meets the conditions that are specified by all nodes in Condition. This parameter must be specified if RoutingRule is specified. redirect (RoutingRuleRedirect, optional): The operation to perform after the rule is matched. This parameter must be specified if RoutingRule is specified.

class alibabacloud_oss_v2.models.bucket_website.RoutingRuleCondition(key_suffix_equals: str | None = None, http_error_code_returned_equals: int | None = None, include_headers: List[RoutingRuleIncludeHeader] | None = None, key_prefix_equals: str | None = None, **kwargs: Any)

Bases: Model

The matching condition. If all of the specified conditions are met, the rule is run. A rule is considered matched only when the rule meets the conditions that are specified by all nodes in Condition. This parameter must be specified if RoutingRule is specified.

key_suffix_equals (str, optional): 只有匹配此后缀的Object才能匹配此规则。 http_error_code_returned_equals (int, optional): The HTTP status code. The rule is matched only when the specified object is accessed and the specified HTTP status code is returned. If the redirection rule is the mirroring-based back-to-origin rule, the value of this parameter is 404. include_headers (List[IncludeHeader], optional): 只有请求中包含了指定Header且值为指定值时，才能匹配此规则。该容器最多可指定10个。 key_prefix_equals (str, optional): The prefix of object names. Only objects whose names contain the specified prefix match the rule.

class alibabacloud_oss_v2.models.bucket_website.RoutingRuleIncludeHeader(key: str | None = None, equals: str | None = None, **kwargs: Any)

Bases: Model

只有请求中包含了指定Header且值为指定值时，才能匹配此规则。该容器最多可指定10个。

key (str, optional): 只有请求中包含了此Header且值为Equals的指定值时，才能匹配此规则。 equals (str, optional): 只有请求中包含了Key指定的Header且值为指定值时，才能匹配此规则。

class alibabacloud_oss_v2.models.bucket_website.RoutingRuleRedirect(mirror_url: str | None = None, replace_key_with: str | None = None, enable_replace_prefix: bool | None = None, pass_query_string: bool | None = None, mirror_headers: MirrorHeaders | None = None, http_redirect_code: int | None = None, mirror_sni: bool | None = None, protocol: str | None = None, replace_key_prefix_with: str | None = None, redirect_type: str | None = None, mirror_pass_query_string: bool | None = None, host_name: str | None = None, mirror_follow_redirect: bool | None = None, mirror_check_md5: bool | None = None, mirror_pass_original_slashes: bool | None = None, **kwargs: Any)

Bases: Model

The operation to perform after the rule is matched. This parameter must be specified if RoutingRule is specified.

mirror_url (str, optional): The origin URL for mirroring-based back-to-origin. This parameter takes effect only when the value of RedirectType is Mirror. The origin URL must start with http:// or https:// and end with a forward slash (/). OSS adds an object name to the end of the URL to generate a back-to-origin URL. For example, the name of the object to access is myobject. If MirrorURL is set to http://example.com/, the back-to-origin URL is http://example.com/myobject. If MirrorURL is set to http://example.com/dir1/, the back-to-origin URL is http://example.com/dir1/myobject. This parameter must be specified if RedirectType is set to Mirror.Valid values:* true * false replace_key_with (str, optional): The string that is used to replace the requested object name when the request is redirected. This parameter can be set to the ${key} variable, which indicates the object name in the request. For example, if ReplaceKeyWith is set to prefix/${key}.suffix and the object to access is test, the value of the Location header is http://example.com/prefix/test.suffix. enable_replace_prefix (bool, optional): If this parameter is set to true, the prefix of the object names is replaced with the value specified by ReplaceKeyPrefixWith. If this parameter is not specified or empty, the prefix of object names is truncated. When the ReplaceKeyWith parameter is not empty, the EnableReplacePrefix parameter cannot be set to true.Default value: false. pass_query_string (bool, optional): Specifies whether to include parameters of the original request in the redirection request when the system runs the redirection rule or mirroring-based back-to-origin rule. For example, if the PassQueryString parameter is set to true, the ?a=b&c=d parameter string is included in a request sent to OSS, and the redirection mode is 302, this parameter is added to the Location header. For example, if the request is Location:example.com?a=b&c=d and the redirection type is mirroring-based back-to-origin, the ?a=b&c=d parameter string is also included in the back-to-origin request. Valid values: true and false (default). mirror_headers (MirrorHeaders, optional): The headers contained in the response that is returned when you use mirroring-based back-to-origin. This parameter takes effect only when the value of RedirectType is Mirror. http_redirect_code (int, optional): The HTTP redirect code in the response. This parameter takes effect only when RedirectType is set to External or AliCDN. Valid values: 301, 302, and 307. mirror_sni (bool, optional): 是否透传SNI protocol (str, optional): The protocol used for redirection. This parameter takes effect only when RedirectType is set to External or AliCDN. For example, if you access an object named test, Protocol is set to https, and Hostname is set to example.com, the value of the Location header is https://example.com/test. Valid values: http and https. replace_key_prefix_with (str, optional): The string that is used to replace the prefix of the object name during redirection. If the prefix of an object name is empty, the string precedes the object name. You can specify only one of the ReplaceKeyWith and ReplaceKeyPrefixWith parameters in a rule. For example, if you access an object named abc/test.txt, KeyPrefixEquals is set to abc/, ReplaceKeyPrefixWith is set to def/, the value of the Location header is http://example.com/def/test.txt. redirect_type (str, optional): The redirection type. Valid values:* Mirror: mirroring-based back-to-origin.* External: external redirection. OSS returns an HTTP 3xx status code and returns an address for you to redirect to.* AliCDN: redirection based on Alibaba Cloud CDN. Compared with external redirection, OSS adds an additional header to the request. After Alibaba Cloud CDN identifies the header, Alibaba Cloud CDN redirects the access to the specified address and returns the obtained data instead of the HTTP 3xx status code that redirects the access to another address. This parameter must be specified if Redirect is specified. mirror_pass_query_string (bool, optional): This parameter plays the same role as PassQueryString and has a higher priority than PassQueryString. This parameter takes effect only when the value of RedirectType is Mirror. Default value: false.Valid values:* true * false host_name (str, optional): The domain name used for redirection. The domain name must comply with the domain naming rules. For example, if you access an object named test, Protocol is set to https, and Hostname is set to example.com, the value of the Location header is https://example.com/test. mirror_follow_redirect (bool, optional): Specifies whether to redirect the access to the address specified by Location if the origin returns an HTTP 3xx status code. This parameter takes effect only when the value of RedirectType is Mirror. For example, when a mirroring-based back-to-origin request is initiated, the origin returns 302 and Location is specified.* If you set MirrorFollowRedirect to true, OSS continues requesting the resource at the address specified by Location. The access can be redirected up to 10 times. If the access is redirected more than 10 times, the mirroring-based back-to-origin request fails.* If you set MirrorFollowRedirect to false, OSS returns 302 and passes through Location.Default value: true. mirror_check_md5 (bool, optional): Specifies whether to check the MD5 hash of the body of the response returned by the origin. This parameter takes effect only when the value of RedirectType is Mirror. When MirrorCheckMd5 is set to true and the response returned by the origin includes the Content-Md5 header, OSS checks whether the MD5 hash of the obtained data matches the header value. If the MD5 hash of the obtained data does not match the header value, the obtained data is not stored in OSS. Default value: false. mirror_pass_original_slashes (bool, optional): 是否透传/到源站

class alibabacloud_oss_v2.models.bucket_website.RoutingRules(routing_rules: List[RoutingRule] | None = None, **kwargs: Any)

Bases: Model

The container that stores the redirection rules. You must specify at least one of the following containers: IndexDocument, ErrorDocument, and RoutingRules.

routing_rules (List[RoutingRule], optional): The specified redirection rule or mirroring-based back-to-origin rule. You can specify up to 20 rules.

class alibabacloud_oss_v2.models.bucket_website.WebsiteConfiguration(index_document: IndexDocument | None = None, error_document: ErrorDocument | None = None, routing_rules: RoutingRules | None = None, **kwargs: Any)

Bases: Model

The root node for website configuration.

index_document (IndexDocument, optional): The container that stores the default homepage. You must specify at least one of the following containers: IndexDocument, ErrorDocument, and RoutingRules. error_document (ErrorDocument, optional): The container that stores the default 404 page. You must specify at least one of the following containers: IndexDocument, ErrorDocument, and RoutingRules. routing_rules (RoutingRules, optional): The container that stores the redirection rules. You must specify at least one of the following containers: IndexDocument, ErrorDocument, and RoutingRules.

alibabacloud_oss_v2.models.bucket_worm module

class alibabacloud_oss_v2.models.bucket_worm.AbortBucketWormRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the AbortBucketWorm operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_worm.AbortBucketWormResult(**kwargs: Any)

Bases: ResultModel

The request for the AbortBucketWorm operation.

class alibabacloud_oss_v2.models.bucket_worm.BucketWormStateType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The status of the retention policy

IN_PROGRESS = 'InProgress'

LOCKED = 'Locked'

class alibabacloud_oss_v2.models.bucket_worm.CompleteBucketWormRequest(bucket: str = None, worm_id: str = None, **kwargs: Any)

Bases: RequestModel

The request for the CompleteBucketWorm operation.

bucket (str, required): The name of the bucket. worm_id (str, required): The ID of the retention policy.

class alibabacloud_oss_v2.models.bucket_worm.CompleteBucketWormResult(**kwargs: Any)

Bases: ResultModel

The request for the CompleteBucketWorm operation.

class alibabacloud_oss_v2.models.bucket_worm.ExtendBucketWormRequest(bucket: str = None, worm_id: str = None, extend_worm_configuration: ExtendWormConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ExtendBucketWorm operation.

bucket (str, required): The name of the bucket. worm_id (str, required): The ID of the retention policy. If the ID of the retention policy that specifies the number of days for which objects can be retained does not exist, the HTTP status code 404 is returned. extend_worm_configuration (ExtendWormConfiguration, optional): The container of the request body.

class alibabacloud_oss_v2.models.bucket_worm.ExtendBucketWormResult(**kwargs: Any)

Bases: ResultModel

The request for the ExtendBucketWorm operation.

class alibabacloud_oss_v2.models.bucket_worm.ExtendWormConfiguration(retention_period_in_days: int | None = None, **kwargs: Any)

Bases: Model

The container that stores the root node.

retention_period_in_days (int, optional): The number of days for which objects can be retained.

class alibabacloud_oss_v2.models.bucket_worm.GetBucketWormRequest(bucket: str = None, **kwargs: Any)

Bases: RequestModel

The request for the GetBucketWorm operation.

bucket (str, required): The name of the bucket.

class alibabacloud_oss_v2.models.bucket_worm.GetBucketWormResult(worm_configuration: WormConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetBucketWorm operation.

worm_configuration (WormConfiguration, optional): The container that stores the information about retention policies of the bucket.

class alibabacloud_oss_v2.models.bucket_worm.InitiateBucketWormRequest(bucket: str = None, initiate_worm_configuration: InitiateWormConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the InitiateBucketWorm operation.

bucket (str, required): The name of the bucket. initiate_worm_configuration (InitiateWormConfiguration, optional): The container of the request body.

class alibabacloud_oss_v2.models.bucket_worm.InitiateBucketWormResult(worm_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The request for the InitiateBucketWorm operation.

worm_id (str, optional): <no value>

class alibabacloud_oss_v2.models.bucket_worm.InitiateWormConfiguration(retention_period_in_days: int | None = None, **kwargs: Any)

Bases: Model

The container that stores the root node.

retention_period_in_days (int, optional): The number of days for which objects can be retained.

class alibabacloud_oss_v2.models.bucket_worm.WormConfiguration(worm_id: str | None = None, state: str | BucketWormStateType | None = None, retention_period_in_days: int | None = None, creation_date: str | None = None, expiration_date: str | None = None, **kwargs: Any)

Bases: Model

The container that stores the information about retention policies of the bucket.

worm_id (str, optional): The ID of the retention policy.Note If the specified retention policy ID that is used to query the retention policy configurations of the bucket does not exist, OSS returns the 404 error code. state (str | BucketWormStateType, optional): The status of the retention policy. Valid values:- InProgress: indicates that the retention policy is in the InProgress state. By default, a retention policy is in the InProgress state after it is created. The policy remains in this state for 24 hours.- Locked: indicates that the retention policy is in the Locked state. retention_period_in_days (int, optional): The number of days for which objects can be retained. creation_date (str, optional): The time at which the retention policy was created. expiration_date (str, optional): The time at which the retention policy will be expired.

alibabacloud_oss_v2.models.enums module

Enum for operation APIs

class alibabacloud_oss_v2.models.enums.BucketACLType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The access control list (ACL) of the bucket.

PRIVATE = 'private'

Only the bucket owner can perform read and write operations on objects in the bucket. Other users cannot access the objects in the bucket.

PUBLICREAD = 'public-read'

Only the bucket owner can write data to objects in the bucket. Other users, including anonymous users, can only read objects in the bucket.

PUBLICREADWRITE = 'public-read-write'

All users, including anonymous users, can perform read and write operations on the bucket.

class alibabacloud_oss_v2.models.enums.DataRedundancyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The redundancy type of the bucket.

LRS = 'LRS'

LRS Locally redundant storage(LRS) stores copies of each object across different devices in the same zone. This ensures data reliability and availability even if two storage devices are damaged at the same time.

ZRS = 'ZRS'

ZRS Zone-redundant storage(ZRS) uses the multi-zone mechanism to distribute user data across multiple zones in the same region. If one zone becomes unavailable, you can continue to access the data that is stored in other zones.

class alibabacloud_oss_v2.models.enums.ObjectACLType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The access control list(ACL) of the object.

DEFAULT = 'default'

The ACL of the object is the same as that of the bucket in which the object is stored.

PRIVATE = 'private'

Only the object owner is allowed to perform read and write operations on the object. Other users cannot access the object.

PUBLICREAD = 'public-read'

Only the object owner can write data to the object. Other users, including anonymous users, can only read the object.

PUBLICREADWRITE = 'public-read-write'

All users, including anonymous users, can perform read and write operations on the object.

class alibabacloud_oss_v2.models.enums.StorageClassType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The storage class of the bucket.

ARCHIVE = 'Archive'

Archive provides high-durability storage at lower prices compared with Standard and IA. It has a minimum billable size of 64 KB and a minimum billable storage duration of 60 days.

COLDARCHIVE = 'ColdArchive'

Cold Archive provides highly durable storage at lower prices compared with Archive. It has a minimum billable size of 64 KB and a minimum billable storage duration of 180 days.

DEEPCOLDARCHIVE = 'DeepColdArchive'

Deep Cold Archive provides highly durable storage at lower prices compared with Cold Archive. It has a minimum billable size of 64 KB and a minimum billable storage duration of 180 days.

IA = 'IA'

IA provides highly durable storage at lower prices compared with Standard. It has a minimum billable size of 64 KB and a minimum billable storage duration of 30 days.

STANDARD = 'Standard'

Standard provides highly reliable, highly available and high-performance object storage for data that is frequently accessed.

alibabacloud_oss_v2.models.object_basic module

Models for object operation APIs

class alibabacloud_oss_v2.models.object_basic.AbortMultipartUploadRequest(bucket: str = None, key: str = None, upload_id: str = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the AbortMultipartUpload operation.

Parameters:

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

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

• upload_id (str, optional) – The ID of the multipart upload task.

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

class alibabacloud_oss_v2.models.object_basic.AbortMultipartUploadResult(**kwargs: Any)

Bases: ResultModel

The result for the AbortMultipartUpload operation.

class alibabacloud_oss_v2.models.object_basic.AppendObjectRequest(bucket: str = None, key: str = None, position: int = None, acl: str | None = None, storage_class: str | None = None, metadata: MutableMapping | None = None, cache_control: str | None = None, content_disposition: str | None = None, content_encoding: str | None = None, content_length: int | None = None, content_md5: str | None = None, content_type: str | None = None, expires: str | None = None, server_side_encryption: str | None = None, server_side_data_encryption: str | None = None, server_side_encryption_key_id: str | None = None, tagging: str | None = None, forbid_overwrite: bool | None = None, traffic_limit: int | None = None, request_payer: str | None = None, body: str | bytes | Iterable[bytes] | IO[str] | IO[bytes] | None = None, progress_fn: Any | None = None, **kwargs: Any)

Bases: RequestModel

The request for the AppendObject operation.

Parameters:

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

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

• position (str, required) – The position from which the AppendObject operation starts. Each time an AppendObject operation succeeds, the x-oss-next-append-position header is included in the response to specify the position from which the next AppendObject operation starts.

• acl (str, optional) – The access control list (ACL) of the object.

• storage_class (str, optional) – The storage class of the object.

• (MutableMapping (metadata)

• upload. (The metadata of the object that you want to)

• cache_control (str, optional) – The caching behavior of the web page when the object is downloaded.

• content_disposition (str, optional) – The method that is used to access the object.

• content_encoding (str, optional) – The method that is used to encode the object.

• content_length (int, optional) – The size of the data in the HTTP message body. Unit: bytes.

• content_md5 (str, optional) – The MD5 hash of the object that you want to upload.

• content_type (str, optional) – A standard MIME type describing the format of the contents.

• expires (str, optional) – The expiration time of the cache in UTC.

• server_side_encryption (str, optional) – The encryption method on the server side when an object is created. Valid values: AES256 and KMS

• server_side_data_encryption (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS). This header is valid only when the x-oss-server-side-encryption header is set to KMS.

• server_side_encryption_key_id (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS).

• tagging (str, optional) – The tags that are specified for the object by using a key-value pair. You can specify multiple tags for an object. Example: TagA=A&TagB=B.

• callback (str, optional) – A callback parameter is a Base64-encoded string that contains multiple fields in the JSON format.

• callback_var (str, optional) – Configure custom parameters by using the callback-var parameter.

• forbid_overwrite (bool, optional) – Specifies whether the object that is uploaded by calling the PutObject operation overwrites an existing object that has the same name.

• traffic_limit (int, optional) – Specify the speed limit value. The speed limit value ranges from 245760 to 838860800, with a unit of bit/s.

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

• body (BodyType,optional) – Object data.

• progress_fn (Any,optional) – Progress callback function.

class alibabacloud_oss_v2.models.object_basic.AppendObjectResult(version_id: str | None = None, hash_crc64: str | None = None, next_position: int | None = None, server_side_encryption: str | None = None, server_side_data_encryption: str | None = None, server_side_encryption_key_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the AppendObject operation.

Parameters:

• version_id (str, optional) – Version of the object.

• hash_crc64 (str, optional) – The 64-bit CRC value of the object. This value is calculated based on the ECMA-182 standard.

• next_position (str, optional) – The position that must be provided in the next request, which is the current length of the object.

• server_side_encryption (str, optional) – The encryption method on the server side when an object is created. Valid values: AES256 and KMS

• server_side_data_encryption (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS). This header is valid only when the x-oss-server-side-encryption header is set to KMS.

• server_side_encryption_key_id (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS).

class alibabacloud_oss_v2.models.object_basic.AsyncProcessObjectRequest(bucket: str = None, key: str = None, process: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the AsyncProcessObject operation.

Parameters:

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

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

• process (str, required) – Image async processing parameters.

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

class alibabacloud_oss_v2.models.object_basic.AsyncProcessObjectResult(event_id: str | None = None, task_id: int | None = None, process_request_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the AsyncProcessObject operation.

Parameters:

• event_id (str, optional) – The id of event.

• task_id (str, optional) – The id of task.

• process_request_id (str, optional) – The request id of task.

class alibabacloud_oss_v2.models.object_basic.CleanRestoredObjectRequest(bucket: str = None, key: str = None, **kwargs: Any)

Bases: RequestModel

The request for the CleanRestoredObject operation.

bucket (str, required): The name of the bucket key (str, required): The name of the object.

class alibabacloud_oss_v2.models.object_basic.CleanRestoredObjectResult(**kwargs: Any)

Bases: ResultModel

The request for the CleanRestoredObject operation.

class alibabacloud_oss_v2.models.object_basic.CompleteMultipartUpload(parts: List[UploadPart] | None = None, **kwargs: Any)

Bases: Model

The container that stores the information about the uploaded parts.

parts ([UploadPart], optional): The uploaded parts.

class alibabacloud_oss_v2.models.object_basic.CompleteMultipartUploadRequest(bucket: str = None, key: str = None, upload_id: str = None, acl: str | None = None, complete_multipart_upload: CompleteMultipartUpload | None = None, complete_all: str | None = None, callback: str | None = None, callback_var: str | None = None, forbid_overwrite: bool | None = None, encoding_type: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the CompleteMultipartUpload operation.

Parameters:

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

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

• upload_id (str, optional) – The ID of the multipart upload task.

• acl (str, optional) – The access control list (ACL) of the object.

• complete_multipart_upload (CompleteMultipartUpload, optional) – The container that stores the content of the CompleteMultipartUpload

• complete_all (str, optional) – Specifies whether to list all parts that are uploaded by using the current upload ID. Valid value: yes

• callback (str, optional) – A callback parameter is a Base64-encoded string that contains multiple fields in the JSON format.

• callback_var (str, optional) – Configure custom parameters by using the callback-var parameter.

• forbid_overwrite (bool, optional) – Specifies whether the object that is uploaded by calling the PutObject operation overwrites an existing object that has the same name.

• encoding_type (str, optional) – The encoding type of the object names in the response. Valid value: url.

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

class alibabacloud_oss_v2.models.object_basic.CompleteMultipartUploadResult(bucket: str | None = None, key: str | None = None, location: str | None = None, etag: str | None = None, encoding_type: str | None = None, hash_crc64: str | None = None, version_id: str | None = None, callback_result: Dict | None = None, **kwargs: Any)

Bases: ResultModel

The result for the CompleteMultipartUpload operation.

Parameters:

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

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

• location (str, optional) – The URL that is used to access the uploaded object.

• etag (str, optional) – The ETag that is generated when an object is created. ETags are used to identify the content of objects.

• encoding_type (str, optional) – The encoding type of the name of the deleted object in the response. If encoding-type is specified in the request, the object name is encoded in the returned result.

• hash_crc64 (str, optional) – The 64-bit CRC value of the object. This value is calculated based on the ECMA-182 standard.

• version_id (str, optional) – Version of the object.

• callback_result (dict, optional) – Callback result, it is valid only when the callback is set.

class alibabacloud_oss_v2.models.object_basic.CopyObjectRequest(bucket: str = None, key: str = None, source_bucket: str | None = None, source_key: str | None = None, source_version_id: str | None = None, if_match: str | None = None, if_none_match: str | None = None, if_modified_since: str | None = None, if_unmodified_since: str | None = None, acl: str | None = None, storage_class: str | None = None, metadata: MutableMapping | None = None, cache_control: str | None = None, content_disposition: str | None = None, content_encoding: str | None = None, content_length: int | None = None, content_md5: str | None = None, content_type: str | None = None, expires: str | None = None, metadata_directive: str | None = None, server_side_encryption: str | None = None, server_side_data_encryption: str | None = None, server_side_encryption_key_id: str | None = None, tagging: str | None = None, tagging_directive: str | None = None, forbid_overwrite: bool | None = None, traffic_limit: int | None = None, request_payer: str | None = None, progress_fn: Any | None = None, **kwargs: Any)

Bases: RequestModel

The request for the CopyObject operation.

Parameters:

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

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

• source_bucket (str, optional) – The name of the source bucket.

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

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

• if_match (str, optional) – Specifies whether the object that is uploaded by calling the CopyObject operation overwrites an existing object that has the same name. Valid values: true and false

• if_none_match (str, optional) – If the ETag specified in the request does not match the ETag value of the object, the object and 200 OK are returned. Otherwise, 304 Not Modified is returned.

• if_modified_since (str, optional) – If the time specified in this header is earlier than the object modified time or is invalid, the object and 200 OK are returned. Otherwise, 304 Not Modified is returned. The time must be in GMT. Example: Fri, 13 Nov 2015 14:47:53 GMT.

• if_unmodified_since (str, optional) – If the time specified in this header is the same as or later than the object modified time, the object and 200 OK are returned. Otherwise, 412 Precondition Failed is returned. The time must be in GMT. Example: Fri, 13 Nov 2015 14:47:53 GMT.

• acl (str, optional) – The access control list (ACL) of the object.

• storage_class (str, optional) – The storage class of the object.

• (MutableMapping (metadata)

• upload. (The metadata of the object that you want to)

• cache_control (str, optional) – The caching behavior of the web page when the object is downloaded.

• content_disposition (str, optional) – The method that is used to access the object.

• content_encoding (str, optional) – The method that is used to encode the object.

• content_length (int, optional) – The size of the data in the HTTP message body. Unit: bytes.

• content_md5 (str, optional) – The MD5 hash of the object that you want to upload.

• content_type (str, optional) – A standard MIME type describing the format of the contents.

• expires (str, optional) – The expiration time of the cache in UTC.

• metadata_directive (str, optional) – The method that is used to configure the metadata of the destination object. COPY (default): The metadata of the source object is copied to the destination object. The configurations of the x-oss-server-side-encryption header of the source object header of the source object are not copied to the destination object. The x-oss-server-side-encryption header in the CopyObject request specifies the method used to encrypt the destination object. REPLACE: The metadata specified in the request is used as the metadata of the destination object.

• server_side_encryption (str, optional) – The encryption method on the server side when an object is created. Valid values: AES256 and KMS

• server_side_data_encryption (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS). This header is valid only when the x-oss-server-side-encryption header is set to KMS.

• server_side_encryption_key_id (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS).

• tagging (str, optional) – The tags that are specified for the object by using a key-value pair. You can specify multiple tags for an object. Example: TagA=A&TagB=B.

• tagging_directive (str, optional) – The method that is used to configure tags for the destination object. Valid values: Copy (default): The tags of the source object are copied to the destination object. Replace: The tags specified in the request are configured for the destination object.

• forbid_overwrite (bool, optional) – Specifies whether the object that is uploaded by calling the PutObject operation overwrites an existing object that has the same name.

• traffic_limit (int, optional) – Specify the speed limit value. The speed limit value ranges from 245760 to 838860800, with a unit of bit/s.

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

• progress_fn (Any,optional) – Progress callback function, it works in Copier.copy only.

class alibabacloud_oss_v2.models.object_basic.CopyObjectResult(version_id: str | None = None, hash_crc64: str | None = None, source_version_id: str | None = None, server_side_encryption: str | None = None, server_side_data_encryption: str | None = None, server_side_encryption_key_id: str | None = None, last_modified: datetime | None = None, etag: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the CopyObject operation.

Parameters:

• version_id (str, optional) – Version of the object.

• hash_crc64 (str, optional) – The 64-bit CRC value of the object. This value is calculated based on the ECMA-182 standard.

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

• server_side_encryption (str, optional) – The encryption method on the server side when an object is created. Valid values: AES256 and KMS

• server_side_data_encryption (str, optional) – The server side data encryption algorithm.

• server_side_encryption_key_id (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS).

• last_modified (str, optional) – The time when the returned objects were last modified.

• etag (str, optional) – The entity tag (ETag). An ETag is created when an object is created to identify the content of the object.

class alibabacloud_oss_v2.models.object_basic.DeleteMultipleObjectsRequest(bucket: str = None, encoding_type: str | None = None, objects: List[DeleteObject] | None = None, quiet: bool | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteMultipleObjects operation.

Parameters:

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

• encoding_type (str, optional) – The encoding type of the object names in the response. Valid value: url

• objects ([DeleteObject], optional) – The container that stores information about you want to delete objects.

• quiet (bool, optional) – Specifies whether to enable the Quiet return mode. The DeleteMultipleObjects operation provides the following return modes: Valid value: true,false

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

class alibabacloud_oss_v2.models.object_basic.DeleteMultipleObjectsResult(deleted_objects: List[DeletedInfo] | None = None, encoding_type: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the DeleteMultipleObjects operation.

deleted_objects ([DeletedInfo], optional): The container that stores information about the deleted objects. encoding_type (str, optional): The encoding type of the content in the response.

If encoding-type is specified in the request, the object name is encoded in the returned result.

class alibabacloud_oss_v2.models.object_basic.DeleteObject(key: str | None = None, version_id: str | None = None, **kwargs: Any)

Bases: Model

The information about a delete object.

key (str, optional): The name of the object that you want to delete. version_id (str, optional): The version ID of the object that you want to delete.

class alibabacloud_oss_v2.models.object_basic.DeleteObjectRequest(bucket: str = None, key: str = None, version_id: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteObject operation.

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.

class alibabacloud_oss_v2.models.object_basic.DeleteObjectResult(version_id: str | None = None, delete_marker: bool | None = None, **kwargs: Any)

Bases: ResultModel

The result for the DeleteObject operation.

Parameters:

• version_id (str, optional) – Version of the object.

• delete_marker (bool, optional) – Indicates whether the deleted version is a delete marker.

class alibabacloud_oss_v2.models.object_basic.DeleteObjectTaggingRequest(bucket: str = None, key: str = None, version_id: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the DeleteObjectTagging operation.

Parameters:

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

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

• version_id (str, optional) – VersionId used to reference a specific version of the object.

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

class alibabacloud_oss_v2.models.object_basic.DeleteObjectTaggingResult(version_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the DeleteObjectTagging operation.

Parameters:

version_id (str, optional) – Version of the object.

class alibabacloud_oss_v2.models.object_basic.DeletedInfo(key: str | None = None, version_id: str | None = None, delete_marker: bool | None = None, delete_marker_version_id: str | None = None, **kwargs: Any)

Bases: Model

The information about a delete object.

key (str, optional): The name of the deleted object. version_id (str, optional): The version ID of the object that you deleted. delete_marker (bool, optional): Indicates whether the deleted version is a delete marker. delete_marker_version_id (str, optional): The version ID of the delete marker.

class alibabacloud_oss_v2.models.object_basic.GetObjectAclRequest(bucket: str = None, key: str = None, version_id: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the GetObjectAcl operation.

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

class alibabacloud_oss_v2.models.object_basic.GetObjectAclResult(acl: str | None = None, owner: Owner | None = None, version_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the GetObjectAcl operation.

Parameters:

• acl (str, optional) – The ACL of the object. Default value: default.

• owner (Owner, optional) – The container that stores information about the object owner.

• version_id (str, optional) – Version of the object.

class alibabacloud_oss_v2.models.object_basic.GetObjectMetaRequest(bucket: str = None, key: str = None, version_id: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the GetObjectMeta operation.

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.

class alibabacloud_oss_v2.models.object_basic.GetObjectMetaResult(content_length: int | None = None, etag: str | None = None, last_modified: datetime | None = None, last_access_time: datetime | None = None, version_id: str | None = None, hash_crc64: str | None = None, transition_time: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the GetObjectMeta operation.

Parameters:

• content_length (int, optional) – Size of the body in bytes.

• etag (str, optional) – The entity tag (ETag). An ETag is created when an object is created to identify the content of the object.

• last_modified (datetime.datetime, optional) – The time when the returned objects were last modified.

• last_access_time (datetime.datetime, optional) – The time when the object was last accessed.

• version_id (str, optional) – Version of the object.

• hash_crc64 (str, optional) – The 64-bit CRC value of the object. This value is calculated based on the ECMA-182 standard.

• transition_time (str, optional) – The time when the storage class of the object is converted to Cold Archive or Deep Cold Archive based on lifecycle rules.

class alibabacloud_oss_v2.models.object_basic.GetObjectRequest(bucket: str = None, key: str = None, if_match: str | None = None, if_none_match: str | None = None, if_modified_since: str | None = None, if_unmodified_since: str | None = None, range_header: str | None = None, range_behavior: str | None = None, response_cache_control: str | None = None, response_content_disposition: str | None = None, response_content_encoding: str | None = None, response_content_language: str | None = None, response_content_type: str | None = None, response_expires: str | None = None, version_id: str | None = None, traffic_limit: int | None = None, process: str | None = None, request_payer: str | None = None, progress_fn: Any | None = None, **kwargs: Any)

Bases: RequestModel

The request for the GetObject operation.

Parameters:

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

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

• if_match (str, optional) – If the ETag specified in the request matches the ETag value of the object the object and 200 OK are returned. Otherwise, 412 Precondition Failed is returned.

• if_none_match (str, optional) – If the ETag specified in the request does not match the ETag value of the object, the object and 200 OK are returned. Otherwise, 304 Not Modified is returned.

• if_modified_since (str, optional) – If the time specified in this header is earlier than the object modified time or is invalid, the object and 200 OK are returned. Otherwise, 304 Not Modified is returned. The time must be in GMT. Example: Fri, 13 Nov 2015 14:47:53 GMT.

• if_unmodified_since (str, optional) – If the time specified in this header is the same as or later than the object modified time,the object and 200 OK are returned. Otherwise, 412 Precondition Failed is returned. The time must be in GMT. Example: Fri, 13 Nov 2015 14:47:53 GMT.

• range_header (str, optional) – The content range of the object to be returned. If the value of Range is valid, the total size of the object and the content range are returned. For example, Content-Range: bytes 0~9/44 indicates that the total size of the object is 44 bytes, and the range of data returned is the first 10 bytes. However, if the value of Range is invalid, the entire object is returned, and the response does not include the Content-Range parameter.

• range_behavior (str, optional) – Specify standard behaviors to download data by range. If the value is “standard”, the download behavior is modified when the specified range is not within the valid range. For an object whose size is 1,000 bytes: 1) If you set Range: bytes to 500-2000, the value at the end of the range is invalid. In this case, OSS returns HTTP status code 206 and the data that is within the range of byte 500 to byte 999. 2) If you set Range: bytes to 1000-2000, the value at the start of the range is invalid. In this case, OSS returns HTTP status code 416 and the InvalidRange error code.

• response_cache_control (str, optional) – The cache-control header to be returned in the response.

• response_content_disposition (str, optional) – The content-disposition header to be returned in the response.

• response_content_encoding (str, optional) – The content-encoding header to be returned in the response.

• response_content_language (str, optional) – The content-language header to be returned in the response.

• response_content_type (str, optional) – The content-type header to be returned in the response.

• response_expires (str, optional) – The expires header to be returned in the response.

• version_id (str, optional) – VersionId used to reference a specific version of the object.

• traffic_limit (int, optional) – Specify the speed limit value. The speed limit value ranges from 245760 to 838860800, with a unit of bit/s.

• process (str, optional) – Image processing parameters.

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

• progress_fn (Any, optional) – Progress callback function.

class alibabacloud_oss_v2.models.object_basic.GetObjectResult(content_length: int | None = None, content_range: str | None = None, content_type: str | None = None, etag: str | None = None, last_modified: datetime | None = None, content_md5: str | None = None, metadata: MutableMapping | None = None, cache_control: str | None = None, content_disposition: str | None = None, content_encoding: str | None = None, expires: str | None = None, hash_crc64: str | None = None, storage_class: str | None = None, object_type: str | None = None, version_id: str | None = None, tagging_count: int | None = None, server_side_encryption: str | None = None, server_side_data_encryption: str | None = None, server_side_encryption_key_id: str | None = None, next_append_position: str | None = None, expiration: str | None = None, restore: str | None = None, process_status: str | None = None, delete_marker: bool | None = None, body: StreamBody | None = None, **kwargs: Any)

Bases: ResultModel

The result for the GetObject operation.

Parameters:

• content_length (int, optional) – Size of the body in bytes.

• content_range (str, optional) – The portion of the object returned in the response.

• content_type (str, optional) – A standard MIME type describing the format of the object data.

• etag (str, optional) – The entity tag (ETag). An ETag is created when an object is created to identify the content of the object.

• last_modified (datetime.datetime, optional) – The time when the returned objects were last modified.

• content_md5 (str, optional) – Content-Md5 for the uploaded object.

• metadata (MutableMapping, optional) – A map of metadata to store with the object.

• cache_control (str, optional) – The caching behavior of the web page when the object is downloaded.

• content_disposition (str, optional) – The method that is used to access the object.

• content_encoding (str, optional) – The method that is used to encode the object.

• expires (str, optional) – The expiration time of the cache in UTC.

• hash_crc64 (str, optional) – The 64-bit CRC value of the object. This value is calculated based on the ECMA-182 standard.

• storage_class (str, optional) – The storage class of the object.

• object_type (str, optional) – The type of the object.

• version_id (str, optional) – Version of the object.

• tagging_count (int, optional) – The number of tags added to the object. This header is included in the response only when you have read permissions on tags.

• server_side_encryption (str, optional) – If the requested object is encrypted by using a server-side encryption algorithm based on entropy encoding, OSS automatically decrypts the object and returns the decrypted object after OSS receives the GetObject request. The x-oss-server-side-encryption header is included in the response to indicate the encryption algorithm used to encrypt the object on the server.

• server_side_data_encryption (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS).

• server_side_encryption_key_id (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS).

• next_append_position (str, optional) – The position for the next append operation. If the type of the object is Appendable, this header is included in the response.

• expiration (str, optional) – The lifecycle information about the object. If lifecycle rules are configured for the object, this header is included in the response. This header contains the following parameters: expiry-date that indicates the expiration time of the object, and rule-id that indicates the ID of the matched lifecycle rule.

• restore (str, optional) – The status of the object when you restore an object. If the storage class of the bucket is Archive and a RestoreObject request is submitted,

• process_status (str, optional) – The result of an event notification that is triggered for the object.

• delete_marker (bool, optional) – Specifies whether the object retrieved was (true) or was not (false) a Delete Marker.

• body (Any, optional) – Object data.

class alibabacloud_oss_v2.models.object_basic.GetObjectTaggingRequest(bucket: str = None, key: str = None, version_id: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the GetObjectTagging operation.

Parameters:

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

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

• version_id (str, optional) – VersionId used to reference a specific version of the object.

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

class alibabacloud_oss_v2.models.object_basic.GetObjectTaggingResult(version_id: str | None = None, tag_set: TagSet | None = None, **kwargs: Any)

Bases: ResultModel

The result for the GetObjectTagging operation.

Parameters:

• version_id (str, optional) – Version of the object.

• tag_set (TagSet, optional) – The collection of tags.

class alibabacloud_oss_v2.models.object_basic.GetSymlinkRequest(bucket: str = None, key: str = None, version_id: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the GetSymlink operation.

Parameters:

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

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

• version_id (str, optional) – VersionId used to reference a specific version of the object.

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

class alibabacloud_oss_v2.models.object_basic.GetSymlinkResult(version_id: str | None = None, target: str | None = None, etag: str | None = None, metadata: MutableMapping | None = None, **kwargs: Any)

Bases: ResultModel

The result for the GetSymlink operation.

Parameters:

• version_id (str, optional) – Version of the object.

• target (str, optional) – Indicates the target object that the symbol link directs to.

• etag (str, optional) – The entity tag (ETag). An ETag is created when an object is created to identify the content of the object.

• metadata (MutableMapping, optional) – A map of metadata to store with the object.

class alibabacloud_oss_v2.models.object_basic.HeadObjectRequest(bucket: str = None, key: str = None, version_id: str | None = None, if_match: str | None = None, if_none_match: str | None = None, if_modified_since: str | None = None, if_unmodified_since: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the HeadObject operation.

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.

• if_match (str, optional) – If the ETag specified in the request matches the ETag value of the object the object and 200 OK are returned. Otherwise, 412 Precondition Failed is returned.

• if_none_match (str, optional) – If the ETag specified in the request does not match the ETag value of the object, the object and 200 OK are returned. Otherwise, 304 Not Modified is returned.

• if_modified_since (str, optional) – If the time specified in this header is earlier than the object modified time or is invalid, the object and 200 OK are returned. Otherwise, 304 Not Modified is returned. The time must be in GMT. Example: Fri, 13 Nov 2015 14:47:53 GMT.

• if_unmodified_since (str, optional) – If the time specified in this header is the same as or later than the object modified time,the object and 200 OK are returned. Otherwise, 412 Precondition Failed is returned. The time must be in GMT. Example: Fri, 13 Nov 2015 14:47:53 GMT.

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

class alibabacloud_oss_v2.models.object_basic.HeadObjectResult(content_length: int | None = None, content_type: str | None = None, etag: str | None = None, last_modified: datetime | None = None, content_md5: str | None = None, metadata: MutableMapping | None = None, cache_control: str | None = None, content_disposition: str | None = None, content_encoding: str | None = None, expires: str | None = None, hash_crc64: str | None = None, storage_class: str | None = None, object_type: str | None = None, version_id: str | None = None, tagging_count: int | None = None, server_side_encryption: str | None = None, server_side_data_encryption: str | None = None, server_side_encryption_key_id: str | None = None, next_append_position: str | None = None, expiration: str | None = None, restore: str | None = None, process_status: str | None = None, request_charged: str | None = None, allow_origin: str | None = None, allow_methods: str | None = None, allow_age: str | None = None, allow_headers: str | None = None, expose_headers: str | None = None, transition_time: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the HeadObject operation.

Parameters:

• content_length (int, optional) – Size of the body in bytes.

• content_type (str, optional) – A standard MIME type describing the format of the object data.

• etag (str, optional) – The entity tag (ETag). An ETag is created when an object is created to identify the content of the object.

• last_modified (datetime.datetime, optional) – The time when the returned objects were last modified.

• content_md5 (str, optional) – Content-Md5 for the uploaded object.

• metadata (MutableMapping, optional) – A map of metadata to store with the object.

• cache_control (str, optional) – The caching behavior of the web page when the object is downloaded.

• content_disposition (str, optional) – The method that is used to access the object.

• content_encoding (str, optional) – The method that is used to encode the object.

• expires (str, optional) – The expiration time of the cache in UTC.

• hash_crc64 (str, optional) – The 64-bit CRC value of the object. This value is calculated based on the ECMA-182 standard.

• storage_class (str, optional) – The storage class of the object.

• object_type (str, optional) – The type of the object.

• version_id (str, optional) – Version of the object.

• tagging_count (int, optional) – The number of tags added to the object. This header is included in the response only when you have read permissions on tags.

• server_side_encryption (str, optional) – If the requested object is encrypted by using a server-side encryption algorithm based on entropy encoding, OSS automatically decrypts the object and returns the decrypted object after OSS receives the GetObject request. The x-oss-server-side-encryption header is included in the response to indicate the encryption algorithm used to encrypt the object on the server.

• server_side_data_encryption (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS).

• server_side_encryption_key_id (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS).

• next_append_position (str, optional) – The position for the next append operation. If the type of the object is Appendable, this header is included in the response.

• expiration (str, optional) – The lifecycle information about the object. If lifecycle rules are configured for the object, this header is included in the response. This header contains the following parameters: expiry-date that indicates the expiration time of the object, and rule-id that indicates the ID of the matched lifecycle rule.

• restore (str, optional) – The status of the object when you restore an object. If the storage class of the bucket is Archive and a RestoreObject request is submitted,

• process_status (str, optional) – The result of an event notification that is triggered for the object.

• request_charged (str, optional) – The requester. This header is included in the response if the pay-by-requester mode is enabled for the bucket and the requester is not the bucket owner. The value of this header is requester

• allow_origin (str, optional) – The origins allowed for cross-origin resource sharing (CORS).

• allow_methods (str, optional) – The methods allowed for CORS.

• allow_age (str, optional) – The maximum caching period for CORS.

• allow_headers (str, optional) – The headers allowed for CORS.

• expose_headers (str, optional) – The headers that can be accessed by JavaScript applications on the client.

• transition_time (str, optional) – The time when the storage class of the object is converted to Cold Archive or Deep Cold Archive based on lifecycle rules.

class alibabacloud_oss_v2.models.object_basic.InitiateMultipartUploadRequest(bucket: str = None, key: str = None, encoding_type: str | None = None, storage_class: str | None = None, metadata: MutableMapping | None = None, cache_control: str | None = None, content_disposition: str | None = None, content_encoding: str | None = None, content_length: int | None = None, content_md5: str | None = None, content_type: str | None = None, expires: str | None = None, server_side_encryption: str | None = None, server_side_data_encryption: str | None = None, server_side_encryption_key_id: str | None = None, tagging: str | None = None, forbid_overwrite: bool | None = None, request_payer: str | None = None, cse_data_size: int | None = None, cse_part_size: int | None = None, **kwargs: Any)

Bases: RequestModel

The request for the InitiateMultipartUpload operation.

Parameters:

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

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

• encoding_type (str, optional) – The encoding type of the object names in the response. Valid value: url

• storage_class (str, optional) – The storage class of the object.

• (MutableMapping (metadata)

• upload. (The metadata of the object that you want to)

• cache_control (str, optional) – The caching behavior of the web page when the object is downloaded.

• content_disposition (str, optional) – The method that is used to access the object.

• content_encoding (str, optional) – The method that is used to encode the object.

• content_length (int, optional) – The size of the data in the HTTP message body. Unit: bytes.

• content_md5 (str, optional) – The MD5 hash of the object that you want to upload.

• content_type (str, optional) – A standard MIME type describing the format of the contents.

• expires (str, optional) – The expiration time of the cache in UTC.

• server_side_encryption (str, optional) – The encryption method on the server side when an object is created. Valid values: AES256 and KMS

• server_side_data_encryption (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS). This header is valid only when the x-oss-server-side-encryption header is set to KMS.

• server_side_encryption_key_id (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS).

• tagging (str, optional) – The tags that are specified for the object by using a key-value pair. You can specify multiple tags for an object. Example: TagA=A&TagB=B.

• forbid_overwrite (bool, optional) – Specifies whether the object that is uploaded by calling the PutObject operation overwrites an existing object that has the same name.

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

• cse_data_size (int, optional) – The total size when using client side encryption. Only valid in EncryptionClient.

• cse_part_size (int, optional) – The part size when using client side encryption. Only valid in EncryptionClient. It must be aligned to the secret iv length.

class alibabacloud_oss_v2.models.object_basic.InitiateMultipartUploadResult(bucket: str | None = None, key: str | None = None, upload_id: str | None = None, encoding_type: str | None = None, cse_multipart_context: Any | None = None, **kwargs: Any)

Bases: ResultModel

The result for the InitiateMultipartUpload operation.

Parameters:

• bucket (str, optional) – The name of the bucket to which the object is uploaded by the multipart upload task.

• key (str, optional) – The name of the object that is uploaded by the multipart upload task.

• upload_id (str, optional) – The upload ID that uniquely identifies the multipart upload task.

• encoding_type (str, optional) – The encoding type of the object names in the response. Valid value: url

• cse_multipart_context (Any, optional) – The encryption context for multipart upload when using client side encryption, only valid in EncryptionClient

class alibabacloud_oss_v2.models.object_basic.ListMultipartUploadsRequest(bucket: str = None, delimiter: str | None = None, encoding_type: str | None = None, key_marker: str | None = None, max_uploads: int | None = None, prefix: str | None = None, upload_id_marker: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ListMultipartUploads operation.

bucket (str, required): The name of the bucket to create. delimiter (str, optional): The character that is used to group objects by name.

If you specify the delimiter parameter in the request, the response contains the CommonPrefixes parameter. The objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in CommonPrefixes.

encoding_type (str, optional): The encoding type of the content in the response. Valid value: url key_marker (str, optional): This parameter is used together with the upload-id-marker parameter to specify

the position from which the next list begins.

max_uploads (int, optional): The maximum number of multipart upload tasks that can be returned for the current request.

Default value: 1000. Maximum value: 1000.

prefix (str, optional): The prefix that the names of the returned objects must contain. upload_id_marker (str, optional): The upload ID of the multipart upload task after which the list begins.

This parameter is used together with the key-marker parameter.

request_payer (str, optional): To indicate that the requester is aware that the request

and data download will incur costs

class alibabacloud_oss_v2.models.object_basic.ListMultipartUploadsResult(encoding_type: str | None = None, bucket: str | None = None, key_marker: str | None = None, upload_id_marker: str | None = None, next_key_marker: str | None = None, next_upload_id_marker: str | None = None, delimiter: str | None = None, prefix: str | None = None, max_uploads: int | None = None, is_truncated: bool | None = None, uploads: List[Upload] | None = None, **kwargs: Any)

Bases: ResultModel

The result for the ListMultipartUploads operation.

encoding_type (str, optional): The method used to encode the object name in the response.

If encoding-type is specified in the request, values of those elements including Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key are encoded in the returned result.

bucket (str, optional): The name of the bucket. key_marker (str, optional): The name of the object that corresponds to the multipart upload task after which the list begins. upload_id_marker (str, optional): The upload ID of the multipart upload task after which the list begins. next_key_marker (str, optional): The upload ID of the multipart upload task after which the list begins. next_upload_id_marker (str, optional): The NextUploadMarker value that is used for the UploadMarker value in

the next request if the response does not contain all required results.

delimiter (str, optional): The character that is used to group objects by name. prefix (str, optional): The prefix contained in the returned object names. max_uploads (int, optional): The maximum number of multipart upload tasks returned by OSS. is_truncated (bool, optional): Indicates whether the returned results are truncated.

true indicates that not all results are returned this time. false indicates that all results are returned this time.

uploads ([Upload], optional): The container that stores information about upload task.

class alibabacloud_oss_v2.models.object_basic.ListPartsRequest(bucket: str = None, key: str = None, upload_id: str = None, encoding_type: str | None = None, max_parts: int | None = None, part_number_marker: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ListParts operation.

bucket (str, required): The name of the bucket. key (str, required): The name of the object. upload_id (str, required): The ID of the multipart upload task. encoding_type (str, optional): The encoding type of the content in the response. Valid value: url max_parts (int, optional): The maximum number of parts that can be returned by OSS.

Default value: 1000. Maximum value: 1000.

part_number_marker (str, optional): The position from which the list starts.

All parts whose part numbers are greater than the value of this parameter are listed.

request_payer (str, optional): To indicate that the requester is aware that the request

and data download will incur costs

class alibabacloud_oss_v2.models.object_basic.ListPartsResult(encoding_type: str | None = None, bucket: str | None = None, key: str | None = None, upload_id: str | None = None, part_number_marker: int | None = None, next_part_number_marker: int | None = None, max_parts: int | None = None, is_truncated: bool | None = None, storage_class: str | None = None, client_encryption_key: str | None = None, client_encryption_start: str | None = None, client_encryption_cek_alg: str | None = None, client_encryption_wrap_alg: str | None = None, client_encryption_data_size: int | None = None, client_encryption_part_size: int | None = None, parts: List[Part] | None = None, **kwargs: Any)

Bases: ResultModel

The result for the ListParts operation.

encoding_type (str, optional): The method used to encode the object name in the response.

If encoding-type is specified in the request, values of those elements including Key are encoded in the returned result.

bucket (str, optional): The name of the bucket. key (str, optional): The name of the object that corresponds to the multipart upload task after which the list begins. upload_id (str, optional): The ID of the upload task. part_number_marker (int, optional): The position from which the list starts.

All parts whose part numbers are greater than the value of this parameter are listed.

next_part_number_marker (int, optional): The NextPartNumberMarker value that is used for the PartNumberMarker value

in a subsequent request when the response does not contain all required results.

max_parts (int, optional): The maximum number of parts in the response. is_truncated (bool, optional): Indicates whether the returned results are truncated.

true indicates that not all results are returned this time. false indicates that all results are returned this time.

storage_class (str, optional): The storage class of the object. client_encryption_key (str, optional): The encrypted data key.

The encrypted data key is a string encrypted by a customer master key and encoded in Base64. Only available in client-side encryption.

client_encryption_start (str, optional): The initial value that is randomly generated for data encryption.

The initial value is is a string encrypted by a customer master key and encoded in Base64. Only available in client-side encryption.

client_encryption_cek_alg (str, optional): The algorithm used to encrypt data.

Only available in client-side encryption.

client_encryption_wrap_alg (str, optional): The algorithm used to encrypt the data key.

Only available in client-side encryption.

client_encryption_data_size (str, optional): The total size of the data to encrypt for multipart upload when init_multipart is called.

Only available in client-side encryption.

client_encryption_part_size (str, optional): The size of each part to encrypt for multipart upload when init_multipart is called.

Only available in client-side encryption.

parts ([Part], optional): The container that stores information about uploaded part.

class alibabacloud_oss_v2.models.object_basic.Part(part_number: int | None = None, etag: str | None = None, last_modified: datetime | None = None, size: int | None = None, hash_crc64: str | None = None, **kwargs: Any)

Bases: Model

The inforamtion about the uploaded part.

part_number (int, optional): The number that identifies a part. etag (str, optional): The ETag value of the content of the uploaded part. last_modified (datetime, optional): The time when the part was uploaded. size (int, optional): The size of the uploaded parts. hash_crc64 (str, optional): The 64-bit CRC value of the object.

This value is calculated based on the ECMA-182 standard.

class alibabacloud_oss_v2.models.object_basic.ProcessObjectRequest(bucket: str = None, key: str = None, process: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ProcessObject operation.

Parameters:

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

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

• process (str, required) – Image processing parameters.

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

class alibabacloud_oss_v2.models.object_basic.ProcessObjectResult(bucket: str | None = None, file_size: int | None = None, key: str | None = None, process_status: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the ProcessObject operation.

Parameters:

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

• file_size (str, optional) – The size of the proessed object.

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

• process_status (str, optional) – The status.

class alibabacloud_oss_v2.models.object_basic.PutObjectAclRequest(bucket: str = None, key: str = None, acl: str | None = None, version_id: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutObjectAcl operation.

bucket (str, required): The name of the bucket. key (str, required): The name of the object. acl (str, required): The access control list (ACL) 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

class alibabacloud_oss_v2.models.object_basic.PutObjectAclResult(version_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the PutObjectAcl operation.

Parameters:

version_id (str, optional) – Version of the object.

class alibabacloud_oss_v2.models.object_basic.PutObjectRequest(bucket: str = None, key: str = None, acl: str | None = None, storage_class: str | None = None, metadata: MutableMapping | None = None, cache_control: str | None = None, content_disposition: str | None = None, content_encoding: str | None = None, content_length: int | None = None, content_md5: str | None = None, content_type: str | None = None, expires: str | None = None, server_side_encryption: str | None = None, server_side_data_encryption: str | None = None, server_side_encryption_key_id: str | None = None, tagging: str | None = None, callback: str | None = None, callback_var: str | None = None, forbid_overwrite: bool | None = None, traffic_limit: int | None = None, request_payer: str | None = None, body: str | bytes | Iterable[bytes] | IO[str] | IO[bytes] | None = None, progress_fn: Any | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutObject operation.

Parameters:

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

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

• acl (str, optional) – The access control list (ACL) of the object.

• storage_class (str, optional) – The storage class of the object.

• (MutableMapping (metadata)

• upload. (The metadata of the object that you want to)

• cache_control (str, optional) – The caching behavior of the web page when the object is downloaded.

• content_disposition (str, optional) – The method that is used to access the object.

• content_encoding (str, optional) – The method that is used to encode the object.

• content_length (int, optional) – The size of the data in the HTTP message body. Unit: bytes.

• content_md5 (str, optional) – The MD5 hash of the object that you want to upload.

• content_type (str, optional) – A standard MIME type describing the format of the contents.

• expires (str, optional) – The expiration time of the cache in UTC.

• server_side_encryption (str, optional) – The encryption method on the server side when an object is created. Valid values: AES256 and KMS

• server_side_data_encryption (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS). This header is valid only when the x-oss-server-side-encryption header is set to KMS.

• server_side_encryption_key_id (str, optional) – The ID of the customer master key (CMK) that is managed by Key Management Service (KMS).

• tagging (str, optional) – The tags that are specified for the object by using a key-value pair. You can specify multiple tags for an object. Example: TagA=A&TagB=B.

• callback (str, optional) – A callback parameter is a Base64-encoded string that contains multiple fields in the JSON format.

• callback_var (str, optional) – Configure custom parameters by using the callback-var parameter.

• forbid_overwrite (bool, optional) – Specifies whether the object that is uploaded by calling the PutObject operation overwrites an existing object that has the same name.

• traffic_limit (int, optional) – Specify the speed limit value. The speed limit value ranges from 245760 to 838860800, with a unit of bit/s.

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

• body (BodyType,optional) – Object data.

• progress_fn (Any,optional) – Progress callback function.

class alibabacloud_oss_v2.models.object_basic.PutObjectResult(content_md5: str | None = None, etag: str | None = None, hash_crc64: str | None = None, version_id: str | None = None, callback_result: Dict | None = None, **kwargs: Any)

Bases: ResultModel

The result for the PutObject operation.

Parameters:

• content_md5 (str, optional) – Content-Md5 for the uploaded object.

• etag (str, optional) – Entity tag for the uploaded object.

• hash_crc64 (str, optional) – The 64-bit CRC value of the object. This value is calculated based on the ECMA-182 standard.

• version_id (str, optional) – Version of the object.

• callback_result (dict, optional) – Callback result, it is valid only when the callback is set.

class alibabacloud_oss_v2.models.object_basic.PutObjectTaggingRequest(bucket: str = None, key: str = None, tagging: Tagging = None, version_id: str | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutObjectTagging operation.

Parameters:

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

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

• tagging (Tagging, required) – The container used to store the collection of tags.

• version_id (str, optional) – Version of the object.

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

class alibabacloud_oss_v2.models.object_basic.PutObjectTaggingResult(version_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the PutObjectTagging operation.

Parameters:

version_id (str, optional) – Version of the object.

class alibabacloud_oss_v2.models.object_basic.PutSymlinkRequest(bucket: str = None, key: str = None, target: str = None, acl: str | None = None, storage_class: str | None = None, metadata: MutableMapping | None = None, forbid_overwrite: bool | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutSymlink operation.

Parameters:

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

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

• target (str, required) – The destination object to which the symbolic link points.

• acl (str, optional) – The access control list (ACL) of the object.

• storage_class (str, optional) – The storage class of the object.

• (MutableMapping (metadata)

• upload. (The metadata of the object that you want to)

• forbid_overwrite (bool, optional) – Specifies whether the object that is uploaded by calling the PutObject operation overwrites an existing object that has the same name.

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

class alibabacloud_oss_v2.models.object_basic.PutSymlinkResult(version_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the PutSymlink operation.

Parameters:

version_id (str, optional) – Version of the object.

class alibabacloud_oss_v2.models.object_basic.RestoreObjectRequest(bucket: str = None, key: str = None, version_id: str | None = None, restore_request: RestoreRequest | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the RestoreObject operation.

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. restore_request (RestoreRequest, optional): The container that stores information about the RestoreObject request. request_payer (str, optional): To indicate that the requester is aware that the request and data download will incur costs

class alibabacloud_oss_v2.models.object_basic.RestoreObjectResult(version_id: str | None = None, restore_priority: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the RestoreObject operation.

Parameters:

• version_id (str, optional) – Version of the object.

• restore_priority (str, optional) – The restoration priority. This header is displayed only for the Cold Archive or Deep Cold Archive object in the restored state.

class alibabacloud_oss_v2.models.object_basic.RestoreRequest(days: int | None = None, tier: str | None = None, **kwargs: Any)

Bases: Model

The configuration information about the RestoreObject request.

days (int, optional): The duration within which the restored object remains in the restored state. tier (str, optional): The restoration priority of Cold Archive or Deep Cold Archive objects.

Valid values:Expedited,Standard,Bulk

class alibabacloud_oss_v2.models.object_basic.Tag(key: str | None = None, value: str | None = None, **kwargs: Any)

Bases: Model

The inforamtion about the tag.

key (str, optional): The key of the tag. value (str, optional): The value of the tag.

class alibabacloud_oss_v2.models.object_basic.TagSet(tags: List[Tag] | None = None, **kwargs: Any)

Bases: Model

The collection of tags.

tags ([Tag], optional): A list of tags.

class alibabacloud_oss_v2.models.object_basic.Tagging(tag_set: TagSet | None = None, **kwargs: Any)

Bases: Model

The container used to store the collection of tags.

tag_set (TagSet, optional): The collection of tags.

class alibabacloud_oss_v2.models.object_basic.Upload(key: str | None = None, upload_id: str | None = None, initiated: datetime | None = None, **kwargs: Any)

Bases: Model

The inforamtion about the upload task was initiated.

key (str, optional): The name of the object for which a multipart upload task was initiated. upload_id (str, optional): The ID of the multipart upload task. initiated (str, optional): The time when the multipart upload task was initialized.

class alibabacloud_oss_v2.models.object_basic.UploadPart(part_number: int | None = None, etag: str | None = None, **kwargs: Any)

Bases: Model

The inforamtion about the content of the Part.

part_number (int, optional): The number of parts. etag (str, optional): The ETag values that are returned by OSS after parts are uploaded.

class alibabacloud_oss_v2.models.object_basic.UploadPartCopyRequest(bucket: str = None, key: str = None, part_number: int | None = None, upload_id: str | None = None, source_bucket: str | None = None, source_key: str | None = None, source_version_id: str | None = None, source_range: str | None = None, if_match: str | None = None, if_none_match: str | None = None, if_modified_since: str | None = None, if_unmodified_since: str | None = None, traffic_limit: int | None = None, request_payer: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the UploadPartCopy operation.

Parameters:

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

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

• part_number (int, optional) – Each uploaded part is identified by a number, Value: 1-10000. The size limit of a single part is between 100 KB and 5 GB.

• upload_id (str, optional) – The ID of the multipart upload task.

• source_bucket (str, optional) – The name of the source bucket.

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

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

• source_range (str, optional) – The range of bytes to copy data from the source object.

• if_match (str, optional) – Specifies whether the object that is uploaded by calling the CopyObject operation overwrites an existing object that has the same name. Valid values: true and false

• if_none_match (str, optional) – If the ETag specified in the request does not match the ETag value of the object, the object and 200 OK are returned. Otherwise, 304 Not Modified is returned.

• if_modified_since (str, optional) – If the time specified in this header is earlier than the object modified time or is invalid, the object and 200 OK are returned. Otherwise, 304 Not Modified is returned. The time must be in GMT. Example: Fri, 13 Nov 2015 14:47:53 GMT.

• if_unmodified_since (str, optional) – If the time specified in this header is the same as or later than the object modified time, the object and 200 OK are returned. Otherwise, 412 Precondition Failed is returned. The time must be in GMT. Example: Fri, 13 Nov 2015 14:47:53 GMT.

• traffic_limit (str, optional) – Specify the speed limit value. The speed limit value ranges from 245760 to 838860800, with a unit of bit/s.

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

class alibabacloud_oss_v2.models.object_basic.UploadPartCopyResult(last_modified: datetime | None = None, etag: str | None = None, source_version_id: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the UploadPartCopy operation.

Parameters:

• last_modified (datetime, optional) – The time when the returned objects were last modified.

• etag (str, optional) – Entity tag for the uploaded part.

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

class alibabacloud_oss_v2.models.object_basic.UploadPartRequest(bucket: str = None, key: str = None, part_number: int = None, upload_id: str = None, content_md5: str | None = None, content_length: int | None = None, traffic_limit: int | None = None, body: str | bytes | Iterable[bytes] | IO[str] | IO[bytes] | None = None, request_payer: str | None = None, progress_fn: Any | None = None, cse_multipart_context: Any | None = None, **kwargs: Any)

Bases: RequestModel

The request for the UploadPart operation.

Parameters:

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

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

• part_number (int, required) – Each uploaded part is identified by a number, Value: 1-10000. The size limit of a single part is between 100 KB and 5 GB.

• upload_id (str, required) – The ID of the multipart upload task.

• content_md5 (str, optional) – The MD5 hash of the object that you want to upload.

• content_length (int, optional) – The size of the data in the HTTP message body. Unit: bytes.

• traffic_limit (str, optional) – Specify the speed limit value. The speed limit value ranges from 245760 to 838860800, with a unit of bit/s.

• body (str, optional) – Object data.

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

• progress_fn (str, optional) – Progress callback function.

• cse_multipart_context (Any, optional) – The encryption context for multipart upload when using client side encryption.

class alibabacloud_oss_v2.models.object_basic.UploadPartResult(content_md5: str | None = None, etag: str | None = None, hash_crc64: str | None = None, **kwargs: Any)

Bases: ResultModel

The result for the UploadPart operation.

Parameters:

• content_md5 (str, optional) – Entity tag for the uploaded part.

• etag (str, optional) – The MD5 hash of the part that you want to upload.

• hash_crc64 (str, optional) – The 64-bit CRC value of the part. This value is calculated based on the ECMA-182 standard.

alibabacloud_oss_v2.models.public_access_block module

class alibabacloud_oss_v2.models.public_access_block.DeletePublicAccessBlockRequest(**kwargs: Any)

Bases: RequestModel

The request for the DeletePublicAccessBlock operation.

class alibabacloud_oss_v2.models.public_access_block.DeletePublicAccessBlockResult(**kwargs: Any)

Bases: ResultModel

The request for the DeletePublicAccessBlock operation.

class alibabacloud_oss_v2.models.public_access_block.GetPublicAccessBlockRequest(**kwargs: Any)

Bases: RequestModel

The request for the GetPublicAccessBlock operation.

class alibabacloud_oss_v2.models.public_access_block.GetPublicAccessBlockResult(public_access_block_configuration: PublicAccessBlockConfiguration | None = None, **kwargs: Any)

Bases: ResultModel

The request for the GetPublicAccessBlock operation.

public_access_block_configuration (PublicAccessBlockConfiguration, optional): The container in which the Block Public Access configurations are stored.

class alibabacloud_oss_v2.models.public_access_block.PublicAccessBlockConfiguration(block_public_access: bool | None = None, **kwargs: Any)

Bases: Model

The container in which the Block Public Access configurations are stored.

block_public_access (bool, optional): Specifies whether to enable Block Public Access.true: enables Block Public Access.false (default): disables Block Public Access.

class alibabacloud_oss_v2.models.public_access_block.PutPublicAccessBlockRequest(public_access_block_configuration: PublicAccessBlockConfiguration | None = None, **kwargs: Any)

Bases: RequestModel

The request for the PutPublicAccessBlock operation.

public_access_block_configuration (PublicAccessBlockConfiguration, optional): Request body.

class alibabacloud_oss_v2.models.public_access_block.PutPublicAccessBlockResult(**kwargs: Any)

Bases: ResultModel

The request for the PutPublicAccessBlock operation.

alibabacloud_oss_v2.models.region module

Models for region operation APIs

class alibabacloud_oss_v2.models.region.DescribeRegionsRequest(regions: str | None = '', **kwargs: Any)

Bases: RequestModel

The request for the DescribeRegions operation.

regions (str, optional): Regional information

class alibabacloud_oss_v2.models.region.DescribeRegionsResult(region_info: List[RegionInfo] | None = None, **kwargs: Any)

Bases: ResultModel

The result for the DescribeRegions operation.

region_info (RegionInfo, optional): The result for the DescribeRegions operation.

class alibabacloud_oss_v2.models.region.RegionInfo(region: str | None = None, internet_endpoint: str | None = None, internal_endpoint: str | None = None, accelerate_endpoint: str | None = None, **kwargs: Any)

Bases: Model

Regional information.

region (str, optional): OSS dedicated region ID. internet_endpoint (str, optional): External endpoint. internal_endpoint (str, optional): Internal network endpoint. accelerate_endpoint (str, optional): Transfer acceleration endpoint.

alibabacloud_oss_v2.models.service module

Models for service operation APIs

class alibabacloud_oss_v2.models.service.BucketProperties(name: str | None = None, location: str | None = None, creation_date: datetime | None = None, storage_class: str | None = None, extranet_endpoint: str | None = None, intranet_endpoint: str | None = None, region: str | None = None, resource_group_id: str | None = None, **kwargs: Any)

Bases: Model

Stores the metadata of the bucket.

name (str, optional): The name of the bucket. location (str, optional): The data center in which the bucket is located. creation_date (datetime, optional): The time when the bucket was created. storage_class (str, optional): The storage class of the bucket.

Valid values: Standard, IA, Archive, ColdArchive and DeepColdArchive.

extranet_endpoint (str, optional): The public endpoint used to access the bucket over the Internet. intranet_endpoint (str, optional): The internal endpoint that is used to access the bucket from ECS instances

that reside in the same region as the bucket.

region (str, optional): The region in which the bucket is located. resource_group_id (str, optional): The ID of the resource group to which the bucket belongs.

class alibabacloud_oss_v2.models.service.ListBucketsRequest(marker: str | None = None, max_keys: int | None = None, prefix: str | None = None, resource_group_id: str | None = None, **kwargs: Any)

Bases: RequestModel

The request for the ListBuckets operation.

marker (str, optional): The name of the bucket from which the list operation begins. max_keys (int, optional): The maximum number of buckets that can be returned in the single query.

Valid values: 1 to 1000.

prefix (str, optional): The prefix that the names of returned buckets must contain.

Limits the response to keys that begin with the specified prefix

request_payer (str, optional): The ID of the resource group.

class alibabacloud_oss_v2.models.service.ListBucketsResult(prefix: str | None = None, marker: str | None = None, max_keys: int | None = None, is_truncated: bool | None = None, next_marker: str | None = None, owner: Owner | None = None, buckets: List[BucketProperties] | None = None, **kwargs: Any)

Bases: ResultModel

The result for the ListBuckets operation.

prefix (str, optional): The prefix contained in the names of the returned bucket. marker (str, optional): The name of the bucket after which the ListBuckets operation starts max_keys (int, optional): The maximum number of buckets that can be returned for the request. is_truncated (bool, optional): Indicates whether the returned results are truncated.

true indicates that not all results are returned this time. false indicates that all results are returned this time.

next_marker (str, optional): The marker for the next ListBuckets request, which can be used

to return the remaining results.

owner (Owner, optional): The container that stores information about the bucket owner. buckets ([BucketProperties], optional): The container that stores information about buckets.

alibabacloud_oss_v2.models.structs module

class alibabacloud_oss_v2.models.structs.Tag(key: str | None = None, value: str | None = None, **kwargs: Any)

Bases: Model

The container used to store the tag that you want to configure.

key (str, optional): The key of a tag. * A tag key can be up to 64 bytes in length.* A tag key cannot start with http://, https://, or Aliyun.* A tag key must be UTF-8 encoded.* A tag key cannot be left empty. value (str, optional): The value of the tag that you want to add or modify. * A tag value can be up to 128 bytes in length.* A tag value must be UTF-8 encoded.* The tag value can be left empty.

Module contents