Skip to content

Type definitions#

Index > Transfer > 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],
  1. See CompressionEnumType
  2. See EncryptionAlgType
  3. See SigningAlgType
  4. See MdnSigningAlgType
  5. See MdnResponseType

HomeDirectoryMapEntryTypeDef#

# HomeDirectoryMapEntryTypeDef definition

class HomeDirectoryMapEntryTypeDef(TypedDict):
    Entry: str,
    Target: str,
    Type: NotRequired[MapTypeType],  # (1)
  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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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)
  1. See SftpAuthenticationMethodsType

ProtocolDetailsTypeDef#

# ProtocolDetailsTypeDef definition

class ProtocolDetailsTypeDef(TypedDict):
    PassiveIp: NotRequired[str],
    TlsSessionResumptionMode: NotRequired[TlsSessionResumptionModeType],  # (1)
    SetStatOption: NotRequired[SetStatOptionType],  # (2)
    As2Transports: NotRequired[Sequence[As2TransportType]],  # (3)
  1. See TlsSessionResumptionModeType
  2. See SetStatOptionType
  3. See As2TransportType

S3StorageOptionsTypeDef#

# S3StorageOptionsTypeDef definition

class S3StorageOptionsTypeDef(TypedDict):
    DirectoryListingOptimization: NotRequired[DirectoryListingOptimizationType],  # (1)
  1. See DirectoryListingOptimizationType

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,
  1. See ExecutionErrorTypeType

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],
  1. See HomeDirectoryTypeType

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],
    Description: NotRequired[str],
    Status: NotRequired[AgreementStatusTypeType],  # (1)
    ServerId: NotRequired[str],
    LocalProfileId: NotRequired[str],
    PartnerProfileId: NotRequired[str],
  1. See AgreementStatusTypeType

ListCertificatesRequestRequestTypeDef#

# ListCertificatesRequestRequestTypeDef definition

class ListCertificatesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListedCertificateTypeDef#

# ListedCertificateTypeDef definition

class ListedCertificateTypeDef(TypedDict):
    Arn: NotRequired[str],
    CertificateId: NotRequired[str],
    Usage: NotRequired[CertificateUsageTypeType],  # (1)
    Status: NotRequired[CertificateStatusTypeType],  # (2)
    ActiveDate: NotRequired[datetime],
    InactiveDate: NotRequired[datetime],
    Type: NotRequired[CertificateTypeType],  # (3)
    Description: NotRequired[str],
  1. See CertificateUsageTypeType
  2. See CertificateStatusTypeType
  3. See CertificateTypeType

ListConnectorsRequestRequestTypeDef#

# ListConnectorsRequestRequestTypeDef definition

class ListConnectorsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListedConnectorTypeDef#

# ListedConnectorTypeDef definition

class ListedConnectorTypeDef(TypedDict):
    Arn: NotRequired[str],
    ConnectorId: NotRequired[str],
    Url: NotRequired[str],

ListExecutionsRequestRequestTypeDef#

# ListExecutionsRequestRequestTypeDef definition

class ListExecutionsRequestRequestTypeDef(TypedDict):
    WorkflowId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListHostKeysRequestRequestTypeDef#

# ListHostKeysRequestRequestTypeDef definition

class ListHostKeysRequestRequestTypeDef(TypedDict):
    ServerId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListedHostKeyTypeDef#

# ListedHostKeyTypeDef definition

class ListedHostKeyTypeDef(TypedDict):
    Arn: str,
    HostKeyId: NotRequired[str],
    Fingerprint: NotRequired[str],
    Description: NotRequired[str],
    Type: NotRequired[str],
    DateImported: NotRequired[datetime],

ListProfilesRequestRequestTypeDef#

# ListProfilesRequestRequestTypeDef definition

class ListProfilesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    ProfileType: NotRequired[ProfileTypeType],  # (1)
  1. See ProfileTypeType

ListedProfileTypeDef#

# ListedProfileTypeDef definition

class ListedProfileTypeDef(TypedDict):
    Arn: NotRequired[str],
    ProfileId: NotRequired[str],
    As2Id: NotRequired[str],
    ProfileType: NotRequired[ProfileTypeType],  # (1)
  1. See ProfileTypeType

ListSecurityPoliciesRequestRequestTypeDef#

# ListSecurityPoliciesRequestRequestTypeDef definition

class ListSecurityPoliciesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListServersRequestRequestTypeDef#

# ListServersRequestRequestTypeDef definition

class ListServersRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListedServerTypeDef#

# ListedServerTypeDef definition

class ListedServerTypeDef(TypedDict):
    Arn: str,
    Domain: NotRequired[DomainType],  # (1)
    IdentityProviderType: NotRequired[IdentityProviderTypeType],  # (2)
    EndpointType: NotRequired[EndpointTypeType],  # (3)
    LoggingRole: NotRequired[str],
    ServerId: NotRequired[str],
    State: NotRequired[StateType],  # (4)
    UserCount: NotRequired[int],
  1. See DomainType
  2. See IdentityProviderTypeType
  3. See EndpointTypeType
  4. See StateType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    Arn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListUsersRequestRequestTypeDef#

# ListUsersRequestRequestTypeDef definition

class ListUsersRequestRequestTypeDef(TypedDict):
    ServerId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListedUserTypeDef#

# ListedUserTypeDef definition

class ListedUserTypeDef(TypedDict):
    Arn: str,
    HomeDirectory: NotRequired[str],
    HomeDirectoryType: NotRequired[HomeDirectoryTypeType],  # (1)
    Role: NotRequired[str],
    SshPublicKeyCount: NotRequired[int],
    UserName: NotRequired[str],
  1. See HomeDirectoryTypeType

