mypy-boto3-transfer
Type annotations for boto3.Transfer 1.26.13 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-builder 7.11.11.
More information can be found on boto3-stubs page and in mypy-boto3-transfer docs.
See how it helps to find and fix potential bugs:
- mypy-boto3-transfer
How to install
VSCode extension
Add
AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start command.
Click Modify and select boto3 common and Transfer.
From PyPI with pip
Install boto3-stubs for Transfer service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[transfer]'
# 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[transfer]'
# standalone installation
python -m pip install mypy-boto3-transfer
How to uninstall
python -m pip uninstall -y mypy-boto3-transfer
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylanceas your Python Language Server - Install
boto3-stubs[transfer]in your environment:
python -m pip install 'boto3-stubs[transfer]'
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[transfer] in your environment:
python -m pip install 'boto3-stubs-lite[transfer]'`
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-stubswith services you use in your environment:
python -m pip install 'boto3-stubs[transfer]'
- Install use-package, lsp, company and flycheck packages
- Install lsp-pyright package
(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[transfer]with services you use in your environment:
python -m pip install 'boto3-stubs[transfer]'
- Install 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[transfer]in your environment:
python -m pip install 'boto3-stubs[transfer]'`
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[transfer]in your environment:
python -m pip install 'boto3-stubs[transfer]'
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
TransferClient provides annotations for boto3.client("transfer").
from boto3.session import Session
from mypy_boto3_transfer import TransferClient
client: TransferClient = Session().client("transfer")
# now client usage is checked by mypy and IDE should provide code completion
Paginators annotations
mypy_boto3_transfer.paginator module contains type annotations for all
paginators.
from boto3.session import Session
from mypy_boto3_transfer import TransferClient
from mypy_boto3_transfer.paginator import (
ListAccessesPaginator,
ListAgreementsPaginator,
ListCertificatesPaginator,
ListConnectorsPaginator,
ListExecutionsPaginator,
ListProfilesPaginator,
ListSecurityPoliciesPaginator,
ListServersPaginator,
ListTagsForResourcePaginator,
ListUsersPaginator,
ListWorkflowsPaginator,
)
client: TransferClient = Session().client("transfer")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_accesses_paginator: ListAccessesPaginator = client.get_paginator("list_accesses")
list_agreements_paginator: ListAgreementsPaginator = client.get_paginator("list_agreements")
list_certificates_paginator: ListCertificatesPaginator = client.get_paginator("list_certificates")
list_connectors_paginator: ListConnectorsPaginator = client.get_paginator("list_connectors")
list_executions_paginator: ListExecutionsPaginator = client.get_paginator("list_executions")
list_profiles_paginator: ListProfilesPaginator = client.get_paginator("list_profiles")
list_security_policies_paginator: ListSecurityPoliciesPaginator = client.get_paginator(
"list_security_policies"
)
list_servers_paginator: ListServersPaginator = client.get_paginator("list_servers")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
"list_tags_for_resource"
)
list_users_paginator: ListUsersPaginator = client.get_paginator("list_users")
list_workflows_paginator: ListWorkflowsPaginator = client.get_paginator("list_workflows")
Waiters annotations
mypy_boto3_transfer.waiter module contains type annotations for all waiters.
from boto3.session import Session
from mypy_boto3_transfer import TransferClient
from mypy_boto3_transfer.waiter import ServerOfflineWaiter, ServerOnlineWaiter
client: TransferClient = Session().client("transfer")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
server_offline_waiter: ServerOfflineWaiter = client.get_waiter("server_offline")
server_online_waiter: ServerOnlineWaiter = client.get_waiter("server_online")
Literals
mypy_boto3_transfer.literals module contains literals extracted from shapes
that can be used in user code for type checking.
from mypy_boto3_transfer.literals import (
AgreementStatusTypeType,
As2TransportType,
CertificateStatusTypeType,
CertificateTypeType,
CertificateUsageTypeType,
CompressionEnumType,
CustomStepStatusType,
DomainType,
EncryptionAlgType,
EndpointTypeType,
ExecutionErrorTypeType,
ExecutionStatusType,
HomeDirectoryTypeType,
IdentityProviderTypeType,
ListAccessesPaginatorName,
ListAgreementsPaginatorName,
ListCertificatesPaginatorName,
ListConnectorsPaginatorName,
ListExecutionsPaginatorName,
ListProfilesPaginatorName,
ListSecurityPoliciesPaginatorName,
ListServersPaginatorName,
ListTagsForResourcePaginatorName,
ListUsersPaginatorName,
ListWorkflowsPaginatorName,
MdnResponseType,
MdnSigningAlgType,
OverwriteExistingType,
ProfileTypeType,
ProtocolType,
ServerOfflineWaiterName,
ServerOnlineWaiterName,
SetStatOptionType,
SigningAlgType,
StateType,
TlsSessionResumptionModeType,
WorkflowStepTypeType,
TransferServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AgreementStatusTypeType) -> bool:
...
Typed dictionaries
mypy_boto3_transfer.type_defs module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_transfer.type_defs import (
As2ConnectorConfigTypeDef,
HomeDirectoryMapEntryTypeDef,
PosixProfileTypeDef,
ResponseMetadataTypeDef,
TagTypeDef,
EndpointDetailsTypeDef,
IdentityProviderDetailsTypeDef,
ProtocolDetailsTypeDef,
CustomStepDetailsTypeDef,
DeleteAccessRequestRequestTypeDef,
DeleteAgreementRequestRequestTypeDef,
DeleteCertificateRequestRequestTypeDef,
DeleteConnectorRequestRequestTypeDef,
DeleteHostKeyRequestRequestTypeDef,
DeleteProfileRequestRequestTypeDef,
DeleteServerRequestRequestTypeDef,
DeleteSshPublicKeyRequestRequestTypeDef,
DeleteStepDetailsTypeDef,
DeleteUserRequestRequestTypeDef,
DeleteWorkflowRequestRequestTypeDef,
DescribeAccessRequestRequestTypeDef,
DescribeAgreementRequestRequestTypeDef,
DescribeCertificateRequestRequestTypeDef,
DescribeConnectorRequestRequestTypeDef,
DescribeExecutionRequestRequestTypeDef,
DescribeHostKeyRequestRequestTypeDef,
DescribeProfileRequestRequestTypeDef,
DescribeSecurityPolicyRequestRequestTypeDef,
DescribedSecurityPolicyTypeDef,
DescribeServerRequestRequestTypeDef,
WaiterConfigTypeDef,
DescribeUserRequestRequestTypeDef,
DescribeWorkflowRequestRequestTypeDef,
LoggingConfigurationTypeDef,
SshPublicKeyTypeDef,
EfsFileLocationTypeDef,
ExecutionErrorTypeDef,
S3FileLocationTypeDef,
ImportSshPublicKeyRequestRequestTypeDef,
S3InputFileLocationTypeDef,
PaginatorConfigTypeDef,
ListAccessesRequestRequestTypeDef,
ListedAccessTypeDef,
ListAgreementsRequestRequestTypeDef,
ListedAgreementTypeDef,
ListCertificatesRequestRequestTypeDef,
ListedCertificateTypeDef,
ListConnectorsRequestRequestTypeDef,
ListedConnectorTypeDef,
ListExecutionsRequestRequestTypeDef,
ListHostKeysRequestRequestTypeDef,
ListedHostKeyTypeDef,
ListProfilesRequestRequestTypeDef,
ListedProfileTypeDef,
ListSecurityPoliciesRequestRequestTypeDef,
ListServersRequestRequestTypeDef,
ListedServerTypeDef,
ListTagsForResourceRequestRequestTypeDef,
ListUsersRequestRequestTypeDef,
ListedUserTypeDef,
ListWorkflowsRequestRequestTypeDef,
ListedWorkflowTypeDef,
S3TagTypeDef,
SendWorkflowStepStateRequestRequestTypeDef,
UserDetailsTypeDef,
StartFileTransferRequestRequestTypeDef,
StartServerRequestRequestTypeDef,
StopServerRequestRequestTypeDef,
TestIdentityProviderRequestRequestTypeDef,
UntagResourceRequestRequestTypeDef,
UpdateAgreementRequestRequestTypeDef,
UpdateCertificateRequestRequestTypeDef,
UpdateHostKeyRequestRequestTypeDef,
UpdateProfileRequestRequestTypeDef,
WorkflowDetailTypeDef,
UpdateConnectorRequestRequestTypeDef,
CreateAccessRequestRequestTypeDef,
DescribedAccessTypeDef,
UpdateAccessRequestRequestTypeDef,
UpdateUserRequestRequestTypeDef,
CreateAccessResponseTypeDef,
CreateAgreementResponseTypeDef,
CreateConnectorResponseTypeDef,
CreateProfileResponseTypeDef,
CreateServerResponseTypeDef,
CreateUserResponseTypeDef,
CreateWorkflowResponseTypeDef,
EmptyResponseMetadataTypeDef,
ImportCertificateResponseTypeDef,
ImportHostKeyResponseTypeDef,
ImportSshPublicKeyResponseTypeDef,
ListSecurityPoliciesResponseTypeDef,
StartFileTransferResponseTypeDef,
TestIdentityProviderResponseTypeDef,
UpdateAccessResponseTypeDef,
UpdateAgreementResponseTypeDef,
UpdateCertificateResponseTypeDef,
UpdateConnectorResponseTypeDef,
UpdateHostKeyResponseTypeDef,
UpdateProfileResponseTypeDef,
UpdateServerResponseTypeDef,
UpdateUserResponseTypeDef,
CreateAgreementRequestRequestTypeDef,
CreateConnectorRequestRequestTypeDef,
CreateProfileRequestRequestTypeDef,
CreateUserRequestRequestTypeDef,
DescribedAgreementTypeDef,
DescribedCertificateTypeDef,
DescribedConnectorTypeDef,
DescribedHostKeyTypeDef,
DescribedProfileTypeDef,
ImportCertificateRequestRequestTypeDef,
ImportHostKeyRequestRequestTypeDef,
ListTagsForResourceResponseTypeDef,
TagResourceRequestRequestTypeDef,
DescribeSecurityPolicyResponseTypeDef,
DescribeServerRequestServerOfflineWaitTypeDef,
DescribeServerRequestServerOnlineWaitTypeDef,
DescribedUserTypeDef,
ExecutionStepResultTypeDef,
FileLocationTypeDef,
InputFileLocationTypeDef,
ListAccessesRequestListAccessesPaginateTypeDef,
ListAgreementsRequestListAgreementsPaginateTypeDef,
ListCertificatesRequestListCertificatesPaginateTypeDef,
ListConnectorsRequestListConnectorsPaginateTypeDef,
ListExecutionsRequestListExecutionsPaginateTypeDef,
ListProfilesRequestListProfilesPaginateTypeDef,
ListSecurityPoliciesRequestListSecurityPoliciesPaginateTypeDef,
ListServersRequestListServersPaginateTypeDef,
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef,
ListUsersRequestListUsersPaginateTypeDef,
ListWorkflowsRequestListWorkflowsPaginateTypeDef,
ListAccessesResponseTypeDef,
ListAgreementsResponseTypeDef,
ListCertificatesResponseTypeDef,
ListConnectorsResponseTypeDef,
ListHostKeysResponseTypeDef,
ListProfilesResponseTypeDef,
ListServersResponseTypeDef,
ListUsersResponseTypeDef,
ListWorkflowsResponseTypeDef,
TagStepDetailsTypeDef,
ServiceMetadataTypeDef,
WorkflowDetailsTypeDef,
DescribeAccessResponseTypeDef,
DescribeAgreementResponseTypeDef,
DescribeCertificateResponseTypeDef,
DescribeConnectorResponseTypeDef,
DescribeHostKeyResponseTypeDef,
DescribeProfileResponseTypeDef,
DescribeUserResponseTypeDef,
ExecutionResultsTypeDef,
CopyStepDetailsTypeDef,
ListedExecutionTypeDef,
CreateServerRequestRequestTypeDef,
DescribedServerTypeDef,
UpdateServerRequestRequestTypeDef,
DescribedExecutionTypeDef,
WorkflowStepTypeDef,
ListExecutionsResponseTypeDef,
DescribeServerResponseTypeDef,
DescribeExecutionResponseTypeDef,
CreateWorkflowRequestRequestTypeDef,
DescribedWorkflowTypeDef,
DescribeWorkflowResponseTypeDef,
)
def get_structure() -> As2ConnectorConfigTypeDef:
return {...}
How it works
Fully automated
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
boto3services are covered. - Each public class and method of every
boto3service gets valid type annotations extracted from the documentation (blamebotocoredocs if types are incorrect). - Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by black and isort for readability.
What's new
Implemented features
- Fully type annotated
boto3,botocoreandaiobotocorelibraries mypy,pyright,VSCode,PyCharm,Sublime TextandEmacscompatibilityClient,ServiceResource,Resource,WaiterPaginatortype annotations for each service- Generated
TypeDefsfor each service - Generated
Literalsfor each service - Auto discovery of types for
boto3.clientandboto3.sessioncalls - Auto discovery of types for
session.clientandsession.sessioncalls - Auto discovery of types for
client.get_waiterandclient.get_paginatorcalls - Auto discovery of types for
ServiceResourceandResourcecollections - Auto discovery of types for
aiobotocore.Session.create_clientcalls
Latest changes
Builder changelog can be found in Releases.
Versioning
mypy-boto3-transfer version is the same as related boto3 version and
follows PEP 440 format.
Thank you
- Allie Fitter for boto3-type-annotations, this package is based on top of his work
- black developers for an awesome formatting tool
- Timothy Edmund Crosley for isort and how flexible it is
- mypy developers for doing all dirty work for us
- pyright team for the new era of typed Python
Documentation
All services type annotations can be found in boto3 docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
1 maintainer
Metadata
1 maintainer
Release files for mypy-boto3-transfer 1.26.13.post15
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| mypy-boto3-transfer-1.26.13.post15.tar.gz | 39.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mypy_boto3_transfer-1.26.13.post15-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 83.2 kB
Release files / mypy-boto3-transfer-1.26.13.post15.tar.gz
| Download URL | mypy-boto3-transfer-1.26.13.post15.tar.gz |
|---|---|
| Size | 39.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
09324091c205fbca5b8ec0c87c13ced155de1551e1d0f816e6df641eab327777
|
|
BLAKE2b-256 checksum How to use checksums |
cec925b4ea32313c496aa3f0f62b02ba02c723377750c0a6689ad6b313a0b87d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.0
|
Release files / mypy_boto3_transfer-1.26.13.post15-py3-none-any.whl
| Download URL | mypy_boto3_transfer-1.26.13.post15-py3-none-any.whl |
|---|---|
| Size | 44.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5c432a7dfd0ccaeec651ff2c52ad8c266ed5fbbcfbd5dca25599a817960ad4dd
|
|
BLAKE2b-256 checksum How to use checksums |
4dd618f3b669329a5cca15cd7feede131bf86577c210d3499273278f37e2acac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.0
|
Security for mypy-boto3-transfer 1.26.13.post15
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
