Transfer module
Index > Transfer
Auto-generated documentation for Transfer type annotations stubs module types-aiobotocore-transfer.
How to install
From PyPI with pip
Install types-aioboto3
for Transfer
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[transfer]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[transfer]'
# standalone installation
python -m pip install types-aiobotocore-transfer
How to uninstall
Usage
Code samples can be found in Examples.
TransferClient
Type annotations and code completion for session.client("transfer")
as TransferClient
boto3 documentation
Usage example
from aioboto3.session import Session
from types_aiobotocore_transfer.client import TransferClient
session = Session()
async with session.client("transfer") as client:
client: TransferClient
Paginators
Type annotations and code completion for
paginators
from session.client("transfer").get_paginator("...")
.
Usage example
from types_aiobotocore_transfer.paginator import ListAccessesPaginator
def get_list_accesses_paginator() -> ListAccessesPaginator:
return client.get_paginator("list_accesses"))
- ListAccessesPaginator
- ListAgreementsPaginator
- ListCertificatesPaginator
- ListConnectorsPaginator
- ListExecutionsPaginator
- ListProfilesPaginator
- ListSecurityPoliciesPaginator
- ListServersPaginator
- ListTagsForResourcePaginator
- ListUsersPaginator
- ListWorkflowsPaginator
Waiters
Type annotations and code completion for
waiters
from session.client("transfer").get_waiter("...")
.
Usage example
from types_aiobotocore_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.
Usage example
from types_aiobotocore_transfer.literals import AgreementStatusTypeType
def get_value() -> AgreementStatusTypeType:
return "ACTIVE"
- 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
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from types_aiobotocore_transfer.type_defs import As2ConnectorConfigTypeDef
def get_value() -> As2ConnectorConfigTypeDef:
return {
"LocalProfileId": ...,
}
- As2ConnectorConfigTypeDef
- HomeDirectoryMapEntryTypeDef
- PosixProfileTypeDef
- ResponseMetadataTypeDef
- TagTypeDef
- EndpointDetailsTypeDef
- IdentityProviderDetailsTypeDef
- ProtocolDetailsTypeDef
- CustomStepDetailsTypeDef
- DeleteAccessRequestRequestTypeDef
- DeleteAgreementRequestRequestTypeDef
- DeleteCertificateRequestRequestTypeDef
- DeleteConnectorRequestRequestTypeDef
- DeleteProfileRequestRequestTypeDef
- DeleteServerRequestRequestTypeDef
- DeleteSshPublicKeyRequestRequestTypeDef
- DeleteStepDetailsTypeDef
- DeleteUserRequestRequestTypeDef
- DeleteWorkflowRequestRequestTypeDef
- DescribeAccessRequestRequestTypeDef
- DescribeAgreementRequestRequestTypeDef
- DescribeCertificateRequestRequestTypeDef
- DescribeConnectorRequestRequestTypeDef
- DescribeExecutionRequestRequestTypeDef
- DescribeProfileRequestRequestTypeDef
- DescribeSecurityPolicyRequestRequestTypeDef
- DescribedSecurityPolicyTypeDef
- DescribeServerRequestRequestTypeDef
- WaiterConfigTypeDef
- DescribeUserRequestRequestTypeDef
- DescribeWorkflowRequestRequestTypeDef
- LoggingConfigurationTypeDef
- SshPublicKeyTypeDef
- EfsFileLocationTypeDef
- ExecutionErrorTypeDef
- S3FileLocationTypeDef
- ImportSshPublicKeyRequestRequestTypeDef
- S3InputFileLocationTypeDef
- PaginatorConfigTypeDef
- ListAccessesRequestRequestTypeDef
- ListedAccessTypeDef
- ListAgreementsRequestRequestTypeDef
- ListedAgreementTypeDef
- ListCertificatesRequestRequestTypeDef
- ListedCertificateTypeDef
- ListConnectorsRequestRequestTypeDef
- ListedConnectorTypeDef
- ListExecutionsRequestRequestTypeDef
- ListProfilesRequestRequestTypeDef
- ListedProfileTypeDef
- ListSecurityPoliciesRequestRequestTypeDef
- ListServersRequestRequestTypeDef
- ListedServerTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListUsersRequestRequestTypeDef
- ListedUserTypeDef
- ListWorkflowsRequestRequestTypeDef
- ListedWorkflowTypeDef
- S3TagTypeDef
- SendWorkflowStepStateRequestRequestTypeDef
- UserDetailsTypeDef
- StartFileTransferRequestRequestTypeDef
- StartServerRequestRequestTypeDef
- StopServerRequestRequestTypeDef
- TestIdentityProviderRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateAgreementRequestRequestTypeDef
- UpdateCertificateRequestRequestTypeDef
- UpdateProfileRequestRequestTypeDef
- WorkflowDetailTypeDef
- UpdateConnectorRequestRequestTypeDef
- CreateAccessRequestRequestTypeDef
- DescribedAccessTypeDef
- UpdateAccessRequestRequestTypeDef
- UpdateUserRequestRequestTypeDef
- CreateAccessResponseTypeDef
- CreateAgreementResponseTypeDef
- CreateConnectorResponseTypeDef
- CreateProfileResponseTypeDef
- CreateServerResponseTypeDef
- CreateUserResponseTypeDef
- CreateWorkflowResponseTypeDef
- EmptyResponseMetadataTypeDef
- ImportCertificateResponseTypeDef
- ImportSshPublicKeyResponseTypeDef
- ListSecurityPoliciesResponseTypeDef
- StartFileTransferResponseTypeDef
- TestIdentityProviderResponseTypeDef
- UpdateAccessResponseTypeDef
- UpdateAgreementResponseTypeDef
- UpdateCertificateResponseTypeDef
- UpdateConnectorResponseTypeDef
- UpdateProfileResponseTypeDef
- UpdateServerResponseTypeDef
- UpdateUserResponseTypeDef
- CreateAgreementRequestRequestTypeDef
- CreateConnectorRequestRequestTypeDef
- CreateProfileRequestRequestTypeDef
- CreateUserRequestRequestTypeDef
- DescribedAgreementTypeDef
- DescribedCertificateTypeDef
- DescribedConnectorTypeDef
- DescribedProfileTypeDef
- ImportCertificateRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- DescribeSecurityPolicyResponseTypeDef
- DescribeServerRequestServerOfflineWaitTypeDef
- DescribeServerRequestServerOnlineWaitTypeDef
- DescribedUserTypeDef
- ExecutionStepResultTypeDef
- FileLocationTypeDef
- InputFileLocationTypeDef
- ListAccessesRequestListAccessesPaginateTypeDef
- ListAgreementsRequestListAgreementsPaginateTypeDef
- ListCertificatesRequestListCertificatesPaginateTypeDef
- ListConnectorsRequestListConnectorsPaginateTypeDef
- ListExecutionsRequestListExecutionsPaginateTypeDef
- ListProfilesRequestListProfilesPaginateTypeDef
- ListSecurityPoliciesRequestListSecurityPoliciesPaginateTypeDef
- ListServersRequestListServersPaginateTypeDef
- ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
- ListUsersRequestListUsersPaginateTypeDef
- ListWorkflowsRequestListWorkflowsPaginateTypeDef
- ListAccessesResponseTypeDef
- ListAgreementsResponseTypeDef
- ListCertificatesResponseTypeDef
- ListConnectorsResponseTypeDef
- ListProfilesResponseTypeDef
- ListServersResponseTypeDef
- ListUsersResponseTypeDef
- ListWorkflowsResponseTypeDef
- TagStepDetailsTypeDef
- ServiceMetadataTypeDef
- WorkflowDetailsTypeDef
- DescribeAccessResponseTypeDef
- DescribeAgreementResponseTypeDef
- DescribeCertificateResponseTypeDef
- DescribeConnectorResponseTypeDef
- DescribeProfileResponseTypeDef
- DescribeUserResponseTypeDef
- ExecutionResultsTypeDef
- CopyStepDetailsTypeDef
- ListedExecutionTypeDef
- CreateServerRequestRequestTypeDef
- DescribedServerTypeDef
- UpdateServerRequestRequestTypeDef
- DescribedExecutionTypeDef
- WorkflowStepTypeDef
- ListExecutionsResponseTypeDef
- DescribeServerResponseTypeDef
- DescribeExecutionResponseTypeDef
- CreateWorkflowRequestRequestTypeDef
- DescribedWorkflowTypeDef
- DescribeWorkflowResponseTypeDef