ListWorkflowsRequestRequestTypeDef#

# ListWorkflowsRequestRequestTypeDef definition

class ListWorkflowsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListedWorkflowTypeDef#

# ListedWorkflowTypeDef definition

class ListedWorkflowTypeDef(TypedDict):
    WorkflowId: NotRequired[str],
    Description: NotRequired[str],
    Arn: NotRequired[str],

S3TagTypeDef#

# S3TagTypeDef definition

class S3TagTypeDef(TypedDict):
    Key: str,
    Value: str,

SendWorkflowStepStateRequestRequestTypeDef#

# SendWorkflowStepStateRequestRequestTypeDef definition

class SendWorkflowStepStateRequestRequestTypeDef(TypedDict):
    WorkflowId: str,
    ExecutionId: str,
    Token: str,
    Status: CustomStepStatusType,  # (1)
  1. See CustomStepStatusType

UserDetailsTypeDef#

# UserDetailsTypeDef definition

class UserDetailsTypeDef(TypedDict):
    UserName: str,
    ServerId: str,
    SessionId: NotRequired[str],

StartFileTransferRequestRequestTypeDef#

# StartFileTransferRequestRequestTypeDef definition

class StartFileTransferRequestRequestTypeDef(TypedDict):
    ConnectorId: str,
    SendFilePaths: NotRequired[Sequence[str]],
    RetrieveFilePaths: NotRequired[Sequence[str]],
    LocalDirectoryPath: NotRequired[str],
    RemoteDirectoryPath: NotRequired[str],

StartServerRequestRequestTypeDef#

# StartServerRequestRequestTypeDef definition

class StartServerRequestRequestTypeDef(TypedDict):
    ServerId: str,

StopServerRequestRequestTypeDef#

# StopServerRequestRequestTypeDef definition

class StopServerRequestRequestTypeDef(TypedDict):
    ServerId: str,

TestConnectionRequestRequestTypeDef#

# TestConnectionRequestRequestTypeDef definition

class TestConnectionRequestRequestTypeDef(TypedDict):
    ConnectorId: str,

TestIdentityProviderRequestRequestTypeDef#

# TestIdentityProviderRequestRequestTypeDef definition

class TestIdentityProviderRequestRequestTypeDef(TypedDict):
    ServerId: str,
    UserName: str,
    ServerProtocol: NotRequired[ProtocolType],  # (1)
    SourceIp: NotRequired[str],
    UserPassword: NotRequired[str],
  1. See ProtocolType

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    Arn: str,
    TagKeys: Sequence[str],

UpdateAgreementRequestRequestTypeDef#

# UpdateAgreementRequestRequestTypeDef definition

class UpdateAgreementRequestRequestTypeDef(TypedDict):
    AgreementId: str,
    ServerId: str,
    Description: NotRequired[str],
    Status: NotRequired[AgreementStatusTypeType],  # (1)
    LocalProfileId: NotRequired[str],
    PartnerProfileId: NotRequired[str],
    BaseDirectory: NotRequired[str],
    AccessRole: NotRequired[str],
  1. See AgreementStatusTypeType

UpdateHostKeyRequestRequestTypeDef#

# UpdateHostKeyRequestRequestTypeDef definition

class UpdateHostKeyRequestRequestTypeDef(TypedDict):
    ServerId: str,
    HostKeyId: str,
    Description: str,

UpdateProfileRequestRequestTypeDef#

# UpdateProfileRequestRequestTypeDef definition

class UpdateProfileRequestRequestTypeDef(TypedDict):
    ProfileId: str,
    CertificateIds: NotRequired[Sequence[str]],

WorkflowDetailTypeDef#

# WorkflowDetailTypeDef definition

class WorkflowDetailTypeDef(TypedDict):
    WorkflowId: str,
    ExecutionRole: str,

CreateAccessRequestRequestTypeDef#

# CreateAccessRequestRequestTypeDef definition

class CreateAccessRequestRequestTypeDef(TypedDict):
    Role: str,
    ServerId: str,
    ExternalId: str,
    HomeDirectory: NotRequired[str],
    HomeDirectoryType: NotRequired[HomeDirectoryTypeType],  # (1)
    HomeDirectoryMappings: NotRequired[Sequence[HomeDirectoryMapEntryTypeDef]],  # (2)
    Policy: NotRequired[str],
    PosixProfile: NotRequired[PosixProfileTypeDef],  # (3)
  1. See HomeDirectoryTypeType
  2. See HomeDirectoryMapEntryTypeDef
  3. See PosixProfileTypeDef

DescribedAccessTypeDef#

# DescribedAccessTypeDef definition

class DescribedAccessTypeDef(TypedDict):
    HomeDirectory: NotRequired[str],
    HomeDirectoryMappings: NotRequired[List[HomeDirectoryMapEntryTypeDef]],  # (1)
    HomeDirectoryType: NotRequired[HomeDirectoryTypeType],  # (2)
    Policy: NotRequired[str],
    PosixProfile: NotRequired[PosixProfileTypeDef],  # (3)
    Role: NotRequired[str],
    ExternalId: NotRequired[str],
  1. See HomeDirectoryMapEntryTypeDef
  2. See HomeDirectoryTypeType
  3. See PosixProfileTypeDef

UpdateAccessRequestRequestTypeDef#

# UpdateAccessRequestRequestTypeDef definition

