Skip to content

Type definitions#

Index > Transfer > Type definitions

Auto-generated documentation for Transfer type annotations stubs module mypy-boto3-transfer.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

TagStepDetailsUnionTypeDef#

# TagStepDetailsUnionTypeDef definition

TagStepDetailsUnionTypeDef = Union[
    TagStepDetailsTypeDef,  # (1)
    TagStepDetailsOutputTypeDef,  # (2)
]
  1. See TagStepDetailsTypeDef
  2. See TagStepDetailsOutputTypeDef

WorkflowStepUnionTypeDef#

# WorkflowStepUnionTypeDef definition

WorkflowStepUnionTypeDef = Union[
    WorkflowStepTypeDef,  # (1)
    WorkflowStepOutputTypeDef,  # (2)
]
  1. See WorkflowStepTypeDef
  2. See WorkflowStepOutputTypeDef

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],
    PreserveContentType: NotRequired[PreserveContentTypeType],  # (6)
  1. See CompressionEnumType
  2. See EncryptionAlgType
  3. See SigningAlgType
  4. See MdnSigningAlgType
  5. See MdnResponseType
  6. See PreserveContentTypeType

ConnectorFileTransferResultTypeDef#

# ConnectorFileTransferResultTypeDef definition

class ConnectorFileTransferResultTypeDef(TypedDict):
    FilePath: str,
    StatusCode: TransferTableStatusType,  # (1)
    FailureCode: NotRequired[str],
    FailureMessage: NotRequired[str],
  1. See TransferTableStatusType

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

WebAppUnitsTypeDef#

# WebAppUnitsTypeDef definition

class WebAppUnitsTypeDef(TypedDict):
    Provisioned: NotRequired[int],

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,

DeleteWebAppCustomizationRequestRequestTypeDef#

# DeleteWebAppCustomizationRequestRequestTypeDef definition

class DeleteWebAppCustomizationRequestRequestTypeDef(TypedDict):
    WebAppId: str,

DeleteWebAppRequestRequestTypeDef#

# DeleteWebAppRequestRequestTypeDef definition

class DeleteWebAppRequestRequestTypeDef(TypedDict):
    WebAppId: 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]],
    SshHostKeyAlgorithms: NotRequired[list[str]],
    Type: NotRequired[SecurityPolicyResourceTypeType],  # (1)
    Protocols: NotRequired[list[SecurityPolicyProtocolType]],  # (2)
  1. See SecurityPolicyResourceTypeType
  2. See SecurityPolicyProtocolType

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,

DescribeWebAppCustomizationRequestRequestTypeDef#

# DescribeWebAppCustomizationRequestRequestTypeDef definition

class DescribeWebAppCustomizationRequestRequestTypeDef(TypedDict):
    WebAppId: str,

DescribedWebAppCustomizationTypeDef#

# DescribedWebAppCustomizationTypeDef definition

class DescribedWebAppCustomizationTypeDef(TypedDict):
    Arn: str,
    WebAppId: str,
    Title: NotRequired[str],
    LogoFile: NotRequired[bytes],
    FaviconFile: NotRequired[bytes],

DescribeWebAppRequestRequestTypeDef#

# DescribeWebAppRequestRequestTypeDef definition

class DescribeWebAppRequestRequestTypeDef(TypedDict):
    WebAppId: str,

DescribeWorkflowRequestRequestTypeDef#

# DescribeWorkflowRequestRequestTypeDef definition

class DescribeWorkflowRequestRequestTypeDef(TypedDict):
    WorkflowId: str,

PosixProfileOutputTypeDef#

# PosixProfileOutputTypeDef definition

class PosixProfileOutputTypeDef(TypedDict):
    Uid: int,
    Gid: int,
    SecondaryGids: NotRequired[list[int]],

SftpConnectorConfigOutputTypeDef#

# SftpConnectorConfigOutputTypeDef definition

class SftpConnectorConfigOutputTypeDef(TypedDict):
    UserSecretId: NotRequired[str],
    TrustedHostKeys: NotRequired[list[str]],

