%global _empty_manifest_terminate_build 0
Name: python-mypy-boto3-s3control
Version: 1.26.92
Release: 1
Summary: Type annotations for boto3.S3Control 1.26.92 service generated with mypy-boto3-builder 7.13.0
License: MIT License
URL: https://github.com/youtype/mypy_boto3_builder
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/07/67/d88c9b0837fda188a2fb18955bba558941ae9c36a48fe07634d45673610e/mypy-boto3-s3control-1.26.92.tar.gz
BuildArch: noarch
Requires: python3-typing-extensions
%description
# mypy-boto3-s3control
[](https://pypi.org/project/mypy-boto3-s3control)
[](https://pypi.org/project/mypy-boto3-s3control)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-s3control)

Type annotations for
[boto3.S3Control 1.26.92](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.13.0](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:

- [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)
## How to install
### 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`.
### 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
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-s3control
```
## Usage
### 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.
### 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.
### 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.
### 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.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### 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.
### 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.
## Explicit type annotations
### 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
```
### 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")
)
```
### 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,
DeleteMarkerReplicationStatusType,
ExistingObjectReplicationStatusType,
ExpirationStatusType,
FormatType,
GeneratedManifestFormatType,
JobManifestFieldNameType,
JobManifestFormatType,
JobReportFormatType,
JobReportScopeType,
JobStatusType,
ListAccessPointsForObjectLambdaPaginatorName,
MFADeleteStatusType,
MFADeleteType,
MetricsStatusType,
MultiRegionAccessPointStatusType,
NetworkOriginType,
ObjectLambdaAccessPointAliasStatusType,
ObjectLambdaAllowedFeatureType,
ObjectLambdaTransformationConfigurationActionType,
OperationNameType,
OutputSchemaVersionType,
OwnerOverrideType,
ReplicaModificationsStatusType,
ReplicationRuleStatusType,
ReplicationStatusType,
ReplicationStorageClassType,
ReplicationTimeStatusType,
RequestedJobStatusType,
S3CannedAccessControlListType,
S3ChecksumAlgorithmType,
S3GlacierJobTierType,
S3GranteeTypeIdentifierType,
S3MetadataDirectiveType,
S3ObjectLockLegalHoldStatusType,
S3ObjectLockModeType,
S3ObjectLockRetentionModeType,
S3PermissionType,
S3SSEAlgorithmType,
S3StorageClassType,
SseKmsEncryptedObjectsStatusType,
TransitionStorageClassType,
S3ControlServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: AsyncOperationNameType) -> bool:
...
```
### 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,
AccessControlTranslationTypeDef,
VpcConfigurationTypeDef,
ActivityMetricsTypeDef,
AdvancedCostOptimizationMetricsTypeDef,
AdvancedDataProtectionMetricsTypeDef,
DetailedStatusCodesMetricsTypeDef,
AsyncErrorDetailsTypeDef,
DeleteMultiRegionAccessPointInputTypeDef,
PutMultiRegionAccessPointPolicyInputTypeDef,
AwsLambdaTransformationTypeDef,
CloudWatchMetricsTypeDef,
ObjectLambdaAccessPointAliasTypeDef,
ResponseMetadataTypeDef,
PublicAccessBlockConfigurationTypeDef,
CreateBucketConfigurationTypeDef,
JobReportTypeDef,
S3TagTypeDef,
RegionTypeDef,
DeleteAccessPointForObjectLambdaRequestRequestTypeDef,
DeleteAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
DeleteAccessPointPolicyRequestRequestTypeDef,
DeleteAccessPointRequestRequestTypeDef,
DeleteBucketLifecycleConfigurationRequestRequestTypeDef,
DeleteBucketPolicyRequestRequestTypeDef,
DeleteBucketReplicationRequestRequestTypeDef,
DeleteBucketRequestRequestTypeDef,
DeleteBucketTaggingRequestRequestTypeDef,
DeleteJobTaggingRequestRequestTypeDef,
DeleteMarkerReplicationTypeDef,
DeletePublicAccessBlockRequestRequestTypeDef,
DeleteStorageLensConfigurationRequestRequestTypeDef,
DeleteStorageLensConfigurationTaggingRequestRequestTypeDef,
DescribeJobRequestRequestTypeDef,
DescribeMultiRegionAccessPointOperationRequestRequestTypeDef,
EncryptionConfigurationTypeDef,
EstablishedMultiRegionAccessPointPolicyTypeDef,
ExcludeTypeDef,
ExistingObjectReplicationTypeDef,
SSEKMSEncryptionTypeDef,
GetAccessPointConfigurationForObjectLambdaRequestRequestTypeDef,
GetAccessPointForObjectLambdaRequestRequestTypeDef,
GetAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
GetAccessPointPolicyRequestRequestTypeDef,
GetAccessPointPolicyStatusForObjectLambdaRequestRequestTypeDef,
PolicyStatusTypeDef,
GetAccessPointPolicyStatusRequestRequestTypeDef,
GetAccessPointRequestRequestTypeDef,
GetBucketLifecycleConfigurationRequestRequestTypeDef,
GetBucketPolicyRequestRequestTypeDef,
GetBucketReplicationRequestRequestTypeDef,
GetBucketRequestRequestTypeDef,
GetBucketTaggingRequestRequestTypeDef,
GetBucketVersioningRequestRequestTypeDef,
GetJobTaggingRequestRequestTypeDef,
GetMultiRegionAccessPointPolicyRequestRequestTypeDef,
GetMultiRegionAccessPointPolicyStatusRequestRequestTypeDef,
GetMultiRegionAccessPointRequestRequestTypeDef,
GetMultiRegionAccessPointRoutesRequestRequestTypeDef,
MultiRegionAccessPointRouteTypeDef,
GetPublicAccessBlockRequestRequestTypeDef,
GetStorageLensConfigurationRequestRequestTypeDef,
GetStorageLensConfigurationTaggingRequestRequestTypeDef,
StorageLensTagTypeDef,
IncludeTypeDef,
JobFailureTypeDef,
JobManifestGeneratorFilterTypeDef,
JobManifestLocationTypeDef,
JobManifestSpecTypeDef,
LambdaInvokeOperationTypeDef,
S3InitiateRestoreObjectOperationTypeDef,
JobTimersTypeDef,
LifecycleExpirationTypeDef,
NoncurrentVersionExpirationTypeDef,
NoncurrentVersionTransitionTypeDef,
TransitionTypeDef,
PaginatorConfigTypeDef,
ListAccessPointsForObjectLambdaRequestRequestTypeDef,
ListAccessPointsRequestRequestTypeDef,
ListJobsRequestRequestTypeDef,
ListMultiRegionAccessPointsRequestRequestTypeDef,
ListRegionalBucketsRequestRequestTypeDef,
RegionalBucketTypeDef,
ListStorageLensConfigurationEntryTypeDef,
ListStorageLensConfigurationsRequestRequestTypeDef,
ReplicationTimeValueTypeDef,
ProposedMultiRegionAccessPointPolicyTypeDef,
MultiRegionAccessPointRegionalResponseTypeDef,
RegionReportTypeDef,
SelectionCriteriaTypeDef,
PutAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
PutAccessPointPolicyRequestRequestTypeDef,
PutBucketPolicyRequestRequestTypeDef,
VersioningConfigurationTypeDef,
ReplicaModificationsTypeDef,
S3ObjectOwnerTypeDef,
S3ObjectMetadataTypeDef,
S3GranteeTypeDef,
S3ObjectLockLegalHoldTypeDef,
S3RetentionTypeDef,
SSEKMSTypeDef,
SseKmsEncryptedObjectsTypeDef,
StorageLensAwsOrgTypeDef,
UpdateJobPriorityRequestRequestTypeDef,
UpdateJobStatusRequestRequestTypeDef,
AccessPointTypeDef,
DeleteMultiRegionAccessPointRequestRequestTypeDef,
PutMultiRegionAccessPointPolicyRequestRequestTypeDef,
ObjectLambdaContentTransformationTypeDef,
ObjectLambdaAccessPointTypeDef,
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,
ReplicationRuleAndOperatorTypeDef,
S3SetObjectTaggingOperationTypeDef,
TaggingTypeDef,
CreateMultiRegionAccessPointInputTypeDef,
GeneratedManifestEncryptionTypeDef,
GetAccessPointPolicyStatusForObjectLambdaResultTypeDef,
GetAccessPointPolicyStatusResultTypeDef,
GetMultiRegionAccessPointPolicyStatusResultTypeDef,
GetMultiRegionAccessPointRoutesResultTypeDef,
SubmitMultiRegionAccessPointRoutesRequestRequestTypeDef,
GetStorageLensConfigurationTaggingResultTypeDef,
PutStorageLensConfigurationTaggingRequestRequestTypeDef,
S3GeneratedManifestDescriptorTypeDef,
JobManifestTypeDef,
JobProgressSummaryTypeDef,
ListAccessPointsForObjectLambdaRequestListAccessPointsForObjectLambdaPaginateTypeDef,
ListRegionalBucketsResultTypeDef,
ListStorageLensConfigurationsResultTypeDef,
MetricsTypeDef,
ReplicationTimeTypeDef,
MultiRegionAccessPointPolicyDocumentTypeDef,
MultiRegionAccessPointsAsyncResponseTypeDef,
MultiRegionAccessPointReportTypeDef,
PrefixLevelStorageMetricsTypeDef,
PutBucketVersioningRequestRequestTypeDef,
S3GrantTypeDef,
S3SetObjectLegalHoldOperationTypeDef,
S3SetObjectRetentionOperationTypeDef,
StorageLensDataExportEncryptionTypeDef,
SourceSelectionCriteriaTypeDef,
ListAccessPointsResultTypeDef,
ObjectLambdaTransformationConfigurationTypeDef,
ListAccessPointsForObjectLambdaResultTypeDef,
LifecycleRuleFilterTypeDef,
ReplicationRuleFilterTypeDef,
PutBucketTaggingRequestRequestTypeDef,
AsyncRequestParametersTypeDef,
CreateMultiRegionAccessPointRequestRequestTypeDef,
S3ManifestOutputLocationTypeDef,
JobListDescriptorTypeDef,
DestinationTypeDef,
GetMultiRegionAccessPointPolicyResultTypeDef,
AsyncResponseDetailsTypeDef,
GetMultiRegionAccessPointResultTypeDef,
ListMultiRegionAccessPointsResultTypeDef,
PrefixLevelTypeDef,
S3AccessControlListTypeDef,
S3CopyObjectOperationTypeDef,
S3BucketDestinationTypeDef,
ObjectLambdaConfigurationTypeDef,
LifecycleRuleTypeDef,
S3JobManifestGeneratorTypeDef,
ListJobsResultTypeDef,
ReplicationRuleTypeDef,
AsyncOperationTypeDef,
BucketLevelTypeDef,
S3AccessControlPolicyTypeDef,
StorageLensDataExportTypeDef,
CreateAccessPointForObjectLambdaRequestRequestTypeDef,
GetAccessPointConfigurationForObjectLambdaResultTypeDef,
PutAccessPointConfigurationForObjectLambdaRequestRequestTypeDef,
GetBucketLifecycleConfigurationResultTypeDef,
LifecycleConfigurationTypeDef,
JobManifestGeneratorTypeDef,
ReplicationConfigurationTypeDef,
DescribeMultiRegionAccessPointOperationResultTypeDef,
AccountLevelTypeDef,
S3SetObjectAclOperationTypeDef,
PutBucketLifecycleConfigurationRequestRequestTypeDef,
GetBucketReplicationResultTypeDef,
PutBucketReplicationRequestRequestTypeDef,
StorageLensConfigurationTypeDef,
JobOperationTypeDef,
GetStorageLensConfigurationResultTypeDef,
PutStorageLensConfigurationRequestRequestTypeDef,
CreateJobRequestRequestTypeDef,
JobDescriptorTypeDef,
DescribeJobResultTypeDef,
)
def get_structure() -> AbortIncompleteMultipartUploadTypeDef:
return {...}
```
## 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.
## What's new
### 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
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## 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.
## 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
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3control/)
## 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.
%package -n python3-mypy-boto3-s3control
Summary: Type annotations for boto3.S3Control 1.26.92 service generated with mypy-boto3-builder 7.13.0
Provides: python-mypy-boto3-s3control
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mypy-boto3-s3control
# mypy-boto3-s3control
[](https://pypi.org/project/mypy-boto3-s3control)
[](https://pypi.org/project/mypy-boto3-s3control)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-s3control)

Type annotations for
[boto3.S3Control 1.26.92](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.13.0](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:

- [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)
## How to install
### 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`.
### 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
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-s3control
```
## Usage
### 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.
### 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.
### 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.
### 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.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### 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.
### 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.
## Explicit type annotations
### 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
```
### 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")
)
```
### 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,
DeleteMarkerReplicationStatusType,
ExistingObjectReplicationStatusType,
ExpirationStatusType,
FormatType,
GeneratedManifestFormatType,
JobManifestFieldNameType,
JobManifestFormatType,
JobReportFormatType,
JobReportScopeType,
JobStatusType,
ListAccessPointsForObjectLambdaPaginatorName,
MFADeleteStatusType,
MFADeleteType,
MetricsStatusType,
MultiRegionAccessPointStatusType,
NetworkOriginType,
ObjectLambdaAccessPointAliasStatusType,
ObjectLambdaAllowedFeatureType,
ObjectLambdaTransformationConfigurationActionType,
OperationNameType,
OutputSchemaVersionType,
OwnerOverrideType,
ReplicaModificationsStatusType,
ReplicationRuleStatusType,
ReplicationStatusType,
ReplicationStorageClassType,
ReplicationTimeStatusType,
RequestedJobStatusType,
S3CannedAccessControlListType,
S3ChecksumAlgorithmType,
S3GlacierJobTierType,
S3GranteeTypeIdentifierType,
S3MetadataDirectiveType,
S3ObjectLockLegalHoldStatusType,
S3ObjectLockModeType,
S3ObjectLockRetentionModeType,
S3PermissionType,
S3SSEAlgorithmType,
S3StorageClassType,
SseKmsEncryptedObjectsStatusType,
TransitionStorageClassType,
S3ControlServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: AsyncOperationNameType) -> bool:
...
```
### 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,
AccessControlTranslationTypeDef,
VpcConfigurationTypeDef,
ActivityMetricsTypeDef,
AdvancedCostOptimizationMetricsTypeDef,
AdvancedDataProtectionMetricsTypeDef,
DetailedStatusCodesMetricsTypeDef,
AsyncErrorDetailsTypeDef,
DeleteMultiRegionAccessPointInputTypeDef,
PutMultiRegionAccessPointPolicyInputTypeDef,
AwsLambdaTransformationTypeDef,
CloudWatchMetricsTypeDef,
ObjectLambdaAccessPointAliasTypeDef,
ResponseMetadataTypeDef,
PublicAccessBlockConfigurationTypeDef,
CreateBucketConfigurationTypeDef,
JobReportTypeDef,
S3TagTypeDef,
RegionTypeDef,
DeleteAccessPointForObjectLambdaRequestRequestTypeDef,
DeleteAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
DeleteAccessPointPolicyRequestRequestTypeDef,
DeleteAccessPointRequestRequestTypeDef,
DeleteBucketLifecycleConfigurationRequestRequestTypeDef,
DeleteBucketPolicyRequestRequestTypeDef,
DeleteBucketReplicationRequestRequestTypeDef,
DeleteBucketRequestRequestTypeDef,
DeleteBucketTaggingRequestRequestTypeDef,
DeleteJobTaggingRequestRequestTypeDef,
DeleteMarkerReplicationTypeDef,
DeletePublicAccessBlockRequestRequestTypeDef,
DeleteStorageLensConfigurationRequestRequestTypeDef,
DeleteStorageLensConfigurationTaggingRequestRequestTypeDef,
DescribeJobRequestRequestTypeDef,
DescribeMultiRegionAccessPointOperationRequestRequestTypeDef,
EncryptionConfigurationTypeDef,
EstablishedMultiRegionAccessPointPolicyTypeDef,
ExcludeTypeDef,
ExistingObjectReplicationTypeDef,
SSEKMSEncryptionTypeDef,
GetAccessPointConfigurationForObjectLambdaRequestRequestTypeDef,
GetAccessPointForObjectLambdaRequestRequestTypeDef,
GetAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
GetAccessPointPolicyRequestRequestTypeDef,
GetAccessPointPolicyStatusForObjectLambdaRequestRequestTypeDef,
PolicyStatusTypeDef,
GetAccessPointPolicyStatusRequestRequestTypeDef,
GetAccessPointRequestRequestTypeDef,
GetBucketLifecycleConfigurationRequestRequestTypeDef,
GetBucketPolicyRequestRequestTypeDef,
GetBucketReplicationRequestRequestTypeDef,
GetBucketRequestRequestTypeDef,
GetBucketTaggingRequestRequestTypeDef,
GetBucketVersioningRequestRequestTypeDef,
GetJobTaggingRequestRequestTypeDef,
GetMultiRegionAccessPointPolicyRequestRequestTypeDef,
GetMultiRegionAccessPointPolicyStatusRequestRequestTypeDef,
GetMultiRegionAccessPointRequestRequestTypeDef,
GetMultiRegionAccessPointRoutesRequestRequestTypeDef,
MultiRegionAccessPointRouteTypeDef,
GetPublicAccessBlockRequestRequestTypeDef,
GetStorageLensConfigurationRequestRequestTypeDef,
GetStorageLensConfigurationTaggingRequestRequestTypeDef,
StorageLensTagTypeDef,
IncludeTypeDef,
JobFailureTypeDef,
JobManifestGeneratorFilterTypeDef,
JobManifestLocationTypeDef,
JobManifestSpecTypeDef,
LambdaInvokeOperationTypeDef,
S3InitiateRestoreObjectOperationTypeDef,
JobTimersTypeDef,
LifecycleExpirationTypeDef,
NoncurrentVersionExpirationTypeDef,
NoncurrentVersionTransitionTypeDef,
TransitionTypeDef,
PaginatorConfigTypeDef,
ListAccessPointsForObjectLambdaRequestRequestTypeDef,
ListAccessPointsRequestRequestTypeDef,
ListJobsRequestRequestTypeDef,
ListMultiRegionAccessPointsRequestRequestTypeDef,
ListRegionalBucketsRequestRequestTypeDef,
RegionalBucketTypeDef,
ListStorageLensConfigurationEntryTypeDef,
ListStorageLensConfigurationsRequestRequestTypeDef,
ReplicationTimeValueTypeDef,
ProposedMultiRegionAccessPointPolicyTypeDef,
MultiRegionAccessPointRegionalResponseTypeDef,
RegionReportTypeDef,
SelectionCriteriaTypeDef,
PutAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
PutAccessPointPolicyRequestRequestTypeDef,
PutBucketPolicyRequestRequestTypeDef,
VersioningConfigurationTypeDef,
ReplicaModificationsTypeDef,
S3ObjectOwnerTypeDef,
S3ObjectMetadataTypeDef,
S3GranteeTypeDef,
S3ObjectLockLegalHoldTypeDef,
S3RetentionTypeDef,
SSEKMSTypeDef,
SseKmsEncryptedObjectsTypeDef,
StorageLensAwsOrgTypeDef,
UpdateJobPriorityRequestRequestTypeDef,
UpdateJobStatusRequestRequestTypeDef,
AccessPointTypeDef,
DeleteMultiRegionAccessPointRequestRequestTypeDef,
PutMultiRegionAccessPointPolicyRequestRequestTypeDef,
ObjectLambdaContentTransformationTypeDef,
ObjectLambdaAccessPointTypeDef,
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,
ReplicationRuleAndOperatorTypeDef,
S3SetObjectTaggingOperationTypeDef,
TaggingTypeDef,
CreateMultiRegionAccessPointInputTypeDef,
GeneratedManifestEncryptionTypeDef,
GetAccessPointPolicyStatusForObjectLambdaResultTypeDef,
GetAccessPointPolicyStatusResultTypeDef,
GetMultiRegionAccessPointPolicyStatusResultTypeDef,
GetMultiRegionAccessPointRoutesResultTypeDef,
SubmitMultiRegionAccessPointRoutesRequestRequestTypeDef,
GetStorageLensConfigurationTaggingResultTypeDef,
PutStorageLensConfigurationTaggingRequestRequestTypeDef,
S3GeneratedManifestDescriptorTypeDef,
JobManifestTypeDef,
JobProgressSummaryTypeDef,
ListAccessPointsForObjectLambdaRequestListAccessPointsForObjectLambdaPaginateTypeDef,
ListRegionalBucketsResultTypeDef,
ListStorageLensConfigurationsResultTypeDef,
MetricsTypeDef,
ReplicationTimeTypeDef,
MultiRegionAccessPointPolicyDocumentTypeDef,
MultiRegionAccessPointsAsyncResponseTypeDef,
MultiRegionAccessPointReportTypeDef,
PrefixLevelStorageMetricsTypeDef,
PutBucketVersioningRequestRequestTypeDef,
S3GrantTypeDef,
S3SetObjectLegalHoldOperationTypeDef,
S3SetObjectRetentionOperationTypeDef,
StorageLensDataExportEncryptionTypeDef,
SourceSelectionCriteriaTypeDef,
ListAccessPointsResultTypeDef,
ObjectLambdaTransformationConfigurationTypeDef,
ListAccessPointsForObjectLambdaResultTypeDef,
LifecycleRuleFilterTypeDef,
ReplicationRuleFilterTypeDef,
PutBucketTaggingRequestRequestTypeDef,
AsyncRequestParametersTypeDef,
CreateMultiRegionAccessPointRequestRequestTypeDef,
S3ManifestOutputLocationTypeDef,
JobListDescriptorTypeDef,
DestinationTypeDef,
GetMultiRegionAccessPointPolicyResultTypeDef,
AsyncResponseDetailsTypeDef,
GetMultiRegionAccessPointResultTypeDef,
ListMultiRegionAccessPointsResultTypeDef,
PrefixLevelTypeDef,
S3AccessControlListTypeDef,
S3CopyObjectOperationTypeDef,
S3BucketDestinationTypeDef,
ObjectLambdaConfigurationTypeDef,
LifecycleRuleTypeDef,
S3JobManifestGeneratorTypeDef,
ListJobsResultTypeDef,
ReplicationRuleTypeDef,
AsyncOperationTypeDef,
BucketLevelTypeDef,
S3AccessControlPolicyTypeDef,
StorageLensDataExportTypeDef,
CreateAccessPointForObjectLambdaRequestRequestTypeDef,
GetAccessPointConfigurationForObjectLambdaResultTypeDef,
PutAccessPointConfigurationForObjectLambdaRequestRequestTypeDef,
GetBucketLifecycleConfigurationResultTypeDef,
LifecycleConfigurationTypeDef,
JobManifestGeneratorTypeDef,
ReplicationConfigurationTypeDef,
DescribeMultiRegionAccessPointOperationResultTypeDef,
AccountLevelTypeDef,
S3SetObjectAclOperationTypeDef,
PutBucketLifecycleConfigurationRequestRequestTypeDef,
GetBucketReplicationResultTypeDef,
PutBucketReplicationRequestRequestTypeDef,
StorageLensConfigurationTypeDef,
JobOperationTypeDef,
GetStorageLensConfigurationResultTypeDef,
PutStorageLensConfigurationRequestRequestTypeDef,
CreateJobRequestRequestTypeDef,
JobDescriptorTypeDef,
DescribeJobResultTypeDef,
)
def get_structure() -> AbortIncompleteMultipartUploadTypeDef:
return {...}
```
## 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.
## What's new
### 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
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## 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.
## 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
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3control/)
## 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.
%package help
Summary: Development documents and examples for mypy-boto3-s3control
Provides: python3-mypy-boto3-s3control-doc
%description help
# mypy-boto3-s3control
[](https://pypi.org/project/mypy-boto3-s3control)
[](https://pypi.org/project/mypy-boto3-s3control)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-s3control)

Type annotations for
[boto3.S3Control 1.26.92](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.13.0](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:

- [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)
## How to install
### 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`.
### 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
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-s3control
```
## Usage
### 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.
### 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.
### 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.
### 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.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### 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.
### 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.
## Explicit type annotations
### 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
```
### 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")
)
```
### 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,
DeleteMarkerReplicationStatusType,
ExistingObjectReplicationStatusType,
ExpirationStatusType,
FormatType,
GeneratedManifestFormatType,
JobManifestFieldNameType,
JobManifestFormatType,
JobReportFormatType,
JobReportScopeType,
JobStatusType,
ListAccessPointsForObjectLambdaPaginatorName,
MFADeleteStatusType,
MFADeleteType,
MetricsStatusType,
MultiRegionAccessPointStatusType,
NetworkOriginType,
ObjectLambdaAccessPointAliasStatusType,
ObjectLambdaAllowedFeatureType,
ObjectLambdaTransformationConfigurationActionType,
OperationNameType,
OutputSchemaVersionType,
OwnerOverrideType,
ReplicaModificationsStatusType,
ReplicationRuleStatusType,
ReplicationStatusType,
ReplicationStorageClassType,
ReplicationTimeStatusType,
RequestedJobStatusType,
S3CannedAccessControlListType,
S3ChecksumAlgorithmType,
S3GlacierJobTierType,
S3GranteeTypeIdentifierType,
S3MetadataDirectiveType,
S3ObjectLockLegalHoldStatusType,
S3ObjectLockModeType,
S3ObjectLockRetentionModeType,
S3PermissionType,
S3SSEAlgorithmType,
S3StorageClassType,
SseKmsEncryptedObjectsStatusType,
TransitionStorageClassType,
S3ControlServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: AsyncOperationNameType) -> bool:
...
```
### 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,
AccessControlTranslationTypeDef,
VpcConfigurationTypeDef,
ActivityMetricsTypeDef,
AdvancedCostOptimizationMetricsTypeDef,
AdvancedDataProtectionMetricsTypeDef,
DetailedStatusCodesMetricsTypeDef,
AsyncErrorDetailsTypeDef,
DeleteMultiRegionAccessPointInputTypeDef,
PutMultiRegionAccessPointPolicyInputTypeDef,
AwsLambdaTransformationTypeDef,
CloudWatchMetricsTypeDef,
ObjectLambdaAccessPointAliasTypeDef,
ResponseMetadataTypeDef,
PublicAccessBlockConfigurationTypeDef,
CreateBucketConfigurationTypeDef,
JobReportTypeDef,
S3TagTypeDef,
RegionTypeDef,
DeleteAccessPointForObjectLambdaRequestRequestTypeDef,
DeleteAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
DeleteAccessPointPolicyRequestRequestTypeDef,
DeleteAccessPointRequestRequestTypeDef,
DeleteBucketLifecycleConfigurationRequestRequestTypeDef,
DeleteBucketPolicyRequestRequestTypeDef,
DeleteBucketReplicationRequestRequestTypeDef,
DeleteBucketRequestRequestTypeDef,
DeleteBucketTaggingRequestRequestTypeDef,
DeleteJobTaggingRequestRequestTypeDef,
DeleteMarkerReplicationTypeDef,
DeletePublicAccessBlockRequestRequestTypeDef,
DeleteStorageLensConfigurationRequestRequestTypeDef,
DeleteStorageLensConfigurationTaggingRequestRequestTypeDef,
DescribeJobRequestRequestTypeDef,
DescribeMultiRegionAccessPointOperationRequestRequestTypeDef,
EncryptionConfigurationTypeDef,
EstablishedMultiRegionAccessPointPolicyTypeDef,
ExcludeTypeDef,
ExistingObjectReplicationTypeDef,
SSEKMSEncryptionTypeDef,
GetAccessPointConfigurationForObjectLambdaRequestRequestTypeDef,
GetAccessPointForObjectLambdaRequestRequestTypeDef,
GetAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
GetAccessPointPolicyRequestRequestTypeDef,
GetAccessPointPolicyStatusForObjectLambdaRequestRequestTypeDef,
PolicyStatusTypeDef,
GetAccessPointPolicyStatusRequestRequestTypeDef,
GetAccessPointRequestRequestTypeDef,
GetBucketLifecycleConfigurationRequestRequestTypeDef,
GetBucketPolicyRequestRequestTypeDef,
GetBucketReplicationRequestRequestTypeDef,
GetBucketRequestRequestTypeDef,
GetBucketTaggingRequestRequestTypeDef,
GetBucketVersioningRequestRequestTypeDef,
GetJobTaggingRequestRequestTypeDef,
GetMultiRegionAccessPointPolicyRequestRequestTypeDef,
GetMultiRegionAccessPointPolicyStatusRequestRequestTypeDef,
GetMultiRegionAccessPointRequestRequestTypeDef,
GetMultiRegionAccessPointRoutesRequestRequestTypeDef,
MultiRegionAccessPointRouteTypeDef,
GetPublicAccessBlockRequestRequestTypeDef,
GetStorageLensConfigurationRequestRequestTypeDef,
GetStorageLensConfigurationTaggingRequestRequestTypeDef,
StorageLensTagTypeDef,
IncludeTypeDef,
JobFailureTypeDef,
JobManifestGeneratorFilterTypeDef,
JobManifestLocationTypeDef,
JobManifestSpecTypeDef,
LambdaInvokeOperationTypeDef,
S3InitiateRestoreObjectOperationTypeDef,
JobTimersTypeDef,
LifecycleExpirationTypeDef,
NoncurrentVersionExpirationTypeDef,
NoncurrentVersionTransitionTypeDef,
TransitionTypeDef,
PaginatorConfigTypeDef,
ListAccessPointsForObjectLambdaRequestRequestTypeDef,
ListAccessPointsRequestRequestTypeDef,
ListJobsRequestRequestTypeDef,
ListMultiRegionAccessPointsRequestRequestTypeDef,
ListRegionalBucketsRequestRequestTypeDef,
RegionalBucketTypeDef,
ListStorageLensConfigurationEntryTypeDef,
ListStorageLensConfigurationsRequestRequestTypeDef,
ReplicationTimeValueTypeDef,
ProposedMultiRegionAccessPointPolicyTypeDef,
MultiRegionAccessPointRegionalResponseTypeDef,
RegionReportTypeDef,
SelectionCriteriaTypeDef,
PutAccessPointPolicyForObjectLambdaRequestRequestTypeDef,
PutAccessPointPolicyRequestRequestTypeDef,
PutBucketPolicyRequestRequestTypeDef,
VersioningConfigurationTypeDef,
ReplicaModificationsTypeDef,
S3ObjectOwnerTypeDef,
S3ObjectMetadataTypeDef,
S3GranteeTypeDef,
S3ObjectLockLegalHoldTypeDef,
S3RetentionTypeDef,
SSEKMSTypeDef,
SseKmsEncryptedObjectsTypeDef,
StorageLensAwsOrgTypeDef,
UpdateJobPriorityRequestRequestTypeDef,
UpdateJobStatusRequestRequestTypeDef,
AccessPointTypeDef,
DeleteMultiRegionAccessPointRequestRequestTypeDef,
PutMultiRegionAccessPointPolicyRequestRequestTypeDef,
ObjectLambdaContentTransformationTypeDef,
ObjectLambdaAccessPointTypeDef,
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,
ReplicationRuleAndOperatorTypeDef,
S3SetObjectTaggingOperationTypeDef,
TaggingTypeDef,
CreateMultiRegionAccessPointInputTypeDef,
GeneratedManifestEncryptionTypeDef,
GetAccessPointPolicyStatusForObjectLambdaResultTypeDef,
GetAccessPointPolicyStatusResultTypeDef,
GetMultiRegionAccessPointPolicyStatusResultTypeDef,
GetMultiRegionAccessPointRoutesResultTypeDef,
SubmitMultiRegionAccessPointRoutesRequestRequestTypeDef,
GetStorageLensConfigurationTaggingResultTypeDef,
PutStorageLensConfigurationTaggingRequestRequestTypeDef,
S3GeneratedManifestDescriptorTypeDef,
JobManifestTypeDef,
JobProgressSummaryTypeDef,
ListAccessPointsForObjectLambdaRequestListAccessPointsForObjectLambdaPaginateTypeDef,
ListRegionalBucketsResultTypeDef,
ListStorageLensConfigurationsResultTypeDef,
MetricsTypeDef,
ReplicationTimeTypeDef,
MultiRegionAccessPointPolicyDocumentTypeDef,
MultiRegionAccessPointsAsyncResponseTypeDef,
MultiRegionAccessPointReportTypeDef,
PrefixLevelStorageMetricsTypeDef,
PutBucketVersioningRequestRequestTypeDef,
S3GrantTypeDef,
S3SetObjectLegalHoldOperationTypeDef,
S3SetObjectRetentionOperationTypeDef,
StorageLensDataExportEncryptionTypeDef,
SourceSelectionCriteriaTypeDef,
ListAccessPointsResultTypeDef,
ObjectLambdaTransformationConfigurationTypeDef,
ListAccessPointsForObjectLambdaResultTypeDef,
LifecycleRuleFilterTypeDef,
ReplicationRuleFilterTypeDef,
PutBucketTaggingRequestRequestTypeDef,
AsyncRequestParametersTypeDef,
CreateMultiRegionAccessPointRequestRequestTypeDef,
S3ManifestOutputLocationTypeDef,
JobListDescriptorTypeDef,
DestinationTypeDef,
GetMultiRegionAccessPointPolicyResultTypeDef,
AsyncResponseDetailsTypeDef,
GetMultiRegionAccessPointResultTypeDef,
ListMultiRegionAccessPointsResultTypeDef,
PrefixLevelTypeDef,
S3AccessControlListTypeDef,
S3CopyObjectOperationTypeDef,
S3BucketDestinationTypeDef,
ObjectLambdaConfigurationTypeDef,
LifecycleRuleTypeDef,
S3JobManifestGeneratorTypeDef,
ListJobsResultTypeDef,
ReplicationRuleTypeDef,
AsyncOperationTypeDef,
BucketLevelTypeDef,
S3AccessControlPolicyTypeDef,
StorageLensDataExportTypeDef,
CreateAccessPointForObjectLambdaRequestRequestTypeDef,
GetAccessPointConfigurationForObjectLambdaResultTypeDef,
PutAccessPointConfigurationForObjectLambdaRequestRequestTypeDef,
GetBucketLifecycleConfigurationResultTypeDef,
LifecycleConfigurationTypeDef,
JobManifestGeneratorTypeDef,
ReplicationConfigurationTypeDef,
DescribeMultiRegionAccessPointOperationResultTypeDef,
AccountLevelTypeDef,
S3SetObjectAclOperationTypeDef,
PutBucketLifecycleConfigurationRequestRequestTypeDef,
GetBucketReplicationResultTypeDef,
PutBucketReplicationRequestRequestTypeDef,
StorageLensConfigurationTypeDef,
JobOperationTypeDef,
GetStorageLensConfigurationResultTypeDef,
PutStorageLensConfigurationRequestRequestTypeDef,
CreateJobRequestRequestTypeDef,
JobDescriptorTypeDef,
DescribeJobResultTypeDef,
)
def get_structure() -> AbortIncompleteMultipartUploadTypeDef:
return {...}
```
## 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.
## What's new
### 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
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## 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.
## 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
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3control/)
## 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.
%prep
%autosetup -n mypy-boto3-s3control-1.26.92
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-mypy-boto3-s3control -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 11 2023 Python_Bot - 1.26.92-1
- Package Spec generated