class UpdateAccessRequestRequestTypeDef(TypedDict):
    ServerId: str,
    ExternalId: str,
    HomeDirectory: NotRequired[str],
    HomeDirectoryType: NotRequired[HomeDirectoryTypeType],  # (1)
    HomeDirectoryMappings: NotRequired[Sequence[HomeDirectoryMapEntryTypeDef]],  # (2)
    Policy: NotRequired[str],
    PosixProfile: NotRequired[PosixProfileTypeDef],  # (3)
    Role: NotRequired[str],
  1. See HomeDirectoryTypeType
  2. See HomeDirectoryMapEntryTypeDef
  3. See PosixProfileTypeDef

UpdateUserRequestRequestTypeDef#

# UpdateUserRequestRequestTypeDef definition

class UpdateUserRequestRequestTypeDef(TypedDict):
    ServerId: str,
    UserName: str,
    HomeDirectory: NotRequired[str],
    HomeDirectoryType: NotRequired[HomeDirectoryTypeType],  # (1)
    HomeDirectoryMappings: NotRequired[Sequence[HomeDirectoryMapEntryTypeDef]],  # (2)
    Policy: NotRequired[str],
    PosixProfile: NotRequired[PosixProfileTypeDef],  # (3)
    Role: NotRequired[str],
  1. See HomeDirectoryTypeType
  2. See HomeDirectoryMapEntryTypeDef
  3. See PosixProfileTypeDef

CreateAccessResponseTypeDef#

# CreateAccessResponseTypeDef definition

class CreateAccessResponseTypeDef(TypedDict):
    ServerId: str,
    ExternalId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAgreementResponseTypeDef#

# CreateAgreementResponseTypeDef definition

class CreateAgreementResponseTypeDef(TypedDict):
    AgreementId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateConnectorResponseTypeDef#

# CreateConnectorResponseTypeDef definition

class CreateConnectorResponseTypeDef(TypedDict):
    ConnectorId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateProfileResponseTypeDef#

# CreateProfileResponseTypeDef definition

class CreateProfileResponseTypeDef(TypedDict):
    ProfileId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateServerResponseTypeDef#

# CreateServerResponseTypeDef definition

class CreateServerResponseTypeDef(TypedDict):
    ServerId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUserResponseTypeDef#

# CreateUserResponseTypeDef definition

class CreateUserResponseTypeDef(TypedDict):
    ServerId: str,
    UserName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateWorkflowResponseTypeDef#

# CreateWorkflowResponseTypeDef definition

class CreateWorkflowResponseTypeDef(TypedDict):
    WorkflowId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportCertificateResponseTypeDef#

# ImportCertificateResponseTypeDef definition

class ImportCertificateResponseTypeDef(TypedDict):
    CertificateId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportHostKeyResponseTypeDef#

# ImportHostKeyResponseTypeDef definition

class ImportHostKeyResponseTypeDef(TypedDict):
    ServerId: str,
    HostKeyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportSshPublicKeyResponseTypeDef#

# ImportSshPublicKeyResponseTypeDef definition

class ImportSshPublicKeyResponseTypeDef(TypedDict):
    ServerId: str,
    SshPublicKeyId: str,
    UserName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListSecurityPoliciesResponseTypeDef#

# ListSecurityPoliciesResponseTypeDef definition

class ListSecurityPoliciesResponseTypeDef(TypedDict):
    NextToken: str,
    SecurityPolicyNames: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartFileTransferResponseTypeDef#

# StartFileTransferResponseTypeDef definition

class StartFileTransferResponseTypeDef(TypedDict):
    TransferId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TestConnectionResponseTypeDef#

# TestConnectionResponseTypeDef definition

class TestConnectionResponseTypeDef(TypedDict):
    ConnectorId: str,
    Status: str,
    StatusMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TestIdentityProviderResponseTypeDef#

# TestIdentityProviderResponseTypeDef definition

class TestIdentityProviderResponseTypeDef(TypedDict):
    Response: str,
    StatusCode: int,
    Message: str,
    Url: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateAccessResponseTypeDef#

# UpdateAccessResponseTypeDef definition

class UpdateAccessResponseTypeDef(TypedDict):
    ServerId: str,
    ExternalId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateAgreementResponseTypeDef#

# UpdateAgreementResponseTypeDef definition

class UpdateAgreementResponseTypeDef(TypedDict):
    AgreementId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateCertificateResponseTypeDef#

# UpdateCertificateResponseTypeDef definition

class UpdateCertificateResponseTypeDef(TypedDict):
    CertificateId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateConnectorResponseTypeDef#

# UpdateConnectorResponseTypeDef definition

class UpdateConnectorResponseTypeDef(TypedDict):
    ConnectorId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateHostKeyResponseTypeDef#

# UpdateHostKeyResponseTypeDef definition

class UpdateHostKeyResponseTypeDef(TypedDict):
    ServerId: str,
    HostKeyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateProfileResponseTypeDef#

# UpdateProfileResponseTypeDef definition

class UpdateProfileResponseTypeDef(TypedDict):
    ProfileId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateServerResponseTypeDef#

# UpdateServerResponseTypeDef definition

class UpdateServerResponseTypeDef(TypedDict):
    ServerId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateUserResponseTypeDef#

# UpdateUserResponseTypeDef definition

class UpdateUserResponseTypeDef(TypedDict):
    ServerId: str,
    UserName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAgreementRequestRequestTypeDef#

# CreateAgreementRequestRequestTypeDef definition

class CreateAgreementRequestRequestTypeDef(TypedDict):
    ServerId: str,
    LocalProfileId: str,
    PartnerProfileId: str,
    BaseDirectory: str,
    AccessRole: str,
    Description: NotRequired[str],
    Status: NotRequired[AgreementStatusTypeType],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See AgreementStatusTypeType
  2. See TagTypeDef