LoggingConfigurationTypeDef#

# LoggingConfigurationTypeDef definition

class LoggingConfigurationTypeDef(TypedDict):
    LoggingRole: NotRequired[str],
    LogGroupName: NotRequired[str],

DescribedIdentityCenterConfigTypeDef#

# DescribedIdentityCenterConfigTypeDef definition

class DescribedIdentityCenterConfigTypeDef(TypedDict):
    ApplicationArn: NotRequired[str],
    InstanceArn: NotRequired[str],
    Role: NotRequired[str],

EndpointDetailsOutputTypeDef#

# EndpointDetailsOutputTypeDef definition

class EndpointDetailsOutputTypeDef(TypedDict):
    AddressAllocationIds: NotRequired[list[str]],
    SubnetIds: NotRequired[list[str]],
    VpcEndpointId: NotRequired[str],
    VpcId: NotRequired[str],
    SecurityGroupIds: NotRequired[list[str]],

ProtocolDetailsOutputTypeDef#

# ProtocolDetailsOutputTypeDef definition

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

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],

IdentityCenterConfigTypeDef#

# IdentityCenterConfigTypeDef definition

class IdentityCenterConfigTypeDef(TypedDict):
    InstanceArn: NotRequired[str],
    Role: 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],

ListFileTransferResultsRequestRequestTypeDef#

# ListFileTransferResultsRequestRequestTypeDef definition

class ListFileTransferResultsRequestRequestTypeDef(TypedDict):
    ConnectorId: str,
    TransferId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

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

ListWebAppsRequestRequestTypeDef#

# ListWebAppsRequestRequestTypeDef definition

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

ListedWebAppTypeDef#

# ListedWebAppTypeDef definition

class ListedWebAppTypeDef(TypedDict):
    Arn: str,
    WebAppId: str,
    AccessEndpoint: NotRequired[str],
    WebAppEndpoint: NotRequired[str],

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],

StartDirectoryListingRequestRequestTypeDef#

# StartDirectoryListingRequestRequestTypeDef definition

class StartDirectoryListingRequestRequestTypeDef(TypedDict):
    ConnectorId: str,
    RemoteDirectoryPath: str,
    OutputDirectoryPath: str,
    MaxItems: NotRequired[int],

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],
    PreserveFilename: NotRequired[PreserveFilenameTypeType],  # (2)
    EnforceMessageSigning: NotRequired[EnforceMessageSigningTypeType],  # (3)
  1. See AgreementStatusTypeType
  2. See PreserveFilenameTypeType
  3. See EnforceMessageSigningTypeType

UpdateHostKeyRequestRequestTypeDef#

# UpdateHostKeyRequestRequestTypeDef definition

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

UpdateProfileRequestRequestTypeDef#

# UpdateProfileRequestRequestTypeDef definition

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

UpdateWebAppIdentityCenterConfigTypeDef#

# UpdateWebAppIdentityCenterConfigTypeDef definition

class UpdateWebAppIdentityCenterConfigTypeDef(TypedDict):
    Role: NotRequired[str],

WorkflowDetailTypeDef#

# WorkflowDetailTypeDef definition

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

UpdateWebAppCustomizationRequestRequestTypeDef#

# UpdateWebAppCustomizationRequestRequestTypeDef definition

class UpdateWebAppCustomizationRequestRequestTypeDef(TypedDict):
    WebAppId: str,
    Title: NotRequired[str],
    LogoFile: NotRequired[BlobTypeDef],
    FaviconFile: NotRequired[BlobTypeDef],

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

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

CreateWebAppResponseTypeDef#

# CreateWebAppResponseTypeDef definition

class CreateWebAppResponseTypeDef(TypedDict):
    WebAppId: 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

ListFileTransferResultsResponseTypeDef#

# ListFileTransferResultsResponseTypeDef definition

