Transfer module#
Index > Transfer
Auto-generated documentation for Transfer type annotations stubs module 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#
Code samples can be found in Examples.
TransferClient#
Type annotations and code completion for boto3.client("transfer")
as TransferClient
boto3 documentation
# TransferClient usage example
from boto3.session import Session
from mypy_boto3_transfer.client import TransferClient
def get_client() -> TransferClient:
return Session().client("transfer")
Paginators#
Type annotations and code completion for paginators
from boto3.client("transfer").get_paginator("...")
.
# ListAccessesPaginator usage example
from boto3.session import Session
from mypy_boto3_transfer.paginator import ListAccessesPaginator
def get_list_accesses_paginator() -> ListAccessesPaginator:
return Session().client("transfer").get_paginator("list_accesses"))
- ListAccessesPaginator
- ListAgreementsPaginator
- ListCertificatesPaginator
- ListConnectorsPaginator
- ListExecutionsPaginator
- ListProfilesPaginator
- ListSecurityPoliciesPaginator
- ListServersPaginator
- ListTagsForResourcePaginator
- ListUsersPaginator
- ListWorkflowsPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("transfer").get_waiter("...")
.
# ServerOfflineWaiter usage example
from boto3.session import Session
from mypy_boto3_transfer.waiter import ServerOfflineWaiter
def get_server_offline_waiter() -> ServerOfflineWaiter:
return Session().client("transfer").get_waiter("server_offline")
Literals#
Type annotations for literals used in methods and schema.
# AgreementStatusTypeType usage example
from mypy_boto3_transfer.literals import AgreementStatusTypeType
def get_value() -> AgreementStatusTypeType:
return "ACTIVE"
- AgreementStatusTypeType
- As2TransportType
- CertificateStatusTypeType
- CertificateTypeType
- CertificateUsageTypeType
- CompressionEnumType
- CustomStepStatusType
- DirectoryListingOptimizationType
- DomainType
- EncryptionAlgType
- EncryptionTypeType
- EndpointTypeType
- ExecutionErrorTypeType
- ExecutionStatusType
- HomeDirectoryTypeType
- IdentityProviderTypeType
- ListAccessesPaginatorName
- ListAgreementsPaginatorName
- ListCertificatesPaginatorName
- ListConnectorsPaginatorName
- ListExecutionsPaginatorName
- ListProfilesPaginatorName
- ListSecurityPoliciesPaginatorName
- ListServersPaginatorName
- ListTagsForResourcePaginatorName
- ListUsersPaginatorName
- ListWorkflowsPaginatorName
- MapTypeType
- MdnResponseType
- MdnSigningAlgType
- OverwriteExistingType
- ProfileTypeType
- ProtocolType
- SecurityPolicyProtocolType
- SecurityPolicyResourceTypeType
- ServerOfflineWaiterName
- ServerOnlineWaiterName
- SetStatOptionType
- SftpAuthenticationMethodsType
- SigningAlgType
- StateType
- TlsSessionResumptionModeType
- WorkflowStepTypeType
- TransferServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- As2ConnectorConfigTypeDef
- HomeDirectoryMapEntryTypeDef
- PosixProfileTypeDef
- ResponseMetadataTypeDef
- TagTypeDef
- SftpConnectorConfigTypeDef
- EndpointDetailsTypeDef
- IdentityProviderDetailsTypeDef
- ProtocolDetailsTypeDef
- S3StorageOptionsTypeDef
- 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
- PosixProfileOutputTypeDef
- SftpConnectorConfigOutputTypeDef
- LoggingConfigurationTypeDef
- EndpointDetailsOutputTypeDef
- ProtocolDetailsOutputTypeDef
- SshPublicKeyTypeDef
- EfsFileLocationTypeDef
- ExecutionErrorTypeDef
- S3FileLocationTypeDef
- TimestampTypeDef
- 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
- StartDirectoryListingRequestRequestTypeDef
- StartFileTransferRequestRequestTypeDef
- StartServerRequestRequestTypeDef
- StopServerRequestRequestTypeDef
- TestConnectionRequestRequestTypeDef
- TestIdentityProviderRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateAgreementRequestRequestTypeDef
- UpdateHostKeyRequestRequestTypeDef
- UpdateProfileRequestRequestTypeDef
- WorkflowDetailTypeDef
- CreateAccessRequestRequestTypeDef
- UpdateAccessRequestRequestTypeDef
- UpdateUserRequestRequestTypeDef
- CreateAccessResponseTypeDef
- CreateAgreementResponseTypeDef
- CreateConnectorResponseTypeDef
- CreateProfileResponseTypeDef
- CreateServerResponseTypeDef
- CreateUserResponseTypeDef
- CreateWorkflowResponseTypeDef
- EmptyResponseMetadataTypeDef
- ImportCertificateResponseTypeDef
- ImportHostKeyResponseTypeDef
- ImportSshPublicKeyResponseTypeDef
- ListSecurityPoliciesResponseTypeDef
- StartDirectoryListingResponseTypeDef
- StartFileTransferResponseTypeDef
- TestConnectionResponseTypeDef
- TestIdentityProviderResponseTypeDef
- UpdateAccessResponseTypeDef
- UpdateAgreementResponseTypeDef
- UpdateCertificateResponseTypeDef
- UpdateConnectorResponseTypeDef
- UpdateHostKeyResponseTypeDef
- UpdateProfileResponseTypeDef
- UpdateServerResponseTypeDef
- UpdateUserResponseTypeDef
- CreateAgreementRequestRequestTypeDef
- CreateProfileRequestRequestTypeDef
- CreateUserRequestRequestTypeDef
- DescribedAgreementTypeDef
- DescribedCertificateTypeDef
- DescribedHostKeyTypeDef
- DescribedProfileTypeDef
- ImportHostKeyRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- CreateConnectorRequestRequestTypeDef
- UpdateConnectorRequestRequestTypeDef
- DescribeSecurityPolicyResponseTypeDef
- DescribeServerRequestServerOfflineWaitTypeDef
- DescribeServerRequestServerOnlineWaitTypeDef
- DescribedAccessTypeDef
- PosixProfileUnionTypeDef
- DescribedConnectorTypeDef
- SftpConnectorConfigUnionTypeDef
- EndpointDetailsUnionTypeDef
- ProtocolDetailsUnionTypeDef
- DescribedUserTypeDef
- ExecutionStepResultTypeDef
- FileLocationTypeDef
- ImportCertificateRequestRequestTypeDef
- UpdateCertificateRequestRequestTypeDef
- InputFileLocationTypeDef
- ListAccessesRequestListAccessesPaginateTypeDef
- ListAgreementsRequestListAgreementsPaginateTypeDef
- ListCertificatesRequestListCertificatesPaginateTypeDef
- ListConnectorsRequestListConnectorsPaginateTypeDef
- ListExecutionsRequestListExecutionsPaginateTypeDef
- ListProfilesRequestListProfilesPaginateTypeDef
- ListSecurityPoliciesRequestListSecurityPoliciesPaginateTypeDef
- ListServersRequestListServersPaginateTypeDef
- ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
- ListUsersRequestListUsersPaginateTypeDef
- ListWorkflowsRequestListWorkflowsPaginateTypeDef
- ListAccessesResponseTypeDef
- ListAgreementsResponseTypeDef
- ListCertificatesResponseTypeDef
- ListConnectorsResponseTypeDef
- ListHostKeysResponseTypeDef
- ListProfilesResponseTypeDef
- ListServersResponseTypeDef
- ListUsersResponseTypeDef
- ListWorkflowsResponseTypeDef
- TagStepDetailsOutputTypeDef
- TagStepDetailsTypeDef
- ServiceMetadataTypeDef
- WorkflowDetailsOutputTypeDef
- WorkflowDetailsTypeDef
- DescribeAgreementResponseTypeDef
- DescribeCertificateResponseTypeDef
- DescribeHostKeyResponseTypeDef
- DescribeProfileResponseTypeDef
- DescribeAccessResponseTypeDef
- DescribeConnectorResponseTypeDef
- DescribeUserResponseTypeDef
- ExecutionResultsTypeDef
- CopyStepDetailsTypeDef
- DecryptStepDetailsTypeDef
- ListedExecutionTypeDef
- DescribedServerTypeDef
- CreateServerRequestRequestTypeDef
- UpdateServerRequestRequestTypeDef
- WorkflowDetailsUnionTypeDef
- DescribedExecutionTypeDef
- WorkflowStepOutputTypeDef
- WorkflowStepTypeDef
- ListExecutionsResponseTypeDef
- DescribeServerResponseTypeDef
- DescribeExecutionResponseTypeDef
- DescribedWorkflowTypeDef
- WorkflowStepUnionTypeDef
- DescribeWorkflowResponseTypeDef
- CreateWorkflowRequestRequestTypeDef