CreateProfileRequestRequestTypeDef#

# CreateProfileRequestRequestTypeDef definition

class CreateProfileRequestRequestTypeDef(TypedDict):
    As2Id: str,
    ProfileType: ProfileTypeType,  # (1)
    CertificateIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See ProfileTypeType
  2. See TagTypeDef

CreateUserRequestRequestTypeDef#

# CreateUserRequestRequestTypeDef definition

class CreateUserRequestRequestTypeDef(TypedDict):
    Role: str,
    ServerId: str,
    UserName: str,
    HomeDirectory: NotRequired[str],
    HomeDirectoryType: NotRequired[HomeDirectoryTypeType],  # (1)
    HomeDirectoryMappings: NotRequired[Sequence[HomeDirectoryMapEntryTypeDef]],  # (2)
    Policy: NotRequired[str],
    PosixProfile: NotRequired[PosixProfileTypeDef],  # (3)
    SshPublicKeyBody: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See HomeDirectoryTypeType
  2. See HomeDirectoryMapEntryTypeDef
  3. See PosixProfileTypeDef
  4. See TagTypeDef

DescribedAgreementTypeDef#

# DescribedAgreementTypeDef definition

class DescribedAgreementTypeDef(TypedDict):
    Arn: str,
    AgreementId: NotRequired[str],
    Description: NotRequired[str],
    Status: NotRequired[AgreementStatusTypeType],  # (1)
    ServerId: NotRequired[str],
    LocalProfileId: NotRequired[str],
    PartnerProfileId: NotRequired[str],
    BaseDirectory: NotRequired[str],
    AccessRole: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (2)
  1. See AgreementStatusTypeType
  2. See TagTypeDef

DescribedCertificateTypeDef#

# DescribedCertificateTypeDef definition

class DescribedCertificateTypeDef(TypedDict):
    Arn: str,
    CertificateId: NotRequired[str],
    Usage: NotRequired[CertificateUsageTypeType],  # (1)
    Status: NotRequired[CertificateStatusTypeType],  # (2)
    Certificate: NotRequired[str],
    CertificateChain: NotRequired[str],
    ActiveDate: NotRequired[datetime],
    InactiveDate: NotRequired[datetime],
    Serial: NotRequired[str],
    NotBeforeDate: NotRequired[datetime],
    NotAfterDate: NotRequired[datetime],
    Type: NotRequired[CertificateTypeType],  # (3)
    Description: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (4)
  1. See CertificateUsageTypeType
  2. See CertificateStatusTypeType
  3. See CertificateTypeType
  4. See TagTypeDef

DescribedHostKeyTypeDef#

# DescribedHostKeyTypeDef definition

class DescribedHostKeyTypeDef(TypedDict):
    Arn: str,
    HostKeyId: NotRequired[str],
    HostKeyFingerprint: NotRequired[str],
    Description: NotRequired[str],
    Type: NotRequired[str],
    DateImported: NotRequired[datetime],
    Tags: NotRequired[List[TagTypeDef]],  # (1)
  1. See TagTypeDef

DescribedProfileTypeDef#

# DescribedProfileTypeDef definition

class DescribedProfileTypeDef(TypedDict):
    Arn: str,
    ProfileId: NotRequired[str],
    ProfileType: NotRequired[ProfileTypeType],  # (1)
    As2Id: NotRequired[str],
    CertificateIds: NotRequired[List[str]],
    Tags: NotRequired[List[TagTypeDef]],  # (2)
  1. See ProfileTypeType
  2. See TagTypeDef

ImportHostKeyRequestRequestTypeDef#

# ImportHostKeyRequestRequestTypeDef definition

class ImportHostKeyRequestRequestTypeDef(TypedDict):
    ServerId: str,
    HostKeyBody: str,
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Arn: str,
    NextToken: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    Arn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateConnectorRequestRequestTypeDef#

# CreateConnectorRequestRequestTypeDef definition

class CreateConnectorRequestRequestTypeDef(TypedDict):
    Url: str,
    AccessRole: str,
    As2Config: NotRequired[As2ConnectorConfigTypeDef],  # (1)
    LoggingRole: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    SftpConfig: NotRequired[SftpConnectorConfigTypeDef],  # (3)
  1. See As2ConnectorConfigTypeDef
  2. See TagTypeDef
  3. See SftpConnectorConfigTypeDef

DescribedConnectorTypeDef#

# DescribedConnectorTypeDef definition

class DescribedConnectorTypeDef(TypedDict):
    Arn: str,
    ConnectorId: NotRequired[str],
    Url: NotRequired[str],
    As2Config: NotRequired[As2ConnectorConfigTypeDef],  # (1)
    AccessRole: NotRequired[str],
    LoggingRole: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (2)
    SftpConfig: NotRequired[SftpConnectorConfigTypeDef],  # (3)
    ServiceManagedEgressIpAddresses: NotRequired[List[str]],
  1. See As2ConnectorConfigTypeDef
  2. See TagTypeDef
  3. See SftpConnectorConfigTypeDef

UpdateConnectorRequestRequestTypeDef#

# UpdateConnectorRequestRequestTypeDef definition

class UpdateConnectorRequestRequestTypeDef(TypedDict):
    ConnectorId: str,
    Url: NotRequired[str],
    As2Config: NotRequired[As2ConnectorConfigTypeDef],  # (1)
    AccessRole: NotRequired[str],
    LoggingRole: NotRequired[str],
    SftpConfig: NotRequired[SftpConnectorConfigTypeDef],  # (2)
  1. See As2ConnectorConfigTypeDef
  2. See SftpConnectorConfigTypeDef

