Metadata-Version: 2.1
Name: mypy-boto3-s3
Version: 1.17.86
Summary: Type annotations for boto3.S3 1.17.86 service, generated by mypy-boto3-buider 4.14.1
Home-page: https://github.com/vemel/mypy_boto3_builder
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
License: MIT License
Project-URL: Documentation, https://mypy-boto3-builder.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/vemel/mypy_boto3_builder
Project-URL: Tracker, https://github.com/vemel/mypy_boto3_builder/issues
Description: # mypy-boto3-s3<a id="mypy-boto3-s3"></a>
        
        [![PyPI - mypy-boto3-s3](https://img.shields.io/pypi/v/mypy-boto3-s3.svg?color=blue)](https://pypi.org/project/mypy-boto3-s3)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-s3.svg?color=blue)](https://pypi.org/project/mypy-boto3-s3)
        [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
        [![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-s3?color=blue)](https://pypistats.org/packages/mypy-boto3-s3)
        
        ![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
        
        Type annotations for
        [boto3.S3 1.17.86](https://boto3.amazonaws.com/v1/documentation/api/1.17.86/reference/services/s3.html#S3)
        service compatible with [VSCode](https://code.visualstudio.com/),
        [PyCharm](https://www.jetbrains.com/pycharm/),
        [Emacs](https://www.gnu.org/software/emacs/),
        [Sublime Text](https://www.sublimetext.com/),
        [mypy](https://github.com/python/mypy),
        [pyright](https://github.com/microsoft/pyright) and other tools.
        
        Generated by
        [mypy-boto3-buider 4.14.1](https://github.com/vemel/mypy_boto3_builder).
        
        More information can be found on
        [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
        [mypy-boto3-s3 docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_s3/)
        
        See how it helps to find and fix potential bugs:
        
        ![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
        
        - [mypy-boto3-s3](#mypy-boto3-s3)
          - [How to install](#how-to-install)
          - [Usage](#usage)
            - [VSCode](#vscode)
            - [PyCharm](#pycharm)
            - [Other IDEs](#other-ides)
            - [mypy](#mypy)
            - [pyright](#pyright)
          - [Explicit type annotations](#explicit-type-annotations)
            - [Client annotations](#client-annotations)
            - [Paginators annotations](#paginators-annotations)
            - [Waiters annotations](#waiters-annotations)
            - [Service Resource annotations](#service-resource-annotations)
            - [Other resources annotations](#other-resources-annotations)
            - [Collections annotations](#collections-annotations)
            - [Literals](#literals)
            - [Typed dictionaries](#typed-dictionaries)
          - [Versioning](#versioning)
          - [Documentation](#documentation)
          - [Support and contributing](#support-and-contributing)
        
        ## How to install<a id="how-to-install"></a>
        
        Install `boto3-stubs` for `S3` service.
        
        ```bash
        python -m pip install boto3-stubs[s3]
        ```
        
        ## Usage<a id="usage"></a>
        
        ### VSCode<a id="vscode"></a>
        
        - Install
          [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
        - Install
          [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
        - Set `Pylance` as your Python Language Server
        - Install `boto-stubs[s3]` in your environment:
          `python -m pip install 'boto3-stubs[s3]'`
        
        Both type checking and auto-complete should work for `S3` service. No explicit
        type annotations required, write your `boto3` code as usual.
        
        ### PyCharm<a id="pycharm"></a>
        
        - Install `boto-stubs[s3]` in your environment:
          `python -m pip install 'boto3-stubs[s3]'`
        
        Both type checking and auto-complete should work for `S3` service. No explicit
        type annotations required, write your `boto3` code as usual. Auto-complete can
        be slow on big projects or if you have a lot of installed `boto3-stubs`
        submodules.
        
        ### Other IDEs<a id="other-ides"></a>
        
        Not tested, but as long as your IDE support `mypy` or `pyright`, everything
        should work.
        
        ### mypy<a id="mypy"></a>
        
        - Install `mypy`: `python -m pip install mypy`
        - Install `boto-stubs[s3]` in your environment:
          `python -m pip install 'boto3-stubs[s3]'`
        - Run `mypy` as usual
        
        Type checking should work for `S3` service. No explicit type annotations
        required, write your `boto3` code as usual.
        
        ### pyright<a id="pyright"></a>
        
        - Install `pyright`: `yarn global add pyright`
        - Install `boto-stubs[s3]` in your environment:
          `python -m pip install 'boto3-stubs[s3]'`
        - Optionally, you can install `boto3-stubs` to `typings` folder.
        
        Type checking should work for `S3` service. No explicit type annotations
        required, write your `boto3` code as usual.
        
        ## Explicit type annotations<a id="explicit-type-annotations"></a>
        
        ### Client annotations<a id="client-annotations"></a>
        
        `S3Client` provides annotations for `boto3.client("s3")`.
        
        ```python
        import boto3
        
        from mypy_boto3_s3 import S3Client
        
        client: S3Client = boto3.client("s3")
        
        # now client usage is checked by mypy and IDE should provide code auto-complete
        
        # works for session as well
        session = boto3.session.Session(region="us-west-1")
        session_client: S3Client = session.client("s3")
        ```
        
        ### Paginators annotations<a id="paginators-annotations"></a>
        
        `mypy_boto3_s3.paginator` module contains type annotations for all paginators.
        
        ```python
        from mypy_boto3_s3 import S3Client
        from mypy_boto3_s3.paginator import (
            ListMultipartUploadsPaginator,
            ListObjectVersionsPaginator,
            ListObjectsPaginator,
            ListObjectsV2Paginator,
            ListPartsPaginator,
        )
        
        client: S3Client = boto3.client("s3")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        # VSCode requires explicit type annotations
        list_multipart_uploads_paginator: ListMultipartUploadsPaginator = client.get_paginator("list_multipart_uploads")
        list_object_versions_paginator: ListObjectVersionsPaginator = client.get_paginator("list_object_versions")
        list_objects_paginator: ListObjectsPaginator = client.get_paginator("list_objects")
        list_objects_v2_paginator: ListObjectsV2Paginator = client.get_paginator("list_objects_v2")
        list_parts_paginator: ListPartsPaginator = client.get_paginator("list_parts")
        ```
        
        ### Waiters annotations<a id="waiters-annotations"></a>
        
        `mypy_boto3_s3.waiter` module contains type annotations for all waiters.
        
        ```python
        from mypy_boto3_s3 import S3Client
        from mypy_boto3_s3.waiter import (
            BucketExistsWaiter,
            BucketNotExistsWaiter,
            ObjectExistsWaiter,
            ObjectNotExistsWaiter,
        )
        
        client: S3Client = boto3.client("s3")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        # VSCode requires explicit type annotations
        bucket_exists_waiter: BucketExistsWaiter = client.get_waiter("bucket_exists")
        bucket_not_exists_waiter: BucketNotExistsWaiter = client.get_waiter("bucket_not_exists")
        object_exists_waiter: ObjectExistsWaiter = client.get_waiter("object_exists")
        object_not_exists_waiter: ObjectNotExistsWaiter = client.get_waiter("object_not_exists")
        ```
        
        ### Service Resource annotations<a id="service-resource-annotations"></a>
        
        `S3ServiceResource` provides annotations for `boto3.resource("s3")`.
        
        ```python
        from mypy_boto3_s3 import S3ServiceResource
        
        resource: S3ServiceResource = boto3.resource("s3")
        
        # now resource usage is checked by mypy and IDE should provide code auto-complete
        
        # works for session as well
        session = boto3.session.Session(region="us-west-1")
        session_resource: S3ServiceResource = session.resource("s3")
        ```
        
        ### Other resources annotations<a id="other-resources-annotations"></a>
        
        `mypy_boto3_s3.service_resource` module contains type annotations for all
        resources.
        
        ```python
        from mypy_boto3_s3 import S3ServiceResource
        from mypy_boto3_s3.service_resource import (
            Bucket,
            BucketAcl,
            BucketCors,
            BucketLifecycle,
            BucketLifecycleConfiguration,
            BucketLogging,
            BucketNotification,
            BucketPolicy,
            BucketRequestPayment,
            BucketTagging,
            BucketVersioning,
            BucketWebsite,
            MultipartUpload,
            MultipartUploadPart,
            Object,
            ObjectAcl,
            ObjectSummary,
            ObjectVersion,
        )
        
        resource: S3ServiceResource = boto3.resource("s3")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        my_bucket: Bucket = resource.Bucket(...)
        my_bucket_acl: BucketAcl = resource.BucketAcl(...)
        my_bucket_cors: BucketCors = resource.BucketCors(...)
        my_bucket_lifecycle: BucketLifecycle = resource.BucketLifecycle(...)
        my_bucket_lifecycle_configuration: BucketLifecycleConfiguration = resource.BucketLifecycleConfiguration(...)
        my_bucket_logging: BucketLogging = resource.BucketLogging(...)
        my_bucket_notification: BucketNotification = resource.BucketNotification(...)
        my_bucket_policy: BucketPolicy = resource.BucketPolicy(...)
        my_bucket_request_payment: BucketRequestPayment = resource.BucketRequestPayment(...)
        my_bucket_tagging: BucketTagging = resource.BucketTagging(...)
        my_bucket_versioning: BucketVersioning = resource.BucketVersioning(...)
        my_bucket_website: BucketWebsite = resource.BucketWebsite(...)
        my_multipart_upload: MultipartUpload = resource.MultipartUpload(...)
        my_multipart_upload_part: MultipartUploadPart = resource.MultipartUploadPart(...)
        my_object: Object = resource.Object(...)
        my_object_acl: ObjectAcl = resource.ObjectAcl(...)
        my_object_summary: ObjectSummary = resource.ObjectSummary(...)
        my_object_version: ObjectVersion = resource.ObjectVersion(...)
        ```
        
        ### Collections annotations<a id="collections-annotations"></a>
        
        `mypy_boto3_s3.service_resource` module contains type annotations for all
        `S3ServiceResource` collections.
        
        ```python
        from mypy_boto3_s3 import S3ServiceResource
        from mypy_boto3_s3.service_resource import (
            ServiceResourceBucketsCollection,
        )
        
        resource: S3ServiceResource = boto3.resource("s3")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        buckets: s3_resources.ServiceResourceBucketsCollection = resource.buckets
        ```
        
        ### Literals<a id="literals"></a>
        
        `mypy_boto3_s3.literals` module contains literals extracted from shapes that
        can be used in user code for type checking.
        
        ```python
        from mypy_boto3_s3.literals import (
            AnalyticsS3ExportFileFormatType,
            ArchiveStatusType,
            BucketAccelerateStatusType,
            BucketCannedACLType,
            BucketExistsWaiterName,
            BucketLocationConstraintType,
            BucketLogsPermissionType,
            BucketNotExistsWaiterName,
            BucketVersioningStatusType,
            CompressionTypeType,
            DeleteMarkerReplicationStatusType,
            EncodingTypeType,
            EventType,
            ExistingObjectReplicationStatusType,
            ExpirationStatusType,
            ExpressionTypeType,
            FileHeaderInfoType,
            FilterRuleNameType,
            IntelligentTieringAccessTierType,
            IntelligentTieringStatusType,
            InventoryFormatType,
            InventoryFrequencyType,
            InventoryIncludedObjectVersionsType,
            InventoryOptionalFieldType,
            JSONTypeType,
            ListMultipartUploadsPaginatorName,
            ListObjectVersionsPaginatorName,
            ListObjectsPaginatorName,
            ListObjectsV2PaginatorName,
            ListPartsPaginatorName,
            MFADeleteStatusType,
            MFADeleteType,
            MetadataDirectiveType,
            MetricsStatusType,
            ObjectCannedACLType,
            ObjectExistsWaiterName,
            ObjectLockEnabledType,
            ObjectLockLegalHoldStatusType,
            ObjectLockModeType,
            ObjectLockRetentionModeType,
            ObjectNotExistsWaiterName,
            ObjectOwnershipType,
            ObjectStorageClassType,
            ObjectVersionStorageClassType,
            OwnerOverrideType,
            PayerType,
            PermissionType,
            ProtocolType,
            QuoteFieldsType,
            ReplicaModificationsStatusType,
            ReplicationRuleStatusType,
            ReplicationStatusType,
            ReplicationTimeStatusType,
            RequestChargedType,
            RequestPayerType,
            RestoreRequestTypeType,
            ServerSideEncryptionType,
            SseKmsEncryptedObjectsStatusType,
            StorageClassAnalysisSchemaVersionType,
            StorageClassType,
            TaggingDirectiveType,
            TierType,
            TransitionStorageClassType,
            TypeType,
        )
        
        def check_value(value: AnalyticsS3ExportFileFormatType) -> bool:
            ...
        ```
        
        ### Typed dictionaries<a id="typed-dictionaries"></a>
        
        `mypy_boto3_s3.type_defs` module contains structures and shapes assembled to
        typed dictionaries for additional type checking.
        
        ```python
        from mypy_boto3_s3.type_defs import (
            AbortIncompleteMultipartUploadTypeDef,
            AbortMultipartUploadOutputTypeDef,
            AccelerateConfigurationTypeDef,
            AccessControlPolicyTypeDef,
            AccessControlTranslationTypeDef,
            AnalyticsAndOperatorTypeDef,
            AnalyticsConfigurationTypeDef,
            AnalyticsExportDestinationTypeDef,
            AnalyticsFilterTypeDef,
            AnalyticsS3BucketDestinationTypeDef,
            BucketLifecycleConfigurationTypeDef,
            BucketLoggingStatusTypeDef,
            BucketTypeDef,
            CORSConfigurationTypeDef,
            CORSRuleTypeDef,
            CSVInputTypeDef,
            CSVOutputTypeDef,
            CloudFunctionConfigurationTypeDef,
            CommonPrefixTypeDef,
            CompleteMultipartUploadOutputTypeDef,
            CompletedMultipartUploadTypeDef,
            CompletedPartTypeDef,
            ConditionTypeDef,
            CopyObjectOutputTypeDef,
            CopyObjectResultTypeDef,
            CopyPartResultTypeDef,
            CopySourceTypeDef,
            CreateBucketConfigurationTypeDef,
            CreateBucketOutputTypeDef,
            CreateMultipartUploadOutputTypeDef,
            DefaultRetentionTypeDef,
            DeleteMarkerEntryTypeDef,
            DeleteMarkerReplicationTypeDef,
            DeleteObjectOutputTypeDef,
            DeleteObjectTaggingOutputTypeDef,
            DeleteObjectsOutputTypeDef,
            DeleteTypeDef,
            DeletedObjectTypeDef,
            DestinationTypeDef,
            EncryptionConfigurationTypeDef,
            EncryptionTypeDef,
            ErrorDocumentTypeDef,
            ErrorTypeDef,
            ExistingObjectReplicationTypeDef,
            FilterRuleTypeDef,
            GetBucketAccelerateConfigurationOutputTypeDef,
            GetBucketAclOutputTypeDef,
            GetBucketAnalyticsConfigurationOutputTypeDef,
            GetBucketCorsOutputTypeDef,
            GetBucketEncryptionOutputTypeDef,
            GetBucketIntelligentTieringConfigurationOutputTypeDef,
            GetBucketInventoryConfigurationOutputTypeDef,
            GetBucketLifecycleConfigurationOutputTypeDef,
            GetBucketLifecycleOutputTypeDef,
            GetBucketLocationOutputTypeDef,
            GetBucketLoggingOutputTypeDef,
            GetBucketMetricsConfigurationOutputTypeDef,
            GetBucketOwnershipControlsOutputTypeDef,
            GetBucketPolicyOutputTypeDef,
            GetBucketPolicyStatusOutputTypeDef,
            GetBucketReplicationOutputTypeDef,
            GetBucketRequestPaymentOutputTypeDef,
            GetBucketTaggingOutputTypeDef,
            GetBucketVersioningOutputTypeDef,
            GetBucketWebsiteOutputTypeDef,
            GetObjectAclOutputTypeDef,
            GetObjectLegalHoldOutputTypeDef,
            GetObjectLockConfigurationOutputTypeDef,
            GetObjectOutputTypeDef,
            GetObjectRetentionOutputTypeDef,
            GetObjectTaggingOutputTypeDef,
            GetObjectTorrentOutputTypeDef,
            GetPublicAccessBlockOutputTypeDef,
            GlacierJobParametersTypeDef,
            GrantTypeDef,
            GranteeTypeDef,
            HeadObjectOutputTypeDef,
            IndexDocumentTypeDef,
            InitiatorTypeDef,
            InputSerializationTypeDef,
            IntelligentTieringAndOperatorTypeDef,
            IntelligentTieringConfigurationTypeDef,
            IntelligentTieringFilterTypeDef,
            InventoryConfigurationTypeDef,
            InventoryDestinationTypeDef,
            InventoryEncryptionTypeDef,
            InventoryFilterTypeDef,
            InventoryS3BucketDestinationTypeDef,
            InventoryScheduleTypeDef,
            JSONInputTypeDef,
            JSONOutputTypeDef,
            LambdaFunctionConfigurationTypeDef,
            LifecycleConfigurationTypeDef,
            LifecycleExpirationTypeDef,
            LifecycleRuleAndOperatorTypeDef,
            LifecycleRuleFilterTypeDef,
            LifecycleRuleTypeDef,
            ListBucketAnalyticsConfigurationsOutputTypeDef,
            ListBucketIntelligentTieringConfigurationsOutputTypeDef,
            ListBucketInventoryConfigurationsOutputTypeDef,
            ListBucketMetricsConfigurationsOutputTypeDef,
            ListBucketsOutputTypeDef,
            ListMultipartUploadsOutputTypeDef,
            ListObjectVersionsOutputTypeDef,
            ListObjectsOutputTypeDef,
            ListObjectsV2OutputTypeDef,
            ListPartsOutputTypeDef,
            LoggingEnabledTypeDef,
            MetadataEntryTypeDef,
            MetricsAndOperatorTypeDef,
            MetricsConfigurationTypeDef,
            MetricsFilterTypeDef,
            MetricsTypeDef,
            MultipartUploadTypeDef,
            NoncurrentVersionExpirationTypeDef,
            NoncurrentVersionTransitionTypeDef,
            NotificationConfigurationDeprecatedTypeDef,
            NotificationConfigurationFilterTypeDef,
            NotificationConfigurationTypeDef,
            ObjectIdentifierTypeDef,
            ObjectLockConfigurationTypeDef,
            ObjectLockLegalHoldTypeDef,
            ObjectLockRetentionTypeDef,
            ObjectLockRuleTypeDef,
            ObjectTypeDef,
            ObjectVersionTypeDef,
            OutputLocationTypeDef,
            OutputSerializationTypeDef,
            OwnerTypeDef,
            OwnershipControlsRuleTypeDef,
            OwnershipControlsTypeDef,
            PaginatorConfigTypeDef,
            PartTypeDef,
            PolicyStatusTypeDef,
            ProgressEventTypeDef,
            ProgressTypeDef,
            PublicAccessBlockConfigurationTypeDef,
            PutObjectAclOutputTypeDef,
            PutObjectLegalHoldOutputTypeDef,
            PutObjectLockConfigurationOutputTypeDef,
            PutObjectOutputTypeDef,
            PutObjectRetentionOutputTypeDef,
            PutObjectTaggingOutputTypeDef,
            QueueConfigurationDeprecatedTypeDef,
            QueueConfigurationTypeDef,
            RecordsEventTypeDef,
            RedirectAllRequestsToTypeDef,
            RedirectTypeDef,
            ReplicaModificationsTypeDef,
            ReplicationConfigurationTypeDef,
            ReplicationRuleAndOperatorTypeDef,
            ReplicationRuleFilterTypeDef,
            ReplicationRuleTypeDef,
            ReplicationTimeTypeDef,
            ReplicationTimeValueTypeDef,
            RequestPaymentConfigurationTypeDef,
            RequestProgressTypeDef,
            ResponseMetadataTypeDef,
            RestoreObjectOutputTypeDef,
            RestoreRequestTypeDef,
            RoutingRuleTypeDef,
            RuleTypeDef,
            S3KeyFilterTypeDef,
            S3LocationTypeDef,
            SSEKMSTypeDef,
            ScanRangeTypeDef,
            SelectObjectContentEventStreamTypeDef,
            SelectObjectContentOutputTypeDef,
            SelectParametersTypeDef,
            ServerSideEncryptionByDefaultTypeDef,
            ServerSideEncryptionConfigurationTypeDef,
            ServerSideEncryptionRuleTypeDef,
            SourceSelectionCriteriaTypeDef,
            SseKmsEncryptedObjectsTypeDef,
            StatsEventTypeDef,
            StatsTypeDef,
            StorageClassAnalysisDataExportTypeDef,
            StorageClassAnalysisTypeDef,
            TagTypeDef,
            TaggingTypeDef,
            TargetGrantTypeDef,
            TieringTypeDef,
            TopicConfigurationDeprecatedTypeDef,
            TopicConfigurationTypeDef,
            TransitionTypeDef,
            UploadPartCopyOutputTypeDef,
            UploadPartOutputTypeDef,
            VersioningConfigurationTypeDef,
            WaiterConfigTypeDef,
            WebsiteConfigurationTypeDef,
        )
        
        def get_structure() -> AbortIncompleteMultipartUploadTypeDef:
            return {
              ...
            }
        ```
        
        ## Versioning<a id="versioning"></a>
        
        `mypy-boto3-s3` version is the same as related `boto3` version and follows
        [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
        
        ## Documentation<a id="documentation"></a>
        
        All type annotations can be found in
        [mypy-boto3-s3 docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_s3/)
        
        ## Support and contributing<a id="support-and-contributing"></a>
        
        This package is auto-generated. Please reports any bugs or request new features
        in [mypy-boto3-builder](https://github.com/vemel/mypy_boto3_builder/issues/)
        repository.
        
Keywords: boto3 s3 type-annotations boto3-stubs mypy typeshed autocomplete auto-generated
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
