.config/coc/extensions/node_modules/coc-pyright/node_modules/pyright/dist/typeshed-fallback/stubs/boto/boto/s3/bucket.pyi

   1 from typing import Any, Text, Type
   2
   3 from .bucketlistresultset import BucketListResultSet
   4 from .connection import S3Connection
   5 from .key import Key
   6
   7 class S3WebsiteEndpointTranslate:
   8     trans_region: dict[str, str]
   9     @classmethod
  10     def translate_region(cls, reg: Text) -> str: ...
  11
  12 S3Permissions: list[str]
  13
  14 class Bucket:
  15     LoggingGroup: str
  16     BucketPaymentBody: str
  17     VersioningBody: str
  18     VersionRE: str
  19     MFADeleteRE: str
  20     name: Text
  21     connection: S3Connection
  22     key_class: Type[Key]
  23     def __init__(self, connection: S3Connection | None = ..., name: Text | None = ..., key_class: Type[Key] = ...) -> None: ...
  24     def __iter__(self): ...
  25     def __contains__(self, key_name) -> bool: ...
  26     def startElement(self, name, attrs, connection): ...
  27     creation_date: Any
  28     def endElement(self, name, value, connection): ...
  29     def set_key_class(self, key_class): ...
  30     def lookup(self, key_name, headers: dict[Text, Text] | None = ...): ...
  31     def get_key(
  32         self,
  33         key_name,
  34         headers: dict[Text, Text] | None = ...,
  35         version_id: Any | None = ...,
  36         response_headers: dict[Text, Text] | None = ...,
  37         validate: bool = ...,
  38     ) -> Key: ...
  39     def list(
  40         self,
  41         prefix: Text = ...,
  42         delimiter: Text = ...,
  43         marker: Text = ...,
  44         headers: dict[Text, Text] | None = ...,
  45         encoding_type: Any | None = ...,
  46     ) -> BucketListResultSet: ...
  47     def list_versions(
  48         self,
  49         prefix: str = ...,
  50         delimiter: str = ...,
  51         key_marker: str = ...,
  52         version_id_marker: str = ...,
  53         headers: dict[Text, Text] | None = ...,
  54         encoding_type: Text | None = ...,
  55     ) -> BucketListResultSet: ...
  56     def list_multipart_uploads(
  57         self,
  58         key_marker: str = ...,
  59         upload_id_marker: str = ...,
  60         headers: dict[Text, Text] | None = ...,
  61         encoding_type: Any | None = ...,
  62     ): ...
  63     def validate_kwarg_names(self, kwargs, names): ...
  64     def get_all_keys(self, headers: dict[Text, Text] | None = ..., **params): ...
  65     def get_all_versions(self, headers: dict[Text, Text] | None = ..., **params): ...
  66     def validate_get_all_versions_params(self, params): ...
  67     def get_all_multipart_uploads(self, headers: dict[Text, Text] | None = ..., **params): ...
  68     def new_key(self, key_name: Any | None = ...): ...
  69     def generate_url(
  70         self,
  71         expires_in,
  72         method: str = ...,
  73         headers: dict[Text, Text] | None = ...,
  74         force_http: bool = ...,
  75         response_headers: dict[Text, Text] | None = ...,
  76         expires_in_absolute: bool = ...,
  77     ): ...
  78     def delete_keys(self, keys, quiet: bool = ..., mfa_token: Any | None = ..., headers: dict[Text, Text] | None = ...): ...
  79     def delete_key(
  80         self, key_name, headers: dict[Text, Text] | None = ..., version_id: Any | None = ..., mfa_token: Any | None = ...
  81     ): ...
  82     def copy_key(
  83         self,
  84         new_key_name,
  85         src_bucket_name,
  86         src_key_name,
  87         metadata: Any | None = ...,
  88         src_version_id: Any | None = ...,
  89         storage_class: str = ...,
  90         preserve_acl: bool = ...,
  91         encrypt_key: bool = ...,
  92         headers: dict[Text, Text] | None = ...,
  93         query_args: Any | None = ...,
  94     ): ...
  95     def set_canned_acl(
  96         self, acl_str, key_name: str = ..., headers: dict[Text, Text] | None = ..., version_id: Any | None = ...
  97     ): ...
  98     def get_xml_acl(self, key_name: str = ..., headers: dict[Text, Text] | None = ..., version_id: Any | None = ...): ...
  99     def set_xml_acl(
 100         self,
 101         acl_str,
 102         key_name: str = ...,
 103         headers: dict[Text, Text] | None = ...,
 104         version_id: Any | None = ...,
 105         query_args: str = ...,
 106     ): ...
 107     def set_acl(self, acl_or_str, key_name: str = ..., headers: dict[Text, Text] | None = ..., version_id: Any | None = ...): ...
 108     def get_acl(self, key_name: str = ..., headers: dict[Text, Text] | None = ..., version_id: Any | None = ...): ...
 109     def set_subresource(
 110         self, subresource, value, key_name: str = ..., headers: dict[Text, Text] | None = ..., version_id: Any | None = ...
 111     ): ...
 112     def get_subresource(
 113         self, subresource, key_name: str = ..., headers: dict[Text, Text] | None = ..., version_id: Any | None = ...
 114     ): ...
 115     def make_public(self, recursive: bool = ..., headers: dict[Text, Text] | None = ...): ...
 116     def add_email_grant(self, permission, email_address, recursive: bool = ..., headers: dict[Text, Text] | None = ...): ...
 117     def add_user_grant(
 118         self, permission, user_id, recursive: bool = ..., headers: dict[Text, Text] | None = ..., display_name: Any | None = ...
 119     ): ...
 120     def list_grants(self, headers: dict[Text, Text] | None = ...): ...
 121     def get_location(self): ...
 122     def set_xml_logging(self, logging_str, headers: dict[Text, Text] | None = ...): ...
 123     def enable_logging(
 124         self, target_bucket, target_prefix: str = ..., grants: Any | None = ..., headers: dict[Text, Text] | None = ...
 125     ): ...
 126     def disable_logging(self, headers: dict[Text, Text] | None = ...): ...
 127     def get_logging_status(self, headers: dict[Text, Text] | None = ...): ...
 128     def set_as_logging_target(self, headers: dict[Text, Text] | None = ...): ...
 129     def get_request_payment(self, headers: dict[Text, Text] | None = ...): ...
 130     def set_request_payment(self, payer: str = ..., headers: dict[Text, Text] | None = ...): ...
 131     def configure_versioning(
 132         self, versioning, mfa_delete: bool = ..., mfa_token: Any | None = ..., headers: dict[Text, Text] | None = ...
 133     ): ...
 134     def get_versioning_status(self, headers: dict[Text, Text] | None = ...): ...
 135     def configure_lifecycle(self, lifecycle_config, headers: dict[Text, Text] | None = ...): ...
 136     def get_lifecycle_config(self, headers: dict[Text, Text] | None = ...): ...
 137     def delete_lifecycle_configuration(self, headers: dict[Text, Text] | None = ...): ...
 138     def configure_website(
 139         self,
 140         suffix: Any | None = ...,
 141         error_key: Any | None = ...,
 142         redirect_all_requests_to: Any | None = ...,
 143         routing_rules: Any | None = ...,
 144         headers: dict[Text, Text] | None = ...,
 145     ): ...
 146     def set_website_configuration(self, config, headers: dict[Text, Text] | None = ...): ...
 147     def set_website_configuration_xml(self, xml, headers: dict[Text, Text] | None = ...): ...
 148     def get_website_configuration(self, headers: dict[Text, Text] | None = ...): ...
 149     def get_website_configuration_obj(self, headers: dict[Text, Text] | None = ...): ...
 150     def get_website_configuration_with_xml(self, headers: dict[Text, Text] | None = ...): ...
 151     def get_website_configuration_xml(self, headers: dict[Text, Text] | None = ...): ...
 152     def delete_website_configuration(self, headers: dict[Text, Text] | None = ...): ...
 153     def get_website_endpoint(self): ...
 154     def get_policy(self, headers: dict[Text, Text] | None = ...): ...
 155     def set_policy(self, policy, headers: dict[Text, Text] | None = ...): ...
 156     def delete_policy(self, headers: dict[Text, Text] | None = ...): ...
 157     def set_cors_xml(self, cors_xml, headers: dict[Text, Text] | None = ...): ...
 158     def set_cors(self, cors_config, headers: dict[Text, Text] | None = ...): ...
 159     def get_cors_xml(self, headers: dict[Text, Text] | None = ...): ...
 160     def get_cors(self, headers: dict[Text, Text] | None = ...): ...
 161     def delete_cors(self, headers: dict[Text, Text] | None = ...): ...
 162     def initiate_multipart_upload(
 163         self,
 164         key_name,
 165         headers: dict[Text, Text] | None = ...,
 166         reduced_redundancy: bool = ...,
 167         metadata: Any | None = ...,
 168         encrypt_key: bool = ...,
 169         policy: Any | None = ...,
 170     ): ...
 171     def complete_multipart_upload(self, key_name, upload_id, xml_body, headers: dict[Text, Text] | None = ...): ...
 172     def cancel_multipart_upload(self, key_name, upload_id, headers: dict[Text, Text] | None = ...): ...
 173     def delete(self, headers: dict[Text, Text] | None = ...): ...
 174     def get_tags(self): ...
 175     def get_xml_tags(self): ...
 176     def set_xml_tags(self, tag_str, headers: dict[Text, Text] | None = ..., query_args: str = ...): ...
 177     def set_tags(self, tags, headers: dict[Text, Text] | None = ...): ...
 178     def delete_tags(self, headers: dict[Text, Text] | None = ...): ...