DescribeSecurityPolicyResponseTypeDef#

# DescribeSecurityPolicyResponseTypeDef definition

class DescribeSecurityPolicyResponseTypeDef(TypedDict):
    SecurityPolicy: DescribedSecurityPolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedSecurityPolicyTypeDef
  2. See ResponseMetadataTypeDef

DescribeServerRequestServerOfflineWaitTypeDef#

# DescribeServerRequestServerOfflineWaitTypeDef definition

class DescribeServerRequestServerOfflineWaitTypeDef(TypedDict):
    ServerId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeServerRequestServerOnlineWaitTypeDef#

# DescribeServerRequestServerOnlineWaitTypeDef definition

class DescribeServerRequestServerOnlineWaitTypeDef(TypedDict):
    ServerId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribedUserTypeDef#

# DescribedUserTypeDef definition

class DescribedUserTypeDef(TypedDict):
    Arn: str,
    HomeDirectory: NotRequired[str],
    HomeDirectoryMappings: NotRequired[List[HomeDirectoryMapEntryTypeDef]],  # (1)
    HomeDirectoryType: NotRequired[HomeDirectoryTypeType],  # (2)
    Policy: NotRequired[str],
    PosixProfile: NotRequired[PosixProfileTypeDef],  # (3)
    Role: NotRequired[str],
    SshPublicKeys: NotRequired[List[SshPublicKeyTypeDef]],  # (4)
    Tags: NotRequired[List[TagTypeDef]],  # (5)
    UserName: NotRequired[str],
  1. See HomeDirectoryMapEntryTypeDef
  2. See HomeDirectoryTypeType
  3. See PosixProfileTypeDef
  4. See SshPublicKeyTypeDef
  5. See TagTypeDef

ExecutionStepResultTypeDef#

# ExecutionStepResultTypeDef definition

class ExecutionStepResultTypeDef(TypedDict):
    StepType: NotRequired[WorkflowStepTypeType],  # (1)
    Outputs: NotRequired[str],
    Error: NotRequired[ExecutionErrorTypeDef],  # (2)
  1. See WorkflowStepTypeType
  2. See ExecutionErrorTypeDef

FileLocationTypeDef#

# FileLocationTypeDef definition

class FileLocationTypeDef(TypedDict):
    S3FileLocation: NotRequired[S3FileLocationTypeDef],  # (1)
    EfsFileLocation: NotRequired[EfsFileLocationTypeDef],  # (2)
  1. See S3FileLocationTypeDef
  2. See EfsFileLocationTypeDef

ImportCertificateRequestRequestTypeDef#

# ImportCertificateRequestRequestTypeDef definition

class ImportCertificateRequestRequestTypeDef(TypedDict):
    Usage: CertificateUsageTypeType,  # (1)
    Certificate: str,
    CertificateChain: NotRequired[str],
    PrivateKey: NotRequired[str],
    ActiveDate: NotRequired[Union[datetime, str]],
    InactiveDate: NotRequired[Union[datetime, str]],
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See CertificateUsageTypeType
  2. See TagTypeDef

UpdateCertificateRequestRequestTypeDef#

# UpdateCertificateRequestRequestTypeDef definition

class UpdateCertificateRequestRequestTypeDef(TypedDict):
    CertificateId: str,
    ActiveDate: NotRequired[Union[datetime, str]],
    InactiveDate: NotRequired[Union[datetime, str]],
    Description: NotRequired[str],

InputFileLocationTypeDef#

# InputFileLocationTypeDef definition

class InputFileLocationTypeDef(TypedDict):
    S3FileLocation: NotRequired[S3InputFileLocationTypeDef],  # (1)
    EfsFileLocation: NotRequired[EfsFileLocationTypeDef],  # (2)
  1. See S3InputFileLocationTypeDef
  2. See EfsFileLocationTypeDef

ListAccessesRequestListAccessesPaginateTypeDef#

# ListAccessesRequestListAccessesPaginateTypeDef definition

class ListAccessesRequestListAccessesPaginateTypeDef(TypedDict):
    ServerId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAgreementsRequestListAgreementsPaginateTypeDef#

# ListAgreementsRequestListAgreementsPaginateTypeDef definition

class ListAgreementsRequestListAgreementsPaginateTypeDef(TypedDict):
    ServerId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListCertificatesRequestListCertificatesPaginateTypeDef#

# ListCertificatesRequestListCertificatesPaginateTypeDef definition

class ListCertificatesRequestListCertificatesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListConnectorsRequestListConnectorsPaginateTypeDef#

# ListConnectorsRequestListConnectorsPaginateTypeDef definition

class ListConnectorsRequestListConnectorsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListExecutionsRequestListExecutionsPaginateTypeDef#

# ListExecutionsRequestListExecutionsPaginateTypeDef definition

class ListExecutionsRequestListExecutionsPaginateTypeDef(TypedDict):
    WorkflowId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProfilesRequestListProfilesPaginateTypeDef#

# ListProfilesRequestListProfilesPaginateTypeDef definition

