:py:mod:`vendor_fabric.aws.s3`
==============================

.. py:module:: vendor_fabric.aws.s3

.. autodoc2-docstring:: vendor_fabric.aws.s3
   :parser: myst
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`AWSS3Mixin <vendor_fabric.aws.s3.AWSS3Mixin>`
     - .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin
          :parser: myst
          :summary:

API
~~~

.. py:class:: AWSS3Mixin
   :canonical: vendor_fabric.aws.s3.AWSS3Mixin

   .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin
      :parser: myst

   .. py:method:: list_s3_buckets(unhump_buckets: bool = True, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.list_s3_buckets

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.list_s3_buckets
         :parser: myst

   .. py:method:: get_bucket_location(bucket_name: str, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedString
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.get_bucket_location

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.get_bucket_location
         :parser: myst

   .. py:method:: get_object(bucket: str, key: str, decode: bool = True, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedString | bytes | None
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.get_object

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.get_object
         :parser: myst

   .. py:method:: get_json_object(bucket: str, key: str, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict | extended_data.containers.ExtendedList[typing.Any] | None
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.get_json_object

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.get_json_object
         :parser: myst

   .. py:method:: put_object(bucket: str, key: str, body: str | bytes, content_type: str | None = None, metadata: collections.abc.Mapping[str, str] | None = None, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.put_object

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.put_object
         :parser: myst

   .. py:method:: put_json_object(bucket: str, key: str, data: collections.abc.Mapping[str, typing.Any] | collections.abc.Sequence[typing.Any], indent: int = 2, metadata: collections.abc.Mapping[str, str] | None = None, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.put_json_object

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.put_json_object
         :parser: myst

   .. py:method:: delete_object(bucket: str, key: str, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.delete_object

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.delete_object
         :parser: myst

   .. py:method:: list_objects(bucket: str, prefix: str | None = None, delimiter: str | None = None, max_keys: int | None = None, unhump_objects: bool = True, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict]
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.list_objects

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.list_objects
         :parser: myst

   .. py:method:: copy_object(source_bucket: str, source_key: str, dest_bucket: str, dest_key: str, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.copy_object

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.copy_object
         :parser: myst

   .. py:method:: get_bucket_features(bucket_name: str, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.get_bucket_features

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.get_bucket_features
         :parser: myst

   .. py:method:: find_buckets_by_name(name_contains: str, include_features: bool = False, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.find_buckets_by_name

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.find_buckets_by_name
         :parser: myst

   .. py:method:: create_bucket(bucket_name: str, region: str | None = None, acl: str = 'private', enable_versioning: bool = False, tags: collections.abc.Mapping[str, str] | None = None, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.create_bucket

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.create_bucket
         :parser: myst

   .. py:method:: delete_bucket(bucket_name: str, force: bool = False, execution_role_arn: str | None = None) -> None
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.delete_bucket

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.delete_bucket
         :parser: myst

   .. py:method:: get_bucket_tags(bucket_name: str, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.get_bucket_tags

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.get_bucket_tags
         :parser: myst

   .. py:method:: set_bucket_tags(bucket_name: str, tags: collections.abc.Mapping[str, str], execution_role_arn: str | None = None) -> None
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.set_bucket_tags

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.set_bucket_tags
         :parser: myst

   .. py:method:: get_bucket_sizes(bucket_names: collections.abc.Sequence[str] | None = None, execution_role_arn: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.aws.s3.AWSS3Mixin.get_bucket_sizes

      .. autodoc2-docstring:: vendor_fabric.aws.s3.AWSS3Mixin.get_bucket_sizes
         :parser: myst