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
Usage
Code samples can be found in Examples.
TransferClient
Type annotations and code completion for boto3.client("transfer")
as TransferClient
boto3 documentation
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("...")
.
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("...")
.
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 schemas.
Usage example
from mypy_boto3_transfer.literals import AgreementStatusTypeType
def get_value() -> AgreementStatusTypeType:
return "ACTIVE"
- AgreementStatusTypeType
- As2TransportType
- CertificateStatusTypeType
- CertificateTypeType
- CertificateUsageTypeType
- CompressionEnumType
- CustomStepStatusType
- DomainType
- EncryptionAlgType
- EncryptionTypeType
- 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
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_transfer.type_defs import As2ConnectorConfigTypeDef
def get_value() -> As2ConnectorConfigTypeDef:
return {
"LocalProfileId": ...,
}
- 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
- DecryptStepDetailsTypeDef
- ListedExecutionTypeDef
- CreateServerRequestRequestTypeDef
- DescribedServerTypeDef
- UpdateServerRequestRequestTypeDef
- DescribedExecutionTypeDef
- WorkflowStepTypeDef
- ListExecutionsResponseTypeDef
- DescribeServerResponseTypeDef
- DescribeExecutionResponseTypeDef
- CreateWorkflowRequestRequestTypeDef
- DescribedWorkflowTypeDef
- DescribeWorkflowResponseTypeDef