class ListFileTransferResultsResponseTypeDef(TypedDict):
    FileTransferResults: list[ConnectorFileTransferResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ConnectorFileTransferResultTypeDef
  2. See ResponseMetadataTypeDef

ListSecurityPoliciesResponseTypeDef#

# ListSecurityPoliciesResponseTypeDef definition

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

StartDirectoryListingResponseTypeDef#

# StartDirectoryListingResponseTypeDef definition

class StartDirectoryListingResponseTypeDef(TypedDict):
    ListingId: str,
    OutputFileName: 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

UpdateWebAppCustomizationResponseTypeDef#

# UpdateWebAppCustomizationResponseTypeDef definition

class UpdateWebAppCustomizationResponseTypeDef(TypedDict):
    WebAppId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateWebAppResponseTypeDef#

# UpdateWebAppResponseTypeDef definition

class UpdateWebAppResponseTypeDef(TypedDict):
    WebAppId: 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)
    PreserveFilename: NotRequired[PreserveFilenameTypeType],  # (3)
    EnforceMessageSigning: NotRequired[EnforceMessageSigningTypeType],  # (4)
  1. See AgreementStatusTypeType
  2. See TagTypeDef
  3. See PreserveFilenameTypeType
  4. See EnforceMessageSigningTypeType

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)
    PreserveFilename: NotRequired[PreserveFilenameTypeType],  # (3)
    EnforceMessageSigning: NotRequired[EnforceMessageSigningTypeType],  # (4)
  1. See AgreementStatusTypeType
  2. See TagTypeDef
  3. See PreserveFilenameTypeType
  4. See EnforceMessageSigningTypeType

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,
    Tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  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)
    SecurityPolicyName: NotRequired[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)
    SecurityPolicyName: NotRequired[str],
  1. See As2ConnectorConfigTypeDef
  2. See SftpConnectorConfigTypeDef

DescribeSecurityPolicyResponseTypeDef#

# DescribeSecurityPolicyResponseTypeDef definition

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

DescribeServerRequestWaitTypeDef#

# DescribeServerRequestWaitTypeDef definition

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

DescribeWebAppCustomizationResponseTypeDef#

# DescribeWebAppCustomizationResponseTypeDef definition

class DescribeWebAppCustomizationResponseTypeDef(TypedDict):
    WebAppCustomization: DescribedWebAppCustomizationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedWebAppCustomizationTypeDef
  2. See ResponseMetadataTypeDef

DescribedAccessTypeDef#

# DescribedAccessTypeDef definition

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

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[SftpConnectorConfigOutputTypeDef],  # (3)
    ServiceManagedEgressIpAddresses: NotRequired[list[str]],
    SecurityPolicyName: NotRequired[str],
  1. See As2ConnectorConfigTypeDef
  2. See TagTypeDef
  3. See SftpConnectorConfigOutputTypeDef

DescribedWebAppIdentityProviderDetailsTypeDef#

# DescribedWebAppIdentityProviderDetailsTypeDef definition

class DescribedWebAppIdentityProviderDetailsTypeDef(TypedDict):
    IdentityCenterConfig: NotRequired[DescribedIdentityCenterConfigTypeDef],  # (1)
  1. See DescribedIdentityCenterConfigTypeDef

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[PosixProfileOutputTypeDef],  # (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 PosixProfileOutputTypeDef
  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

WebAppIdentityProviderDetailsTypeDef#

# WebAppIdentityProviderDetailsTypeDef definition

class WebAppIdentityProviderDetailsTypeDef(TypedDict):
    IdentityCenterConfig: NotRequired[IdentityCenterConfigTypeDef],  # (1)
  1. See IdentityCenterConfigTypeDef

ImportCertificateRequestRequestTypeDef#

# ImportCertificateRequestRequestTypeDef definition

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

UpdateCertificateRequestRequestTypeDef#

# UpdateCertificateRequestRequestTypeDef definition

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

InputFileLocationTypeDef#

# InputFileLocationTypeDef definition

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

ListAccessesRequestPaginateTypeDef#

# ListAccessesRequestPaginateTypeDef definition

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

