Type definitions#
Auto-generated documentation for Transfer type annotations stubs module mypy-boto3-transfer.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
As2ConnectorConfigTypeDef#
# As2ConnectorConfigTypeDef definition
class As2ConnectorConfigTypeDef(TypedDict):
LocalProfileId: NotRequired[str],
PartnerProfileId: NotRequired[str],
MessageSubject: NotRequired[str],
Compression: NotRequired[CompressionEnumType], # (1)
EncryptionAlgorithm: NotRequired[EncryptionAlgType], # (2)
SigningAlgorithm: NotRequired[SigningAlgType], # (3)
MdnSigningAlgorithm: NotRequired[MdnSigningAlgType], # (4)
MdnResponse: NotRequired[MdnResponseType], # (5)
BasicAuthSecretId: NotRequired[str],
- See CompressionEnumType
- See EncryptionAlgType
- See SigningAlgType
- See MdnSigningAlgType
- See MdnResponseType
HomeDirectoryMapEntryTypeDef#
# HomeDirectoryMapEntryTypeDef definition
class HomeDirectoryMapEntryTypeDef(TypedDict):
Entry: str,
Target: str,
Type: NotRequired[MapTypeType], # (1)
- See MapTypeType
PosixProfileTypeDef#
# PosixProfileTypeDef definition
class PosixProfileTypeDef(TypedDict):
Uid: int,
Gid: int,
SecondaryGids: NotRequired[Sequence[int]],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
SftpConnectorConfigTypeDef#
# SftpConnectorConfigTypeDef definition
class SftpConnectorConfigTypeDef(TypedDict):
UserSecretId: NotRequired[str],
TrustedHostKeys: NotRequired[Sequence[str]],
EndpointDetailsTypeDef#
# EndpointDetailsTypeDef definition
class EndpointDetailsTypeDef(TypedDict):
AddressAllocationIds: NotRequired[Sequence[str]],
SubnetIds: NotRequired[Sequence[str]],
VpcEndpointId: NotRequired[str],
VpcId: NotRequired[str],
SecurityGroupIds: NotRequired[Sequence[str]],
IdentityProviderDetailsTypeDef#
# IdentityProviderDetailsTypeDef definition
class IdentityProviderDetailsTypeDef(TypedDict):
Url: NotRequired[str],
InvocationRole: NotRequired[str],
DirectoryId: NotRequired[str],
Function: NotRequired[str],
SftpAuthenticationMethods: NotRequired[SftpAuthenticationMethodsType], # (1)
ProtocolDetailsTypeDef#
# ProtocolDetailsTypeDef definition
class ProtocolDetailsTypeDef(TypedDict):
PassiveIp: NotRequired[str],
TlsSessionResumptionMode: NotRequired[TlsSessionResumptionModeType], # (1)
SetStatOption: NotRequired[SetStatOptionType], # (2)
As2Transports: NotRequired[Sequence[As2TransportType]], # (3)
S3StorageOptionsTypeDef#
# S3StorageOptionsTypeDef definition
class S3StorageOptionsTypeDef(TypedDict):
DirectoryListingOptimization: NotRequired[DirectoryListingOptimizationType], # (1)
CustomStepDetailsTypeDef#
# CustomStepDetailsTypeDef definition
class CustomStepDetailsTypeDef(TypedDict):
Name: NotRequired[str],
Target: NotRequired[str],
TimeoutSeconds: NotRequired[int],
SourceFileLocation: NotRequired[str],
DeleteAccessRequestRequestTypeDef#
# DeleteAccessRequestRequestTypeDef definition
class DeleteAccessRequestRequestTypeDef(TypedDict):
ServerId: str,
ExternalId: str,
DeleteAgreementRequestRequestTypeDef#
# DeleteAgreementRequestRequestTypeDef definition
class DeleteAgreementRequestRequestTypeDef(TypedDict):
AgreementId: str,
ServerId: str,
DeleteCertificateRequestRequestTypeDef#
# DeleteCertificateRequestRequestTypeDef definition
class DeleteCertificateRequestRequestTypeDef(TypedDict):
CertificateId: str,
DeleteConnectorRequestRequestTypeDef#
# DeleteConnectorRequestRequestTypeDef definition
class DeleteConnectorRequestRequestTypeDef(TypedDict):
ConnectorId: str,
DeleteHostKeyRequestRequestTypeDef#
# DeleteHostKeyRequestRequestTypeDef definition
class DeleteHostKeyRequestRequestTypeDef(TypedDict):
ServerId: str,
HostKeyId: str,
DeleteProfileRequestRequestTypeDef#
# DeleteProfileRequestRequestTypeDef definition
class DeleteProfileRequestRequestTypeDef(TypedDict):
ProfileId: str,
DeleteServerRequestRequestTypeDef#
# DeleteServerRequestRequestTypeDef definition
class DeleteServerRequestRequestTypeDef(TypedDict):
ServerId: str,
DeleteSshPublicKeyRequestRequestTypeDef#
# DeleteSshPublicKeyRequestRequestTypeDef definition
class DeleteSshPublicKeyRequestRequestTypeDef(TypedDict):
ServerId: str,
SshPublicKeyId: str,
UserName: str,
DeleteStepDetailsTypeDef#
# DeleteStepDetailsTypeDef definition
class DeleteStepDetailsTypeDef(TypedDict):
Name: NotRequired[str],
SourceFileLocation: NotRequired[str],
DeleteUserRequestRequestTypeDef#
# DeleteUserRequestRequestTypeDef definition
class DeleteUserRequestRequestTypeDef(TypedDict):
ServerId: str,
UserName: str,
DeleteWorkflowRequestRequestTypeDef#
# DeleteWorkflowRequestRequestTypeDef definition
class DeleteWorkflowRequestRequestTypeDef(TypedDict):
WorkflowId: str,
DescribeAccessRequestRequestTypeDef#
# DescribeAccessRequestRequestTypeDef definition
class DescribeAccessRequestRequestTypeDef(TypedDict):
ServerId: str,
ExternalId: str,
DescribeAgreementRequestRequestTypeDef#
# DescribeAgreementRequestRequestTypeDef definition
class DescribeAgreementRequestRequestTypeDef(TypedDict):
AgreementId: str,
ServerId: str,
DescribeCertificateRequestRequestTypeDef#
# DescribeCertificateRequestRequestTypeDef definition
class DescribeCertificateRequestRequestTypeDef(TypedDict):
CertificateId: str,
DescribeConnectorRequestRequestTypeDef#
# DescribeConnectorRequestRequestTypeDef definition
class DescribeConnectorRequestRequestTypeDef(TypedDict):
ConnectorId: str,
DescribeExecutionRequestRequestTypeDef#
# DescribeExecutionRequestRequestTypeDef definition
class DescribeExecutionRequestRequestTypeDef(TypedDict):
ExecutionId: str,
WorkflowId: str,
DescribeHostKeyRequestRequestTypeDef#
# DescribeHostKeyRequestRequestTypeDef definition
class DescribeHostKeyRequestRequestTypeDef(TypedDict):
ServerId: str,
HostKeyId: str,
DescribeProfileRequestRequestTypeDef#
# DescribeProfileRequestRequestTypeDef definition
class DescribeProfileRequestRequestTypeDef(TypedDict):
ProfileId: str,
DescribeSecurityPolicyRequestRequestTypeDef#
# DescribeSecurityPolicyRequestRequestTypeDef definition
class DescribeSecurityPolicyRequestRequestTypeDef(TypedDict):
SecurityPolicyName: str,
DescribedSecurityPolicyTypeDef#
# DescribedSecurityPolicyTypeDef definition
class DescribedSecurityPolicyTypeDef(TypedDict):
SecurityPolicyName: str,
Fips: NotRequired[bool],
SshCiphers: NotRequired[List[str]],
SshKexs: NotRequired[List[str]],
SshMacs: NotRequired[List[str]],
TlsCiphers: NotRequired[List[str]],
DescribeServerRequestRequestTypeDef#
# DescribeServerRequestRequestTypeDef definition
class DescribeServerRequestRequestTypeDef(TypedDict):
ServerId: str,
WaiterConfigTypeDef#
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
DescribeUserRequestRequestTypeDef#
# DescribeUserRequestRequestTypeDef definition
class DescribeUserRequestRequestTypeDef(TypedDict):
ServerId: str,
UserName: str,
DescribeWorkflowRequestRequestTypeDef#
# DescribeWorkflowRequestRequestTypeDef definition
class DescribeWorkflowRequestRequestTypeDef(TypedDict):
WorkflowId: str,
LoggingConfigurationTypeDef#
# LoggingConfigurationTypeDef definition
class LoggingConfigurationTypeDef(TypedDict):
LoggingRole: NotRequired[str],
LogGroupName: NotRequired[str],
SshPublicKeyTypeDef#
# SshPublicKeyTypeDef definition
class SshPublicKeyTypeDef(TypedDict):
DateImported: datetime,
SshPublicKeyBody: str,
SshPublicKeyId: str,
EfsFileLocationTypeDef#
# EfsFileLocationTypeDef definition
class EfsFileLocationTypeDef(TypedDict):
FileSystemId: NotRequired[str],
Path: NotRequired[str],
ExecutionErrorTypeDef#
# ExecutionErrorTypeDef definition
class ExecutionErrorTypeDef(TypedDict):
Type: ExecutionErrorTypeType, # (1)
Message: str,
S3FileLocationTypeDef#
# S3FileLocationTypeDef definition
class S3FileLocationTypeDef(TypedDict):
Bucket: NotRequired[str],
Key: NotRequired[str],
VersionId: NotRequired[str],
Etag: NotRequired[str],
ImportSshPublicKeyRequestRequestTypeDef#
# ImportSshPublicKeyRequestRequestTypeDef definition
class ImportSshPublicKeyRequestRequestTypeDef(TypedDict):
ServerId: str,
SshPublicKeyBody: str,
UserName: str,
S3InputFileLocationTypeDef#
# S3InputFileLocationTypeDef definition
class S3InputFileLocationTypeDef(TypedDict):
Bucket: NotRequired[str],
Key: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListAccessesRequestRequestTypeDef#
# ListAccessesRequestRequestTypeDef definition
class ListAccessesRequestRequestTypeDef(TypedDict):
ServerId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListedAccessTypeDef#
# ListedAccessTypeDef definition
class ListedAccessTypeDef(TypedDict):
HomeDirectory: NotRequired[str],
HomeDirectoryType: NotRequired[HomeDirectoryTypeType], # (1)
Role: NotRequired[str],
ExternalId: NotRequired[str],
ListAgreementsRequestRequestTypeDef#
# ListAgreementsRequestRequestTypeDef definition
class ListAgreementsRequestRequestTypeDef(TypedDict):
ServerId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListedAgreementTypeDef#
# ListedAgreementTypeDef definition
class ListedAgreementTypeDef(TypedDict):
Arn: NotRequired[str],
AgreementId: NotRequired[str],