class ListProfilesRequestListProfilesPaginateTypeDef(TypedDict):
    ProfileType: NotRequired[ProfileTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ProfileTypeType
  2. See PaginatorConfigTypeDef

ListSecurityPoliciesRequestListSecurityPoliciesPaginateTypeDef#

# ListSecurityPoliciesRequestListSecurityPoliciesPaginateTypeDef definition

class ListSecurityPoliciesRequestListSecurityPoliciesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListServersRequestListServersPaginateTypeDef#

# ListServersRequestListServersPaginateTypeDef definition

class ListServersRequestListServersPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#

# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition

class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
    Arn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListUsersRequestListUsersPaginateTypeDef#

# ListUsersRequestListUsersPaginateTypeDef definition

class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
    ServerId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListWorkflowsRequestListWorkflowsPaginateTypeDef#

# ListWorkflowsRequestListWorkflowsPaginateTypeDef definition

class ListWorkflowsRequestListWorkflowsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAccessesResponseTypeDef#

# ListAccessesResponseTypeDef definition

class ListAccessesResponseTypeDef(TypedDict):
    NextToken: str,
    ServerId: str,
    Accesses: List[ListedAccessTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListedAccessTypeDef
  2. See ResponseMetadataTypeDef

ListAgreementsResponseTypeDef#

# ListAgreementsResponseTypeDef definition

class ListAgreementsResponseTypeDef(TypedDict):
    NextToken: str,
    Agreements: List[ListedAgreementTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListedAgreementTypeDef
  2. See ResponseMetadataTypeDef

ListCertificatesResponseTypeDef#

# ListCertificatesResponseTypeDef definition

class ListCertificatesResponseTypeDef(TypedDict):
    NextToken: str,
    Certificates: List[ListedCertificateTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListedCertificateTypeDef
  2. See ResponseMetadataTypeDef

ListConnectorsResponseTypeDef#

# ListConnectorsResponseTypeDef definition

class ListConnectorsResponseTypeDef(TypedDict):
    NextToken: str,
    Connectors: List[ListedConnectorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListedConnectorTypeDef
  2. See ResponseMetadataTypeDef

ListHostKeysResponseTypeDef#

# ListHostKeysResponseTypeDef definition

class ListHostKeysResponseTypeDef(TypedDict):
    NextToken: str,
    ServerId: str,
    HostKeys: List[ListedHostKeyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListedHostKeyTypeDef
  2. See ResponseMetadataTypeDef

ListProfilesResponseTypeDef#

# ListProfilesResponseTypeDef definition

class ListProfilesResponseTypeDef(TypedDict):
    NextToken: str,
    Profiles: List[ListedProfileTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListedProfileTypeDef
  2. See ResponseMetadataTypeDef

ListServersResponseTypeDef#

# ListServersResponseTypeDef definition

class ListServersResponseTypeDef(TypedDict):
    NextToken: str,
    Servers: List[ListedServerTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListedServerTypeDef
  2. See ResponseMetadataTypeDef

ListUsersResponseTypeDef#

# ListUsersResponseTypeDef definition

class ListUsersResponseTypeDef(TypedDict):
    NextToken: str,
    ServerId: str,
    Users: List[ListedUserTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListedUserTypeDef
  2. See ResponseMetadataTypeDef

ListWorkflowsResponseTypeDef#

# ListWorkflowsResponseTypeDef definition

class ListWorkflowsResponseTypeDef(TypedDict):
    NextToken: str,
    Workflows: List[ListedWorkflowTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListedWorkflowTypeDef
  2. See ResponseMetadataTypeDef

TagStepDetailsTypeDef#

# TagStepDetailsTypeDef definition

class TagStepDetailsTypeDef(TypedDict):
    Name: NotRequired[str],
    Tags: NotRequired[Sequence[S3TagTypeDef]],  # (1)
    SourceFileLocation: NotRequired[str],
  1. See S3TagTypeDef

ServiceMetadataTypeDef#

# ServiceMetadataTypeDef definition

class ServiceMetadataTypeDef(TypedDict):
    UserDetails: UserDetailsTypeDef,  # (1)
  1. See UserDetailsTypeDef

WorkflowDetailsTypeDef#

# WorkflowDetailsTypeDef definition

class WorkflowDetailsTypeDef(TypedDict):
    OnUpload: NotRequired[Sequence[WorkflowDetailTypeDef]],  # (1)
    OnPartialUpload: NotRequired[Sequence[WorkflowDetailTypeDef]],  # (1)
  1. See WorkflowDetailTypeDef
  2. See WorkflowDetailTypeDef

DescribeAccessResponseTypeDef#

# DescribeAccessResponseTypeDef definition

class DescribeAccessResponseTypeDef(TypedDict):
    ServerId: str,
    Access: DescribedAccessTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedAccessTypeDef
  2. See ResponseMetadataTypeDef

DescribeAgreementResponseTypeDef#

# DescribeAgreementResponseTypeDef definition

class DescribeAgreementResponseTypeDef(TypedDict):
    Agreement: DescribedAgreementTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedAgreementTypeDef
  2. See ResponseMetadataTypeDef

DescribeCertificateResponseTypeDef#

# DescribeCertificateResponseTypeDef definition

class DescribeCertificateResponseTypeDef(TypedDict):
    Certificate: DescribedCertificateTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedCertificateTypeDef
  2. See ResponseMetadataTypeDef

DescribeHostKeyResponseTypeDef#

# DescribeHostKeyResponseTypeDef definition

class DescribeHostKeyResponseTypeDef(TypedDict):
    HostKey: DescribedHostKeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedHostKeyTypeDef
  2. See ResponseMetadataTypeDef

DescribeProfileResponseTypeDef#

# DescribeProfileResponseTypeDef definition

class DescribeProfileResponseTypeDef(TypedDict):
    Profile: DescribedProfileTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedProfileTypeDef
  2. See ResponseMetadataTypeDef

DescribeConnectorResponseTypeDef#

# DescribeConnectorResponseTypeDef definition

class DescribeConnectorResponseTypeDef(TypedDict):
    Connector: DescribedConnectorTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedConnectorTypeDef
  2. See ResponseMetadataTypeDef

DescribeUserResponseTypeDef#

# DescribeUserResponseTypeDef definition

class DescribeUserResponseTypeDef(TypedDict):
    ServerId: str,
    User: DescribedUserTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedUserTypeDef
  2. See ResponseMetadataTypeDef

ExecutionResultsTypeDef#

# ExecutionResultsTypeDef definition

class ExecutionResultsTypeDef(TypedDict):
    Steps: NotRequired[List[ExecutionStepResultTypeDef]],  # (1)
    OnExceptionSteps: NotRequired[List[ExecutionStepResultTypeDef]],  # (1)
  1. See ExecutionStepResultTypeDef
  2. See ExecutionStepResultTypeDef

CopyStepDetailsTypeDef#

# CopyStepDetailsTypeDef definition

class CopyStepDetailsTypeDef(TypedDict):
    Name: NotRequired[str],
    DestinationFileLocation: NotRequired[InputFileLocationTypeDef],  # (1)
    OverwriteExisting: NotRequired[OverwriteExistingType],  # (2)
    SourceFileLocation: NotRequired[str],
  1. See InputFileLocationTypeDef
  2. See OverwriteExistingType

DecryptStepDetailsTypeDef#

# DecryptStepDetailsTypeDef definition

class DecryptStepDetailsTypeDef(TypedDict):
    Type: EncryptionTypeType,  # (1)
    DestinationFileLocation: InputFileLocationTypeDef,  # (3)
    Name: NotRequired[str],
    SourceFileLocation: NotRequired[str],
    OverwriteExisting: NotRequired[OverwriteExistingType],  # (2)
  1. See EncryptionTypeType
  2. See OverwriteExistingType
  3. See InputFileLocationTypeDef

ListedExecutionTypeDef#

# ListedExecutionTypeDef definition

class ListedExecutionTypeDef(TypedDict):
    ExecutionId: NotRequired[str],
    InitialFileLocation: NotRequired[FileLocationTypeDef],  # (1)
    ServiceMetadata: NotRequired[ServiceMetadataTypeDef],  # (2)
    Status: NotRequired[ExecutionStatusType],  # (3)
  1. See FileLocationTypeDef
  2. See ServiceMetadataTypeDef
  3. See ExecutionStatusType

CreateServerRequestRequestTypeDef#

# CreateServerRequestRequestTypeDef definition

class CreateServerRequestRequestTypeDef(TypedDict):
    Certificate: NotRequired[str],
    Domain: NotRequired[DomainType],  # (1)
    EndpointDetails: NotRequired[EndpointDetailsTypeDef],  # (2)
    EndpointType: NotRequired[EndpointTypeType],  # (3)
    HostKey: NotRequired[str],
    IdentityProviderDetails: NotRequired[IdentityProviderDetailsTypeDef],  # (4)
    IdentityProviderType: NotRequired[IdentityProviderTypeType],  # (5)
    LoggingRole: NotRequired[str],
    PostAuthenticationLoginBanner: NotRequired[str],
    PreAuthenticationLoginBanner: NotRequired[str],
    Protocols: NotRequired[Sequence[ProtocolType]],  # (6)
    ProtocolDetails: NotRequired[ProtocolDetailsTypeDef],  # (7)
    SecurityPolicyName: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (8)
    WorkflowDetails: NotRequired[WorkflowDetailsTypeDef],  # (9)
    StructuredLogDestinations: NotRequired[Sequence[str]],
    S3StorageOptions: NotRequired[S3StorageOptionsTypeDef],  # (10)
  1. See DomainType
  2. See EndpointDetailsTypeDef
  3. See EndpointTypeType
  4. See IdentityProviderDetailsTypeDef
  5. See IdentityProviderTypeType
  6. See ProtocolType
  7. See ProtocolDetailsTypeDef
  8. See TagTypeDef
  9. See WorkflowDetailsTypeDef
  10. See S3StorageOptionsTypeDef

DescribedServerTypeDef#

# DescribedServerTypeDef definition

class DescribedServerTypeDef(TypedDict):
    Arn: str,
    Certificate: NotRequired[str],
    ProtocolDetails: NotRequired[ProtocolDetailsTypeDef],  # (1)
    Domain: NotRequired[DomainType],  # (2)
    EndpointDetails: NotRequired[EndpointDetailsTypeDef],  # (3)
    EndpointType: NotRequired[EndpointTypeType],  # (4)
    HostKeyFingerprint: NotRequired[str],
    IdentityProviderDetails: NotRequired[IdentityProviderDetailsTypeDef],  # (5)
    IdentityProviderType: NotRequired[IdentityProviderTypeType],  # (6)
    LoggingRole: NotRequired[str],
    PostAuthenticationLoginBanner: NotRequired[str],
    PreAuthenticationLoginBanner: NotRequired[str],
    Protocols: NotRequired[List[ProtocolType]],  # (7)
    SecurityPolicyName: NotRequired[str],
    ServerId: NotRequired[str],
    State: NotRequired[StateType],  # (8)
    Tags: NotRequired[List[TagTypeDef]],  # (9)
    UserCount: NotRequired[int],
    WorkflowDetails: NotRequired[WorkflowDetailsTypeDef],  # (10)
    StructuredLogDestinations: NotRequired[List[str]],
    S3StorageOptions: NotRequired[S3StorageOptionsTypeDef],  # (11)
    As2ServiceManagedEgressIpAddresses: NotRequired[List[str]],
  1. See ProtocolDetailsTypeDef
  2. See DomainType
  3. See EndpointDetailsTypeDef
  4. See EndpointTypeType
  5. See IdentityProviderDetailsTypeDef
  6. See IdentityProviderTypeType
  7. See ProtocolType
  8. See StateType
  9. See TagTypeDef
  10. See WorkflowDetailsTypeDef
  11. See S3StorageOptionsTypeDef

UpdateServerRequestRequestTypeDef#

# UpdateServerRequestRequestTypeDef definition

class UpdateServerRequestRequestTypeDef(TypedDict):
    ServerId: str,
    Certificate: NotRequired[str],
    ProtocolDetails: NotRequired[ProtocolDetailsTypeDef],  # (1)
    EndpointDetails: NotRequired[EndpointDetailsTypeDef],  # (2)
    EndpointType: NotRequired[EndpointTypeType],  # (3)
    HostKey: NotRequired[str],
    IdentityProviderDetails: NotRequired[IdentityProviderDetailsTypeDef],  # (4)
    LoggingRole: NotRequired[str],
    PostAuthenticationLoginBanner: NotRequired[str],
    PreAuthenticationLoginBanner: NotRequired[str],
    Protocols: NotRequired[Sequence[ProtocolType]],  # (5)
    SecurityPolicyName: NotRequired[str],
    WorkflowDetails: NotRequired[WorkflowDetailsTypeDef],  # (6)
    StructuredLogDestinations: NotRequired[Sequence[str]],
    S3StorageOptions: NotRequired[S3StorageOptionsTypeDef],  # (7)
  1. See ProtocolDetailsTypeDef
  2. See EndpointDetailsTypeDef
  3. See EndpointTypeType
  4. See IdentityProviderDetailsTypeDef
  5. See ProtocolType
  6. See WorkflowDetailsTypeDef
  7. See S3StorageOptionsTypeDef

DescribedExecutionTypeDef#

# DescribedExecutionTypeDef definition

class DescribedExecutionTypeDef(TypedDict):
    ExecutionId: NotRequired[str],
    InitialFileLocation: NotRequired[FileLocationTypeDef],  # (1)
    ServiceMetadata: NotRequired[ServiceMetadataTypeDef],  # (2)
    ExecutionRole: NotRequired[str],
    LoggingConfiguration: NotRequired[LoggingConfigurationTypeDef],  # (3)
    PosixProfile: NotRequired[PosixProfileTypeDef],  # (4)
    Status: NotRequired[ExecutionStatusType],  # (5)
    Results: NotRequired[ExecutionResultsTypeDef],  # (6)
  1. See FileLocationTypeDef
  2. See ServiceMetadataTypeDef
  3. See LoggingConfigurationTypeDef
  4. See PosixProfileTypeDef
  5. See ExecutionStatusType
  6. See ExecutionResultsTypeDef

WorkflowStepTypeDef#

# WorkflowStepTypeDef definition

class WorkflowStepTypeDef(TypedDict):
    Type: NotRequired[WorkflowStepTypeType],  # (1)
    CopyStepDetails: NotRequired[CopyStepDetailsTypeDef],  # (2)
    CustomStepDetails: NotRequired[CustomStepDetailsTypeDef],  # (3)
    DeleteStepDetails: NotRequired[DeleteStepDetailsTypeDef],  # (4)
    TagStepDetails: NotRequired[TagStepDetailsTypeDef],  # (5)
    DecryptStepDetails: NotRequired[DecryptStepDetailsTypeDef],  # (6)
  1. See WorkflowStepTypeType
  2. See CopyStepDetailsTypeDef
  3. See CustomStepDetailsTypeDef
  4. See DeleteStepDetailsTypeDef
  5. See TagStepDetailsTypeDef
  6. See DecryptStepDetailsTypeDef

ListExecutionsResponseTypeDef#

# ListExecutionsResponseTypeDef definition

class ListExecutionsResponseTypeDef(TypedDict):
    NextToken: str,
    WorkflowId: str,
    Executions: List[ListedExecutionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListedExecutionTypeDef
  2. See ResponseMetadataTypeDef

DescribeServerResponseTypeDef#

# DescribeServerResponseTypeDef definition

class DescribeServerResponseTypeDef(TypedDict):
    Server: DescribedServerTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedServerTypeDef
  2. See ResponseMetadataTypeDef

DescribeExecutionResponseTypeDef#

# DescribeExecutionResponseTypeDef definition

class DescribeExecutionResponseTypeDef(TypedDict):
    WorkflowId: str,
    Execution: DescribedExecutionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedExecutionTypeDef
  2. See ResponseMetadataTypeDef

CreateWorkflowRequestRequestTypeDef#

# CreateWorkflowRequestRequestTypeDef definition

class CreateWorkflowRequestRequestTypeDef(TypedDict):
    Steps: Sequence[WorkflowStepTypeDef],  # (1)
    Description: NotRequired[str],
    OnExceptionSteps: NotRequired[Sequence[WorkflowStepTypeDef]],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See WorkflowStepTypeDef
  2. See WorkflowStepTypeDef
  3. See TagTypeDef

DescribedWorkflowTypeDef#

# DescribedWorkflowTypeDef definition

class DescribedWorkflowTypeDef(TypedDict):
    Arn: str,
    Description: NotRequired[str],
    Steps: NotRequired[List[WorkflowStepTypeDef]],  # (1)
    OnExceptionSteps: NotRequired[List[WorkflowStepTypeDef]],  # (1)
    WorkflowId: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (3)
  1. See WorkflowStepTypeDef
  2. See WorkflowStepTypeDef
  3. See TagTypeDef

DescribeWorkflowResponseTypeDef#

# DescribeWorkflowResponseTypeDef definition

class DescribeWorkflowResponseTypeDef(TypedDict):
    Workflow: DescribedWorkflowTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedWorkflowTypeDef
  2. See ResponseMetadataTypeDef