ListAgreementsRequestPaginateTypeDef#

# ListAgreementsRequestPaginateTypeDef definition

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

ListCertificatesRequestPaginateTypeDef#

# ListCertificatesRequestPaginateTypeDef definition

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

ListConnectorsRequestPaginateTypeDef#

# ListConnectorsRequestPaginateTypeDef definition

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

ListExecutionsRequestPaginateTypeDef#

# ListExecutionsRequestPaginateTypeDef definition

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

ListFileTransferResultsRequestPaginateTypeDef#

# ListFileTransferResultsRequestPaginateTypeDef definition

class ListFileTransferResultsRequestPaginateTypeDef(TypedDict):
    ConnectorId: str,
    TransferId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProfilesRequestPaginateTypeDef#

# ListProfilesRequestPaginateTypeDef definition

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

ListSecurityPoliciesRequestPaginateTypeDef#

# ListSecurityPoliciesRequestPaginateTypeDef definition

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

ListServersRequestPaginateTypeDef#

# ListServersRequestPaginateTypeDef definition

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

ListTagsForResourceRequestPaginateTypeDef#

# ListTagsForResourceRequestPaginateTypeDef definition

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

ListUsersRequestPaginateTypeDef#

# ListUsersRequestPaginateTypeDef definition

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

ListWebAppsRequestPaginateTypeDef#

# ListWebAppsRequestPaginateTypeDef definition

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

ListWorkflowsRequestPaginateTypeDef#

# ListWorkflowsRequestPaginateTypeDef definition

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

ListAccessesResponseTypeDef#

# ListAccessesResponseTypeDef definition

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

ListAgreementsResponseTypeDef#

# ListAgreementsResponseTypeDef definition

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

ListCertificatesResponseTypeDef#

# ListCertificatesResponseTypeDef definition

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

ListConnectorsResponseTypeDef#

# ListConnectorsResponseTypeDef definition

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

ListHostKeysResponseTypeDef#

# ListHostKeysResponseTypeDef definition

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

ListProfilesResponseTypeDef#

# ListProfilesResponseTypeDef definition

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

ListServersResponseTypeDef#

# ListServersResponseTypeDef definition

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

ListUsersResponseTypeDef#

# ListUsersResponseTypeDef definition

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

ListWebAppsResponseTypeDef#

# ListWebAppsResponseTypeDef definition

