Metadata-Version: 2.1
Name: mypy-boto3-s3control
Version: 1.26.1
Summary: Type annotations for boto3.S3Control 1.26.1 service generated with mypy-boto3-builder 7.11.10
Home-page: https://github.com/youtype/mypy_boto3_builder
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
License: MIT License
Project-URL: Documentation, https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3control/
Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
Keywords: boto3 s3control type-annotations boto3-stubs mypy typeshed autocomplete
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.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typing-extensions (>=4.1.0)

<a id="mypy-boto3-s3control"></a>

# mypy-boto3-s3control

[![PyPI - mypy-boto3-s3control](https://img.shields.io/pypi/v/mypy-boto3-s3control.svg?color=blue)](https://pypi.org/project/mypy-boto3-s3control)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-s3control.svg?color=blue)](https://pypi.org/project/mypy-boto3-s3control)
[![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/dm/mypy-boto3-s3control?color=blue)](https://pypistats.org/packages/mypy-boto3-s3control)

![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)

Type annotations for
[boto3.S3Control 1.26.1](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3control.html#S3Control)
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-builder 7.11.10](https://github.com/youtype/mypy_boto3_builder).

More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-s3control docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3control/).

See how it helps to find and fix potential bugs:

![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)

- [mypy-boto3-s3control](#mypy-boto3-s3control)
  - [How to install](#how-to-install)
    - [VSCode extension](#vscode-extension)
    - [From PyPI with pip](#from-pypi-with-pip)
  - [How to uninstall](#how-to-uninstall)
  - [Usage](#usage)
    - [VSCode](#vscode)
    - [PyCharm](#pycharm)
    - [Emacs](#emacs)
    - [Sublime Text](#sublime-text)
    - [Other IDEs](#other-ides)
    - [mypy](#mypy)
    - [pyright](#pyright)
  - [Explicit type annotations](#explicit-type-annotations)
    - [Client annotations](#client-annotations)
    - [Paginators annotations](#paginators-annotations)
    - [Literals](#literals)
    - [Typed dictionaries](#typed-dictionaries)
  - [How it works](#how-it-works)
  - [What's new](#what's-new)
    - [Implemented features](#implemented-features)
    - [Latest changes](#latest-changes)
  - [Versioning](#versioning)
  - [Thank you](#thank-you)
  - [Documentation](#documentation)
  - [Support and contributing](#support-and-contributing)

<a id="how-to-install"></a>

## How to install

<a id="vscode-extension"></a>

### VSCode extension

Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.

Click `Modify` and select `boto3 common` and `S3Control`.

<a id="from-pypi-with-pip"></a>

### From PyPI with pip

Install `boto3-stubs` for `S3Control` service.

```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[s3control]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[s3control]'


# standalone installation
python -m pip install mypy-boto3-s3control
```

<a id="how-to-uninstall"></a>

## How to uninstall

```bash
python -m pip uninstall -y mypy-boto3-s3control
```

<a id="usage"></a>

## Usage

<a id="vscode"></a>

### VSCode

- 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 `boto3-stubs[s3control]` in your environment:

```bash
python -m pip install 'boto3-stubs[s3control]'
```

Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.

<a id="pycharm"></a>

### PyCharm

Install `boto3-stubs-lite[s3control]` in your environment:

```bash
python -m pip install 'boto3-stubs-lite[s3control]'`
```

Both type checking and code completion should now work. Explicit type
annotations **are required**.

Use `boto3-stubs` package instead for implicit type discovery.

<a id="emacs"></a>

### Emacs

- Install `boto3-stubs` with services you use in your environment:

```bash
python -m pip install 'boto3-stubs[s3control]'
```

- Install [use-package](https://github.com/jwiegley/use-package),
  [lsp](https://github.com/emacs-lsp/lsp-mode/),
  [company](https://github.com/company-mode/company-mode) and
  [flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

```elisp
(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
```

- Make sure emacs uses the environment where you have installed `boto3-stubs`

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="sublime-text"></a>

### Sublime Text

- Install `boto3-stubs[s3control]` with services you use in your environment:

```bash
python -m pip install 'boto3-stubs[s3control]'
```

- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="other-ides"></a>

### Other IDEs

Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.

<a id="mypy"></a>

### mypy

- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[s3control]` in your environment:

```bash
python -m pip install 'boto3-stubs[s3control]'`
```

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="pyright"></a>

### pyright

- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[s3control]` in your environment:

```bash
python -m pip install 'boto3-stubs[s3control]'
```

Optionally, you can install `boto3-stubs` to `typings` folder.

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="explicit-type-annotations"></a>

## Explicit type annotations

<a id="client-annotations"></a>

### Client annotations

`S3ControlClient` provides annotations for `boto3.client("s3control")`.

```python
from boto3.session import Session

from mypy_boto3_s3control import S3ControlClient

client: S3ControlClient = Session().client("s3control")

# now client usage is checked by mypy and IDE should provide code completion
```

<a id="paginators-annotations"></a>

### Paginators annotations

`mypy_boto3_s3control.paginator` module contains type annotations for all
paginators.

```python
from boto3.session import Session

from mypy_boto3_s3control import S3ControlClient
from mypy_boto3_s3control.paginator import ListAccessPointsForObjectLambdaPaginator

client: S3ControlClient = Session().client("s3control")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_access_points_for_object_lambda_paginator: ListAccessPointsForObjectLambdaPaginator = (
    client.get_paginator("list_access_points_for_object_lambda")
)
```

<a id="literals"></a>

### Literals

`mypy_boto3_s3control.literals` module contains literals extracted from shapes
that can be used in user code for type checking.

```python
from mypy_boto3_s3control.literals import (
    AsyncOperationNameType,
    BucketCannedACLType,
    BucketLocationConstraintType,
    BucketVersioningStatusType,
    ExpirationStatusType,
    FormatType,
    GeneratedManifestFormatType,
    JobManifestFieldNameType,
    JobManifestFormatType,
    JobReportFormatType,
    JobReportScopeType,
    JobStatusType,
    ListAccessPointsForObjectLambdaPaginatorName,
    MFADeleteStatusType,
    MFADeleteType,
    MultiRegionAccessPointStatusType,
    NetworkOriginType,
    ObjectLambdaAllowedFeatureType,
    ObjectLambdaTransformationConfigurationActionType,
    OperationNameType,
    OutputSchemaVersionType,
    ReplicationStatusType,
    RequestedJobStatusType,
    S3CannedAccessControlListType,
    S3ChecksumAlgorithmType,
    S3GlacierJobTierType,
    S3GranteeTypeIdentifierType,
    S3MetadataDirectiveType,
    S3ObjectLockLegalHoldStatusType,
    S3ObjectLockModeType,
    S3ObjectLockRetentionModeType,
    S3PermissionType,
    S3SSEAlgorithmType,
    S3StorageClassType,
    TransitionStorageClassType,
    S3ControlServiceName,
    ServiceName,
    ResourceServiceName,
    PaginatorName,
    RegionName,
)


def check_value(value: AsyncOperationNameType) -> bool:
    ...
```

<a id="typed-dictionaries"></a>

### Typed dictionaries

`mypy_boto3_s3control.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.

```python
from mypy_boto3_s3control.type_defs import (
    AbortIncompleteMultipartUploadTypeDef,
    VpcConfigurationTypeDef,
    ActivityMetricsTypeDef,
    AsyncErrorDetailsTypeDef,
    DeleteMultiRegionAccessPointInputTypeDef,
    PutMultiRegionAccessPointPolicyInputTypeDef,
    AwsLambdaTransformationTypeDef,
    CloudWatchMetricsTypeDef,
    ResponseMetadataTypeDef,
    PublicAccessBlockConfigurationTypeDef,
    CreateBucketConfigurationTypeDef,
    JobReportTypeDef,
    S3TagTypeDef,
    RegionTypeDef,
    DeleteAccessPointForObjectLambdaRequestRequestTypeDef,
    DeleteAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
    DeleteAccessPointPolicyRequestRequestTypeDef,
    DeleteAccessPointRequestRequestTypeDef,
    DeleteBucketLifecycleConfigurationRequestRequestTypeDef,
    DeleteBucketPolicyRequestRequestTypeDef,
    DeleteBucketRequestRequestTypeDef,
    DeleteBucketTaggingRequestRequestTypeDef,
    DeleteJobTaggingRequestRequestTypeDef,
    DeletePublicAccessBlockRequestRequestTypeDef,
    DeleteStorageLensConfigurationRequestRequestTypeDef,
    DeleteStorageLensConfigurationTaggingRequestRequestTypeDef,
    DescribeJobRequestRequestTypeDef,
    DescribeMultiRegionAccessPointOperationRequestRequestTypeDef,
    EstablishedMultiRegionAccessPointPolicyTypeDef,
    ExcludeTypeDef,
    SSEKMSEncryptionTypeDef,
    GetAccessPointConfigurationForObjectLambdaRequestRequestTypeDef,
    GetAccessPointForObjectLambdaRequestRequestTypeDef,
    GetAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
    GetAccessPointPolicyRequestRequestTypeDef,
    GetAccessPointPolicyStatusForObjectLambdaRequestRequestTypeDef,
    PolicyStatusTypeDef,
    GetAccessPointPolicyStatusRequestRequestTypeDef,
    GetAccessPointRequestRequestTypeDef,
    GetBucketLifecycleConfigurationRequestRequestTypeDef,
    GetBucketPolicyRequestRequestTypeDef,
    GetBucketRequestRequestTypeDef,
    GetBucketTaggingRequestRequestTypeDef,
    GetBucketVersioningRequestRequestTypeDef,
    GetJobTaggingRequestRequestTypeDef,
    GetMultiRegionAccessPointPolicyRequestRequestTypeDef,
    GetMultiRegionAccessPointPolicyStatusRequestRequestTypeDef,
    GetMultiRegionAccessPointRequestRequestTypeDef,
    GetPublicAccessBlockRequestRequestTypeDef,
    GetStorageLensConfigurationRequestRequestTypeDef,
    GetStorageLensConfigurationTaggingRequestRequestTypeDef,
    StorageLensTagTypeDef,
    IncludeTypeDef,
    JobFailureTypeDef,
    JobManifestGeneratorFilterTypeDef,
    JobManifestLocationTypeDef,
    JobManifestSpecTypeDef,
    LambdaInvokeOperationTypeDef,
    S3InitiateRestoreObjectOperationTypeDef,
    JobTimersTypeDef,
    LifecycleExpirationTypeDef,
    NoncurrentVersionExpirationTypeDef,
    NoncurrentVersionTransitionTypeDef,
    TransitionTypeDef,
    PaginatorConfigTypeDef,
    ListAccessPointsForObjectLambdaRequestRequestTypeDef,
    ObjectLambdaAccessPointTypeDef,
    ListAccessPointsRequestRequestTypeDef,
    ListJobsRequestRequestTypeDef,
    ListMultiRegionAccessPointsRequestRequestTypeDef,
    ListRegionalBucketsRequestRequestTypeDef,
    RegionalBucketTypeDef,
    ListStorageLensConfigurationEntryTypeDef,
    ListStorageLensConfigurationsRequestRequestTypeDef,
    ProposedMultiRegionAccessPointPolicyTypeDef,
    MultiRegionAccessPointRegionalResponseTypeDef,
    RegionReportTypeDef,
    SelectionCriteriaTypeDef,
    PutAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
    PutAccessPointPolicyRequestRequestTypeDef,
    PutBucketPolicyRequestRequestTypeDef,
    VersioningConfigurationTypeDef,
    S3ObjectOwnerTypeDef,
    S3ObjectMetadataTypeDef,
    S3GranteeTypeDef,
    S3ObjectLockLegalHoldTypeDef,
    S3RetentionTypeDef,
    SSEKMSTypeDef,
    StorageLensAwsOrgTypeDef,
    UpdateJobPriorityRequestRequestTypeDef,
    UpdateJobStatusRequestRequestTypeDef,
    AccessPointTypeDef,
    DeleteMultiRegionAccessPointRequestRequestTypeDef,
    PutMultiRegionAccessPointPolicyRequestRequestTypeDef,
    ObjectLambdaContentTransformationTypeDef,
    CreateAccessPointForObjectLambdaResultTypeDef,
    CreateAccessPointResultTypeDef,
    CreateBucketResultTypeDef,
    CreateJobResultTypeDef,
    CreateMultiRegionAccessPointResultTypeDef,
    DeleteMultiRegionAccessPointResultTypeDef,
    EmptyResponseMetadataTypeDef,
    GetAccessPointPolicyForObjectLambdaResultTypeDef,
    GetAccessPointPolicyResultTypeDef,
    GetBucketPolicyResultTypeDef,
    GetBucketResultTypeDef,
    GetBucketVersioningResultTypeDef,
    PutMultiRegionAccessPointPolicyResultTypeDef,
    UpdateJobPriorityResultTypeDef,
    UpdateJobStatusResultTypeDef,
    CreateAccessPointRequestRequestTypeDef,
    GetAccessPointForObjectLambdaResultTypeDef,
    GetAccessPointResultTypeDef,
    GetPublicAccessBlockOutputTypeDef,
    PutPublicAccessBlockRequestRequestTypeDef,
    CreateBucketRequestRequestTypeDef,
    GetBucketTaggingResultTypeDef,
    GetJobTaggingResultTypeDef,
    LifecycleRuleAndOperatorTypeDef,
    PutJobTaggingRequestRequestTypeDef,
    S3SetObjectTaggingOperationTypeDef,
    TaggingTypeDef,
    CreateMultiRegionAccessPointInputTypeDef,
    GeneratedManifestEncryptionTypeDef,
    GetAccessPointPolicyStatusForObjectLambdaResultTypeDef,
    GetAccessPointPolicyStatusResultTypeDef,
    GetMultiRegionAccessPointPolicyStatusResultTypeDef,
    GetStorageLensConfigurationTaggingResultTypeDef,
    PutStorageLensConfigurationTaggingRequestRequestTypeDef,
    S3GeneratedManifestDescriptorTypeDef,
    JobManifestTypeDef,
    JobProgressSummaryTypeDef,
    ListAccessPointsForObjectLambdaRequestListAccessPointsForObjectLambdaPaginateTypeDef,
    ListAccessPointsForObjectLambdaResultTypeDef,
    ListRegionalBucketsResultTypeDef,
    ListStorageLensConfigurationsResultTypeDef,
    MultiRegionAccessPointPolicyDocumentTypeDef,
    MultiRegionAccessPointsAsyncResponseTypeDef,
    MultiRegionAccessPointReportTypeDef,
    PrefixLevelStorageMetricsTypeDef,
    PutBucketVersioningRequestRequestTypeDef,
    S3GrantTypeDef,
    S3SetObjectLegalHoldOperationTypeDef,
    S3SetObjectRetentionOperationTypeDef,
    StorageLensDataExportEncryptionTypeDef,
    ListAccessPointsResultTypeDef,
    ObjectLambdaTransformationConfigurationTypeDef,
    LifecycleRuleFilterTypeDef,
    PutBucketTaggingRequestRequestTypeDef,
    AsyncRequestParametersTypeDef,
    CreateMultiRegionAccessPointRequestRequestTypeDef,
    S3ManifestOutputLocationTypeDef,
    JobListDescriptorTypeDef,
    GetMultiRegionAccessPointPolicyResultTypeDef,
    AsyncResponseDetailsTypeDef,
    GetMultiRegionAccessPointResultTypeDef,
    ListMultiRegionAccessPointsResultTypeDef,
    PrefixLevelTypeDef,
    S3AccessControlListTypeDef,
    S3CopyObjectOperationTypeDef,
    S3BucketDestinationTypeDef,
    ObjectLambdaConfigurationTypeDef,
    LifecycleRuleTypeDef,
    S3JobManifestGeneratorTypeDef,
    ListJobsResultTypeDef,
    AsyncOperationTypeDef,
    BucketLevelTypeDef,
    S3AccessControlPolicyTypeDef,
    StorageLensDataExportTypeDef,
    CreateAccessPointForObjectLambdaRequestRequestTypeDef,
    GetAccessPointConfigurationForObjectLambdaResultTypeDef,
    PutAccessPointConfigurationForObjectLambdaRequestRequestTypeDef,
    GetBucketLifecycleConfigurationResultTypeDef,
    LifecycleConfigurationTypeDef,
    JobManifestGeneratorTypeDef,
    DescribeMultiRegionAccessPointOperationResultTypeDef,
    AccountLevelTypeDef,
    S3SetObjectAclOperationTypeDef,
    PutBucketLifecycleConfigurationRequestRequestTypeDef,
    StorageLensConfigurationTypeDef,
    JobOperationTypeDef,
    GetStorageLensConfigurationResultTypeDef,
    PutStorageLensConfigurationRequestRequestTypeDef,
    CreateJobRequestRequestTypeDef,
    JobDescriptorTypeDef,
    DescribeJobResultTypeDef,
)


def get_structure() -> AbortIncompleteMultipartUploadTypeDef:
    return {...}
```

<a id="how-it-works"></a>

## How it works

Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers a drop-in type annotations for you and makes sure that:

- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
  annotations extracted from the documentation (blame `botocore` docs if types
  are incorrect).
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
  [isort](https://github.com/PyCQA/isort) for readability.

<a id="what's-new"></a>

## What's new

<a id="implemented-features"></a>

### Implemented features

- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
  compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
  annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.session` calls
- Auto discovery of types for `session.client` and `session.session` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
  calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls

<a id="latest-changes"></a>

### Latest changes

Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).

<a id="versioning"></a>

## Versioning

`mypy-boto3-s3control` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.

<a id="thank-you"></a>

## Thank you

- [Allie Fitter](https://github.com/alliefitter) for
  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
  this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
  tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
  [isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
  for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
  Python

<a id="documentation"></a>

## Documentation

All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3control/)

<a id="support-and-contributing"></a>

## Support and contributing

This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