class ListWebAppsResponseTypeDef(TypedDict):
    WebApps: list[ListedWebAppTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ListedWebAppTypeDef
  2. See ResponseMetadataTypeDef

ListWorkflowsResponseTypeDef#

# ListWorkflowsResponseTypeDef definition

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

TagStepDetailsOutputTypeDef#

# TagStepDetailsOutputTypeDef definition

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

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

UpdateWebAppIdentityProviderDetailsTypeDef#

# UpdateWebAppIdentityProviderDetailsTypeDef definition

class UpdateWebAppIdentityProviderDetailsTypeDef(TypedDict):
    IdentityCenterConfig: NotRequired[UpdateWebAppIdentityCenterConfigTypeDef],  # (1)
  1. See UpdateWebAppIdentityCenterConfigTypeDef

WorkflowDetailsOutputTypeDef#

# WorkflowDetailsOutputTypeDef definition

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

WorkflowDetailsTypeDef#

# WorkflowDetailsTypeDef definition

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

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

DescribeAccessResponseTypeDef#

# DescribeAccessResponseTypeDef definition

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

DescribeConnectorResponseTypeDef#

# DescribeConnectorResponseTypeDef definition

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

DescribedWebAppTypeDef#

# DescribedWebAppTypeDef definition

class DescribedWebAppTypeDef(TypedDict):
    Arn: str,
    WebAppId: str,
    DescribedIdentityProviderDetails: NotRequired[DescribedWebAppIdentityProviderDetailsTypeDef],  # (1)
    AccessEndpoint: NotRequired[str],
    WebAppEndpoint: NotRequired[str],
    WebAppUnits: NotRequired[WebAppUnitsTypeDef],  # (2)
    Tags: NotRequired[list[TagTypeDef]],  # (3)
  1. See DescribedWebAppIdentityProviderDetailsTypeDef
  2. See WebAppUnitsTypeDef
  3. See TagTypeDef

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

CreateWebAppRequestRequestTypeDef#

# CreateWebAppRequestRequestTypeDef definition

class CreateWebAppRequestRequestTypeDef(TypedDict):
    IdentityProviderDetails: WebAppIdentityProviderDetailsTypeDef,  # (1)
    AccessEndpoint: NotRequired[str],
    WebAppUnits: NotRequired[WebAppUnitsTypeDef],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See WebAppIdentityProviderDetailsTypeDef
  2. See WebAppUnitsTypeDef
  3. See TagTypeDef

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

UpdateWebAppRequestRequestTypeDef#

# UpdateWebAppRequestRequestTypeDef definition

class UpdateWebAppRequestRequestTypeDef(TypedDict):
    WebAppId: str,
    IdentityProviderDetails: NotRequired[UpdateWebAppIdentityProviderDetailsTypeDef],  # (1)
    AccessEndpoint: NotRequired[str],
    WebAppUnits: NotRequired[WebAppUnitsTypeDef],  # (2)
  1. See UpdateWebAppIdentityProviderDetailsTypeDef
  2. See WebAppUnitsTypeDef

DescribedServerTypeDef#

# DescribedServerTypeDef definition

class DescribedServerTypeDef(TypedDict):
    Arn: str,
    Certificate: NotRequired[str],
    ProtocolDetails: NotRequired[ProtocolDetailsOutputTypeDef],  # (1)
    Domain: NotRequired[DomainType],  # (2)
    EndpointDetails: NotRequired[EndpointDetailsOutputTypeDef],  # (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[WorkflowDetailsOutputTypeDef],  # (10)
    StructuredLogDestinations: NotRequired[list[str]],
    S3StorageOptions: NotRequired[S3StorageOptionsTypeDef],  # (11)
    As2ServiceManagedEgressIpAddresses: NotRequired[list[str]],
  1. See ProtocolDetailsOutputTypeDef
  2. See DomainType
  3. See EndpointDetailsOutputTypeDef
  4. See EndpointTypeType
  5. See IdentityProviderDetailsTypeDef
  6. See IdentityProviderTypeType
  7. See ProtocolType
  8. See StateType
  9. See TagTypeDef
  10. See WorkflowDetailsOutputTypeDef
  11. See S3StorageOptionsTypeDef

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

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

DescribeWebAppResponseTypeDef#

# DescribeWebAppResponseTypeDef definition

class DescribeWebAppResponseTypeDef(TypedDict):
    WebApp: DescribedWebAppTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribedWebAppTypeDef
  2. See ResponseMetadataTypeDef

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[PosixProfileOutputTypeDef],  # (4)
    Status: NotRequired[ExecutionStatusType],  # (5)
    Results: NotRequired[ExecutionResultsTypeDef],  # (6)
  1. See FileLocationTypeDef
  2. See ServiceMetadataTypeDef
  3. See LoggingConfigurationTypeDef
  4. See PosixProfileOutputTypeDef
  5. See ExecutionStatusType
  6. See ExecutionResultsTypeDef

WorkflowStepOutputTypeDef#

# WorkflowStepOutputTypeDef definition

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

WorkflowStepTypeDef#

# WorkflowStepTypeDef definition

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

ListExecutionsResponseTypeDef#

# ListExecutionsResponseTypeDef definition

class ListExecutionsResponseTypeDef(TypedDict):
    WorkflowId: str,
    Executions: list[ListedExecutionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  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

DescribedWorkflowTypeDef#

# DescribedWorkflowTypeDef definition

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

DescribeWorkflowResponseTypeDef#

# DescribeWorkflowResponseTypeDef definition

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

CreateWorkflowRequestRequestTypeDef#

# CreateWorkflowRequestRequestTypeDef definition

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