Type definitions

Index > Transfer > Type definitions

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

BlobTypeDef

# BlobTypeDef Union usage example

from mypy_boto3_transfer.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

TimestampTypeDef

# TimestampTypeDef Union usage example

from mypy_boto3_transfer.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

EndpointDetailsUnionTypeDef

# EndpointDetailsUnionTypeDef Union usage example

from mypy_boto3_transfer.type_defs import EndpointDetailsUnionTypeDef


def get_value() -> EndpointDetailsUnionTypeDef:
    return ...


# EndpointDetailsUnionTypeDef definition

EndpointDetailsUnionTypeDef = Union[
    EndpointDetailsTypeDef,  # (1)
    EndpointDetailsOutputTypeDef,  # (2)
]

1. See EndpointDetailsTypeDef
2. See EndpointDetailsOutputTypeDef

PosixProfileUnionTypeDef

# PosixProfileUnionTypeDef Union usage example

from mypy_boto3_transfer.type_defs import PosixProfileUnionTypeDef


def get_value() -> PosixProfileUnionTypeDef:
    return ...


# PosixProfileUnionTypeDef definition

PosixProfileUnionTypeDef = Union[
    PosixProfileTypeDef,  # (1)
    PosixProfileOutputTypeDef,  # (2)
]

1. See PosixProfileTypeDef
2. See PosixProfileOutputTypeDef

ProtocolDetailsUnionTypeDef

# ProtocolDetailsUnionTypeDef Union usage example

from mypy_boto3_transfer.type_defs import ProtocolDetailsUnionTypeDef


def get_value() -> ProtocolDetailsUnionTypeDef:
    return ...


# ProtocolDetailsUnionTypeDef definition

ProtocolDetailsUnionTypeDef = Union[
    ProtocolDetailsTypeDef,  # (1)
    ProtocolDetailsOutputTypeDef,  # (2)
]

1. See ProtocolDetailsTypeDef
2. See ProtocolDetailsOutputTypeDef

SftpConnectorConfigUnionTypeDef

# SftpConnectorConfigUnionTypeDef Union usage example

from mypy_boto3_transfer.type_defs import SftpConnectorConfigUnionTypeDef


def get_value() -> SftpConnectorConfigUnionTypeDef:
    return ...


# SftpConnectorConfigUnionTypeDef definition

SftpConnectorConfigUnionTypeDef = Union[
    SftpConnectorConfigTypeDef,  # (1)
    SftpConnectorConfigOutputTypeDef,  # (2)
]

1. See SftpConnectorConfigTypeDef
2. See SftpConnectorConfigOutputTypeDef

TagStepDetailsUnionTypeDef

# TagStepDetailsUnionTypeDef Union usage example

from mypy_boto3_transfer.type_defs import TagStepDetailsUnionTypeDef


def get_value() -> TagStepDetailsUnionTypeDef:
    return ...


# TagStepDetailsUnionTypeDef definition

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

1. See TagStepDetailsTypeDef
2. See TagStepDetailsOutputTypeDef

WorkflowDetailsUnionTypeDef

# WorkflowDetailsUnionTypeDef Union usage example

from mypy_boto3_transfer.type_defs import WorkflowDetailsUnionTypeDef


def get_value() -> WorkflowDetailsUnionTypeDef:
    return ...


# WorkflowDetailsUnionTypeDef definition

WorkflowDetailsUnionTypeDef = Union[
    WorkflowDetailsTypeDef,  # (1)
    WorkflowDetailsOutputTypeDef,  # (2)
]

1. See WorkflowDetailsTypeDef
2. See WorkflowDetailsOutputTypeDef

WorkflowStepUnionTypeDef

# WorkflowStepUnionTypeDef Union usage example

from mypy_boto3_transfer.type_defs import WorkflowStepUnionTypeDef


def get_value() -> WorkflowStepUnionTypeDef:
    return ...


# WorkflowStepUnionTypeDef definition

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

1. See WorkflowStepTypeDef
2. See WorkflowStepOutputTypeDef

As2ConnectorConfigTypeDef

# As2ConnectorConfigTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import As2ConnectorConfigTypeDef


def get_value() -> As2ConnectorConfigTypeDef:
    return {
        "LocalProfileId": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_transfer.type_defs import ConnectorFileTransferResultTypeDef


def get_value() -> ConnectorFileTransferResultTypeDef:
    return {
        "FilePath": ...,
    }


# ConnectorFileTransferResultTypeDef definition

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

1. See TransferTableStatusType

HomeDirectoryMapEntryTypeDef

# HomeDirectoryMapEntryTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import HomeDirectoryMapEntryTypeDef


def get_value() -> HomeDirectoryMapEntryTypeDef:
    return {
        "Entry": ...,
    }


# HomeDirectoryMapEntryTypeDef definition

class HomeDirectoryMapEntryTypeDef(TypedDict):
    Entry: str,
    Target: str,
    Type: NotRequired[MapTypeType],  # (1)

1. See MapTypeType

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CustomDirectoriesTypeTypeDef

# CustomDirectoriesTypeTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CustomDirectoriesTypeTypeDef


def get_value() -> CustomDirectoriesTypeTypeDef:
    return {
        "FailedFilesDirectory": ...,
    }


# CustomDirectoriesTypeTypeDef definition

class CustomDirectoriesTypeTypeDef(TypedDict):
    FailedFilesDirectory: str,
    MdnFilesDirectory: str,
    PayloadFilesDirectory: str,
    StatusFilesDirectory: str,
    TemporaryFilesDirectory: str,

TagTypeDef

# TagTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }


# TagTypeDef definition

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

IdentityProviderDetailsTypeDef

# IdentityProviderDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import IdentityProviderDetailsTypeDef


def get_value() -> IdentityProviderDetailsTypeDef:
    return {
        "Url": ...,
    }


# IdentityProviderDetailsTypeDef definition

class IdentityProviderDetailsTypeDef(TypedDict):
    Url: NotRequired[str],
    InvocationRole: NotRequired[str],
    DirectoryId: NotRequired[str],
    Function: NotRequired[str],
    SftpAuthenticationMethods: NotRequired[SftpAuthenticationMethodsType],  # (1)

1. See SftpAuthenticationMethodsType

S3StorageOptionsTypeDef

# S3StorageOptionsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import S3StorageOptionsTypeDef


def get_value() -> S3StorageOptionsTypeDef:
    return {
        "DirectoryListingOptimization": ...,
    }


# S3StorageOptionsTypeDef definition

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

1. See DirectoryListingOptimizationType

WebAppUnitsTypeDef

# WebAppUnitsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import WebAppUnitsTypeDef


def get_value() -> WebAppUnitsTypeDef:
    return {
        "Provisioned": ...,
    }


# WebAppUnitsTypeDef definition

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

CustomStepDetailsTypeDef

# CustomStepDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CustomStepDetailsTypeDef


def get_value() -> CustomStepDetailsTypeDef:
    return {
        "Name": ...,
    }


# CustomStepDetailsTypeDef definition

class CustomStepDetailsTypeDef(TypedDict):
    Name: NotRequired[str],
    Target: NotRequired[str],
    TimeoutSeconds: NotRequired[int],
    SourceFileLocation: NotRequired[str],

DeleteAccessRequestTypeDef

# DeleteAccessRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteAccessRequestTypeDef


def get_value() -> DeleteAccessRequestTypeDef:
    return {
        "ServerId": ...,
    }


# DeleteAccessRequestTypeDef definition

class DeleteAccessRequestTypeDef(TypedDict):
    ServerId: str,
    ExternalId: str,

DeleteAgreementRequestTypeDef

# DeleteAgreementRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteAgreementRequestTypeDef


def get_value() -> DeleteAgreementRequestTypeDef:
    return {
        "AgreementId": ...,
    }


# DeleteAgreementRequestTypeDef definition

class DeleteAgreementRequestTypeDef(TypedDict):
    AgreementId: str,
    ServerId: str,

DeleteCertificateRequestTypeDef

# DeleteCertificateRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteCertificateRequestTypeDef


def get_value() -> DeleteCertificateRequestTypeDef:
    return {
        "CertificateId": ...,
    }


# DeleteCertificateRequestTypeDef definition

class DeleteCertificateRequestTypeDef(TypedDict):
    CertificateId: str,

DeleteConnectorRequestTypeDef

# DeleteConnectorRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteConnectorRequestTypeDef


def get_value() -> DeleteConnectorRequestTypeDef:
    return {
        "ConnectorId": ...,
    }


# DeleteConnectorRequestTypeDef definition

class DeleteConnectorRequestTypeDef(TypedDict):
    ConnectorId: str,

DeleteHostKeyRequestTypeDef

# DeleteHostKeyRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteHostKeyRequestTypeDef


def get_value() -> DeleteHostKeyRequestTypeDef:
    return {
        "ServerId": ...,
    }


# DeleteHostKeyRequestTypeDef definition

class DeleteHostKeyRequestTypeDef(TypedDict):
    ServerId: str,
    HostKeyId: str,

DeleteProfileRequestTypeDef

# DeleteProfileRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteProfileRequestTypeDef


def get_value() -> DeleteProfileRequestTypeDef:
    return {
        "ProfileId": ...,
    }


# DeleteProfileRequestTypeDef definition

class DeleteProfileRequestTypeDef(TypedDict):
    ProfileId: str,

DeleteServerRequestTypeDef

# DeleteServerRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteServerRequestTypeDef


def get_value() -> DeleteServerRequestTypeDef:
    return {
        "ServerId": ...,
    }


# DeleteServerRequestTypeDef definition

class DeleteServerRequestTypeDef(TypedDict):
    ServerId: str,

DeleteSshPublicKeyRequestTypeDef

# DeleteSshPublicKeyRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteSshPublicKeyRequestTypeDef


def get_value() -> DeleteSshPublicKeyRequestTypeDef:
    return {
        "ServerId": ...,
    }


# DeleteSshPublicKeyRequestTypeDef definition

class DeleteSshPublicKeyRequestTypeDef(TypedDict):
    ServerId: str,
    SshPublicKeyId: str,
    UserName: str,

DeleteStepDetailsTypeDef

# DeleteStepDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteStepDetailsTypeDef


def get_value() -> DeleteStepDetailsTypeDef:
    return {
        "Name": ...,
    }


# DeleteStepDetailsTypeDef definition

class DeleteStepDetailsTypeDef(TypedDict):
    Name: NotRequired[str],
    SourceFileLocation: NotRequired[str],

DeleteUserRequestTypeDef

# DeleteUserRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteUserRequestTypeDef


def get_value() -> DeleteUserRequestTypeDef:
    return {
        "ServerId": ...,
    }


# DeleteUserRequestTypeDef definition

class DeleteUserRequestTypeDef(TypedDict):
    ServerId: str,
    UserName: str,

DeleteWebAppCustomizationRequestTypeDef

# DeleteWebAppCustomizationRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteWebAppCustomizationRequestTypeDef


def get_value() -> DeleteWebAppCustomizationRequestTypeDef:
    return {
        "WebAppId": ...,
    }


# DeleteWebAppCustomizationRequestTypeDef definition

class DeleteWebAppCustomizationRequestTypeDef(TypedDict):
    WebAppId: str,

DeleteWebAppRequestTypeDef

# DeleteWebAppRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteWebAppRequestTypeDef


def get_value() -> DeleteWebAppRequestTypeDef:
    return {
        "WebAppId": ...,
    }


# DeleteWebAppRequestTypeDef definition

class DeleteWebAppRequestTypeDef(TypedDict):
    WebAppId: str,

DeleteWorkflowRequestTypeDef

# DeleteWorkflowRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DeleteWorkflowRequestTypeDef


def get_value() -> DeleteWorkflowRequestTypeDef:
    return {
        "WorkflowId": ...,
    }


# DeleteWorkflowRequestTypeDef definition

class DeleteWorkflowRequestTypeDef(TypedDict):
    WorkflowId: str,

DescribeAccessRequestTypeDef

# DescribeAccessRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeAccessRequestTypeDef


def get_value() -> DescribeAccessRequestTypeDef:
    return {
        "ServerId": ...,
    }


# DescribeAccessRequestTypeDef definition

class DescribeAccessRequestTypeDef(TypedDict):
    ServerId: str,
    ExternalId: str,

DescribeAgreementRequestTypeDef

# DescribeAgreementRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeAgreementRequestTypeDef


def get_value() -> DescribeAgreementRequestTypeDef:
    return {
        "AgreementId": ...,
    }


# DescribeAgreementRequestTypeDef definition

class DescribeAgreementRequestTypeDef(TypedDict):
    AgreementId: str,
    ServerId: str,

DescribeCertificateRequestTypeDef

# DescribeCertificateRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeCertificateRequestTypeDef


def get_value() -> DescribeCertificateRequestTypeDef:
    return {
        "CertificateId": ...,
    }


# DescribeCertificateRequestTypeDef definition

class DescribeCertificateRequestTypeDef(TypedDict):
    CertificateId: str,

DescribeConnectorRequestTypeDef

# DescribeConnectorRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeConnectorRequestTypeDef


def get_value() -> DescribeConnectorRequestTypeDef:
    return {
        "ConnectorId": ...,
    }


# DescribeConnectorRequestTypeDef definition

class DescribeConnectorRequestTypeDef(TypedDict):
    ConnectorId: str,

DescribeExecutionRequestTypeDef

# DescribeExecutionRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeExecutionRequestTypeDef


def get_value() -> DescribeExecutionRequestTypeDef:
    return {
        "ExecutionId": ...,
    }


# DescribeExecutionRequestTypeDef definition

class DescribeExecutionRequestTypeDef(TypedDict):
    ExecutionId: str,
    WorkflowId: str,

DescribeHostKeyRequestTypeDef

# DescribeHostKeyRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeHostKeyRequestTypeDef


def get_value() -> DescribeHostKeyRequestTypeDef:
    return {
        "ServerId": ...,
    }


# DescribeHostKeyRequestTypeDef definition

class DescribeHostKeyRequestTypeDef(TypedDict):
    ServerId: str,
    HostKeyId: str,

DescribeProfileRequestTypeDef

# DescribeProfileRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeProfileRequestTypeDef


def get_value() -> DescribeProfileRequestTypeDef:
    return {
        "ProfileId": ...,
    }


# DescribeProfileRequestTypeDef definition

class DescribeProfileRequestTypeDef(TypedDict):
    ProfileId: str,

DescribeSecurityPolicyRequestTypeDef

# DescribeSecurityPolicyRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeSecurityPolicyRequestTypeDef


def get_value() -> DescribeSecurityPolicyRequestTypeDef:
    return {
        "SecurityPolicyName": ...,
    }


# DescribeSecurityPolicyRequestTypeDef definition

class DescribeSecurityPolicyRequestTypeDef(TypedDict):
    SecurityPolicyName: str,

DescribedSecurityPolicyTypeDef

# DescribedSecurityPolicyTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedSecurityPolicyTypeDef


def get_value() -> DescribedSecurityPolicyTypeDef:
    return {
        "Fips": ...,
    }


# 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 List[SecurityPolicyProtocolType]

DescribeServerRequestTypeDef

# DescribeServerRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeServerRequestTypeDef


def get_value() -> DescribeServerRequestTypeDef:
    return {
        "ServerId": ...,
    }


# DescribeServerRequestTypeDef definition

class DescribeServerRequestTypeDef(TypedDict):
    ServerId: str,

WaiterConfigTypeDef

# WaiterConfigTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import WaiterConfigTypeDef


def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }


# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeUserRequestTypeDef

# DescribeUserRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeUserRequestTypeDef


def get_value() -> DescribeUserRequestTypeDef:
    return {
        "ServerId": ...,
    }


# DescribeUserRequestTypeDef definition

class DescribeUserRequestTypeDef(TypedDict):
    ServerId: str,
    UserName: str,

DescribeWebAppCustomizationRequestTypeDef

# DescribeWebAppCustomizationRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeWebAppCustomizationRequestTypeDef


def get_value() -> DescribeWebAppCustomizationRequestTypeDef:
    return {
        "WebAppId": ...,
    }


# DescribeWebAppCustomizationRequestTypeDef definition

class DescribeWebAppCustomizationRequestTypeDef(TypedDict):
    WebAppId: str,

DescribedWebAppCustomizationTypeDef

# DescribedWebAppCustomizationTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedWebAppCustomizationTypeDef


def get_value() -> DescribedWebAppCustomizationTypeDef:
    return {
        "Arn": ...,
    }


# DescribedWebAppCustomizationTypeDef definition

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

DescribeWebAppRequestTypeDef

# DescribeWebAppRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeWebAppRequestTypeDef


def get_value() -> DescribeWebAppRequestTypeDef:
    return {
        "WebAppId": ...,
    }


# DescribeWebAppRequestTypeDef definition

class DescribeWebAppRequestTypeDef(TypedDict):
    WebAppId: str,

DescribeWorkflowRequestTypeDef

# DescribeWorkflowRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeWorkflowRequestTypeDef


def get_value() -> DescribeWorkflowRequestTypeDef:
    return {
        "WorkflowId": ...,
    }


# DescribeWorkflowRequestTypeDef definition

class DescribeWorkflowRequestTypeDef(TypedDict):
    WorkflowId: str,

PosixProfileOutputTypeDef

# PosixProfileOutputTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import PosixProfileOutputTypeDef


def get_value() -> PosixProfileOutputTypeDef:
    return {
        "Uid": ...,
    }


# PosixProfileOutputTypeDef definition

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

SftpConnectorConfigOutputTypeDef

# SftpConnectorConfigOutputTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import SftpConnectorConfigOutputTypeDef


def get_value() -> SftpConnectorConfigOutputTypeDef:
    return {
        "UserSecretId": ...,
    }


# SftpConnectorConfigOutputTypeDef definition

class SftpConnectorConfigOutputTypeDef(TypedDict):
    UserSecretId: NotRequired[str],
    TrustedHostKeys: NotRequired[List[str]],
    MaxConcurrentConnections: NotRequired[int],

LoggingConfigurationTypeDef

# LoggingConfigurationTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import LoggingConfigurationTypeDef


def get_value() -> LoggingConfigurationTypeDef:
    return {
        "LoggingRole": ...,
    }


# LoggingConfigurationTypeDef definition

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

DescribedIdentityCenterConfigTypeDef

# DescribedIdentityCenterConfigTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedIdentityCenterConfigTypeDef


def get_value() -> DescribedIdentityCenterConfigTypeDef:
    return {
        "ApplicationArn": ...,
    }


# DescribedIdentityCenterConfigTypeDef definition

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

EndpointDetailsOutputTypeDef

# EndpointDetailsOutputTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import EndpointDetailsOutputTypeDef


def get_value() -> EndpointDetailsOutputTypeDef:
    return {
        "AddressAllocationIds": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_transfer.type_defs import ProtocolDetailsOutputTypeDef


def get_value() -> ProtocolDetailsOutputTypeDef:
    return {
        "PassiveIp": ...,
    }


# 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 List[Literal['HTTP']]

SshPublicKeyTypeDef

# SshPublicKeyTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import SshPublicKeyTypeDef


def get_value() -> SshPublicKeyTypeDef:
    return {
        "DateImported": ...,
    }


# SshPublicKeyTypeDef definition

class SshPublicKeyTypeDef(TypedDict):
    DateImported: datetime.datetime,
    SshPublicKeyBody: str,
    SshPublicKeyId: str,

EfsFileLocationTypeDef

# EfsFileLocationTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import EfsFileLocationTypeDef


def get_value() -> EfsFileLocationTypeDef:
    return {
        "FileSystemId": ...,
    }


# EfsFileLocationTypeDef definition

class EfsFileLocationTypeDef(TypedDict):
    FileSystemId: NotRequired[str],
    Path: NotRequired[str],

EndpointDetailsTypeDef

# EndpointDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import EndpointDetailsTypeDef


def get_value() -> EndpointDetailsTypeDef:
    return {
        "AddressAllocationIds": ...,
    }


# EndpointDetailsTypeDef definition

class EndpointDetailsTypeDef(TypedDict):
    AddressAllocationIds: NotRequired[Sequence[str]],
    SubnetIds: NotRequired[Sequence[str]],
    VpcEndpointId: NotRequired[str],
    VpcId: NotRequired[str],
    SecurityGroupIds: NotRequired[Sequence[str]],

ExecutionErrorTypeDef

# ExecutionErrorTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ExecutionErrorTypeDef


def get_value() -> ExecutionErrorTypeDef:
    return {
        "Type": ...,
    }


# ExecutionErrorTypeDef definition

class ExecutionErrorTypeDef(TypedDict):
    Type: ExecutionErrorTypeType,  # (1)
    Message: str,

1. See ExecutionErrorTypeType

S3FileLocationTypeDef

# S3FileLocationTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import S3FileLocationTypeDef


def get_value() -> S3FileLocationTypeDef:
    return {
        "Bucket": ...,
    }


# S3FileLocationTypeDef definition

class S3FileLocationTypeDef(TypedDict):
    Bucket: NotRequired[str],
    Key: NotRequired[str],
    VersionId: NotRequired[str],
    Etag: NotRequired[str],

IdentityCenterConfigTypeDef

# IdentityCenterConfigTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import IdentityCenterConfigTypeDef


def get_value() -> IdentityCenterConfigTypeDef:
    return {
        "InstanceArn": ...,
    }


# IdentityCenterConfigTypeDef definition

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

ImportSshPublicKeyRequestTypeDef

# ImportSshPublicKeyRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ImportSshPublicKeyRequestTypeDef


def get_value() -> ImportSshPublicKeyRequestTypeDef:
    return {
        "ServerId": ...,
    }


# ImportSshPublicKeyRequestTypeDef definition

class ImportSshPublicKeyRequestTypeDef(TypedDict):
    ServerId: str,
    SshPublicKeyBody: str,
    UserName: str,

S3InputFileLocationTypeDef

# S3InputFileLocationTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import S3InputFileLocationTypeDef


def get_value() -> S3InputFileLocationTypeDef:
    return {
        "Bucket": ...,
    }


# S3InputFileLocationTypeDef definition

class S3InputFileLocationTypeDef(TypedDict):
    Bucket: NotRequired[str],
    Key: NotRequired[str],

PaginatorConfigTypeDef

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAccessesRequestTypeDef

# ListAccessesRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListAccessesRequestTypeDef


def get_value() -> ListAccessesRequestTypeDef:
    return {
        "ServerId": ...,
    }


# ListAccessesRequestTypeDef definition

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

ListedAccessTypeDef

# ListedAccessTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedAccessTypeDef


def get_value() -> ListedAccessTypeDef:
    return {
        "HomeDirectory": ...,
    }


# ListedAccessTypeDef definition

class ListedAccessTypeDef(TypedDict):
    HomeDirectory: NotRequired[str],
    HomeDirectoryType: NotRequired[HomeDirectoryTypeType],  # (1)
    Role: NotRequired[str],
    ExternalId: NotRequired[str],

1. See HomeDirectoryTypeType

ListAgreementsRequestTypeDef

# ListAgreementsRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListAgreementsRequestTypeDef


def get_value() -> ListAgreementsRequestTypeDef:
    return {
        "ServerId": ...,
    }


# ListAgreementsRequestTypeDef definition

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

ListedAgreementTypeDef

# ListedAgreementTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedAgreementTypeDef


def get_value() -> ListedAgreementTypeDef:
    return {
        "Arn": ...,
    }


# 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

ListCertificatesRequestTypeDef

# ListCertificatesRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListCertificatesRequestTypeDef


def get_value() -> ListCertificatesRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListCertificatesRequestTypeDef definition

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

ListedCertificateTypeDef

# ListedCertificateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedCertificateTypeDef


def get_value() -> ListedCertificateTypeDef:
    return {
        "Arn": ...,
    }


# ListedCertificateTypeDef definition

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

1. See CertificateUsageTypeType
2. See CertificateStatusTypeType
3. See CertificateTypeType

ListConnectorsRequestTypeDef

# ListConnectorsRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListConnectorsRequestTypeDef


def get_value() -> ListConnectorsRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListConnectorsRequestTypeDef definition

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

ListedConnectorTypeDef

# ListedConnectorTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedConnectorTypeDef


def get_value() -> ListedConnectorTypeDef:
    return {
        "Arn": ...,
    }


# ListedConnectorTypeDef definition

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

ListExecutionsRequestTypeDef

# ListExecutionsRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListExecutionsRequestTypeDef


def get_value() -> ListExecutionsRequestTypeDef:
    return {
        "WorkflowId": ...,
    }


# ListExecutionsRequestTypeDef definition

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

ListFileTransferResultsRequestTypeDef

# ListFileTransferResultsRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListFileTransferResultsRequestTypeDef


def get_value() -> ListFileTransferResultsRequestTypeDef:
    return {
        "ConnectorId": ...,
    }


# ListFileTransferResultsRequestTypeDef definition

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

ListHostKeysRequestTypeDef

# ListHostKeysRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListHostKeysRequestTypeDef


def get_value() -> ListHostKeysRequestTypeDef:
    return {
        "ServerId": ...,
    }


# ListHostKeysRequestTypeDef definition

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

ListedHostKeyTypeDef

# ListedHostKeyTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedHostKeyTypeDef


def get_value() -> ListedHostKeyTypeDef:
    return {
        "Arn": ...,
    }


# ListedHostKeyTypeDef definition

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

ListProfilesRequestTypeDef

# ListProfilesRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListProfilesRequestTypeDef


def get_value() -> ListProfilesRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListProfilesRequestTypeDef definition

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

1. See ProfileTypeType

ListedProfileTypeDef

# ListedProfileTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedProfileTypeDef


def get_value() -> ListedProfileTypeDef:
    return {
        "Arn": ...,
    }


# ListedProfileTypeDef definition

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

1. See ProfileTypeType

ListSecurityPoliciesRequestTypeDef

# ListSecurityPoliciesRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListSecurityPoliciesRequestTypeDef


def get_value() -> ListSecurityPoliciesRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListSecurityPoliciesRequestTypeDef definition

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

ListServersRequestTypeDef

# ListServersRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListServersRequestTypeDef


def get_value() -> ListServersRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListServersRequestTypeDef definition

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

ListedServerTypeDef

# ListedServerTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedServerTypeDef


def get_value() -> ListedServerTypeDef:
    return {
        "Arn": ...,
    }


# 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

ListTagsForResourceRequestTypeDef

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "Arn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

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

ListUsersRequestTypeDef

# ListUsersRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListUsersRequestTypeDef


def get_value() -> ListUsersRequestTypeDef:
    return {
        "ServerId": ...,
    }


# ListUsersRequestTypeDef definition

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

ListedUserTypeDef

# ListedUserTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedUserTypeDef


def get_value() -> ListedUserTypeDef:
    return {
        "Arn": ...,
    }


# 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

ListWebAppsRequestTypeDef

# ListWebAppsRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListWebAppsRequestTypeDef


def get_value() -> ListWebAppsRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListWebAppsRequestTypeDef definition

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

ListedWebAppTypeDef

# ListedWebAppTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedWebAppTypeDef


def get_value() -> ListedWebAppTypeDef:
    return {
        "Arn": ...,
    }


# ListedWebAppTypeDef definition

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

ListWorkflowsRequestTypeDef

# ListWorkflowsRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListWorkflowsRequestTypeDef


def get_value() -> ListWorkflowsRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListWorkflowsRequestTypeDef definition

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

ListedWorkflowTypeDef

# ListedWorkflowTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedWorkflowTypeDef


def get_value() -> ListedWorkflowTypeDef:
    return {
        "WorkflowId": ...,
    }


# ListedWorkflowTypeDef definition

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

PosixProfileTypeDef

# PosixProfileTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import PosixProfileTypeDef


def get_value() -> PosixProfileTypeDef:
    return {
        "Uid": ...,
    }


# PosixProfileTypeDef definition

class PosixProfileTypeDef(TypedDict):
    Uid: int,
    Gid: int,
    SecondaryGids: NotRequired[Sequence[int]],

ProtocolDetailsTypeDef

# ProtocolDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ProtocolDetailsTypeDef


def get_value() -> ProtocolDetailsTypeDef:
    return {
        "PassiveIp": ...,
    }


# 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 Sequence[Literal['HTTP']]

S3TagTypeDef

# S3TagTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import S3TagTypeDef


def get_value() -> S3TagTypeDef:
    return {
        "Key": ...,
    }


# S3TagTypeDef definition

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

SendWorkflowStepStateRequestTypeDef

# SendWorkflowStepStateRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import SendWorkflowStepStateRequestTypeDef


def get_value() -> SendWorkflowStepStateRequestTypeDef:
    return {
        "WorkflowId": ...,
    }


# SendWorkflowStepStateRequestTypeDef definition

class SendWorkflowStepStateRequestTypeDef(TypedDict):
    WorkflowId: str,
    ExecutionId: str,
    Token: str,
    Status: CustomStepStatusType,  # (1)

1. See CustomStepStatusType

UserDetailsTypeDef

# UserDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UserDetailsTypeDef


def get_value() -> UserDetailsTypeDef:
    return {
        "UserName": ...,
    }


# UserDetailsTypeDef definition

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

SftpConnectorConfigTypeDef

# SftpConnectorConfigTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import SftpConnectorConfigTypeDef


def get_value() -> SftpConnectorConfigTypeDef:
    return {
        "UserSecretId": ...,
    }


# SftpConnectorConfigTypeDef definition

class SftpConnectorConfigTypeDef(TypedDict):
    UserSecretId: NotRequired[str],
    TrustedHostKeys: NotRequired[Sequence[str]],
    MaxConcurrentConnections: NotRequired[int],

SftpConnectorConnectionDetailsTypeDef

# SftpConnectorConnectionDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import SftpConnectorConnectionDetailsTypeDef


def get_value() -> SftpConnectorConnectionDetailsTypeDef:
    return {
        "HostKey": ...,
    }


# SftpConnectorConnectionDetailsTypeDef definition

class SftpConnectorConnectionDetailsTypeDef(TypedDict):
    HostKey: NotRequired[str],

StartDirectoryListingRequestTypeDef

# StartDirectoryListingRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import StartDirectoryListingRequestTypeDef


def get_value() -> StartDirectoryListingRequestTypeDef:
    return {
        "ConnectorId": ...,
    }


# StartDirectoryListingRequestTypeDef definition

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

StartFileTransferRequestTypeDef

# StartFileTransferRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import StartFileTransferRequestTypeDef


def get_value() -> StartFileTransferRequestTypeDef:
    return {
        "ConnectorId": ...,
    }


# StartFileTransferRequestTypeDef definition

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

StartRemoteDeleteRequestTypeDef

# StartRemoteDeleteRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import StartRemoteDeleteRequestTypeDef


def get_value() -> StartRemoteDeleteRequestTypeDef:
    return {
        "ConnectorId": ...,
    }


# StartRemoteDeleteRequestTypeDef definition

class StartRemoteDeleteRequestTypeDef(TypedDict):
    ConnectorId: str,
    DeletePath: str,

StartRemoteMoveRequestTypeDef

# StartRemoteMoveRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import StartRemoteMoveRequestTypeDef


def get_value() -> StartRemoteMoveRequestTypeDef:
    return {
        "ConnectorId": ...,
    }


# StartRemoteMoveRequestTypeDef definition

class StartRemoteMoveRequestTypeDef(TypedDict):
    ConnectorId: str,
    SourcePath: str,
    TargetPath: str,

StartServerRequestTypeDef

# StartServerRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import StartServerRequestTypeDef


def get_value() -> StartServerRequestTypeDef:
    return {
        "ServerId": ...,
    }


# StartServerRequestTypeDef definition

class StartServerRequestTypeDef(TypedDict):
    ServerId: str,

StopServerRequestTypeDef

# StopServerRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import StopServerRequestTypeDef


def get_value() -> StopServerRequestTypeDef:
    return {
        "ServerId": ...,
    }


# StopServerRequestTypeDef definition

class StopServerRequestTypeDef(TypedDict):
    ServerId: str,

TestConnectionRequestTypeDef

# TestConnectionRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import TestConnectionRequestTypeDef


def get_value() -> TestConnectionRequestTypeDef:
    return {
        "ConnectorId": ...,
    }


# TestConnectionRequestTypeDef definition

class TestConnectionRequestTypeDef(TypedDict):
    ConnectorId: str,

TestIdentityProviderRequestTypeDef

# TestIdentityProviderRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import TestIdentityProviderRequestTypeDef


def get_value() -> TestIdentityProviderRequestTypeDef:
    return {
        "ServerId": ...,
    }


# TestIdentityProviderRequestTypeDef definition

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

1. See ProtocolType

UntagResourceRequestTypeDef

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "Arn": ...,
    }


# UntagResourceRequestTypeDef definition

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

UpdateHostKeyRequestTypeDef

# UpdateHostKeyRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateHostKeyRequestTypeDef


def get_value() -> UpdateHostKeyRequestTypeDef:
    return {
        "ServerId": ...,
    }


# UpdateHostKeyRequestTypeDef definition

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

UpdateProfileRequestTypeDef

# UpdateProfileRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateProfileRequestTypeDef


def get_value() -> UpdateProfileRequestTypeDef:
    return {
        "ProfileId": ...,
    }


# UpdateProfileRequestTypeDef definition

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

UpdateWebAppIdentityCenterConfigTypeDef

# UpdateWebAppIdentityCenterConfigTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateWebAppIdentityCenterConfigTypeDef


def get_value() -> UpdateWebAppIdentityCenterConfigTypeDef:
    return {
        "Role": ...,
    }


# UpdateWebAppIdentityCenterConfigTypeDef definition

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

WorkflowDetailTypeDef

# WorkflowDetailTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import WorkflowDetailTypeDef


def get_value() -> WorkflowDetailTypeDef:
    return {
        "WorkflowId": ...,
    }


# WorkflowDetailTypeDef definition

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

UpdateWebAppCustomizationRequestTypeDef

# UpdateWebAppCustomizationRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateWebAppCustomizationRequestTypeDef


def get_value() -> UpdateWebAppCustomizationRequestTypeDef:
    return {
        "WebAppId": ...,
    }


# UpdateWebAppCustomizationRequestTypeDef definition

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

CreateAccessResponseTypeDef

# CreateAccessResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateAccessResponseTypeDef


def get_value() -> CreateAccessResponseTypeDef:
    return {
        "ServerId": ...,
    }


# CreateAccessResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateAgreementResponseTypeDef

# CreateAgreementResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateAgreementResponseTypeDef


def get_value() -> CreateAgreementResponseTypeDef:
    return {
        "AgreementId": ...,
    }


# CreateAgreementResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateConnectorResponseTypeDef

# CreateConnectorResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateConnectorResponseTypeDef


def get_value() -> CreateConnectorResponseTypeDef:
    return {
        "ConnectorId": ...,
    }


# CreateConnectorResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateProfileResponseTypeDef

# CreateProfileResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateProfileResponseTypeDef


def get_value() -> CreateProfileResponseTypeDef:
    return {
        "ProfileId": ...,
    }


# CreateProfileResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateServerResponseTypeDef

# CreateServerResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateServerResponseTypeDef


def get_value() -> CreateServerResponseTypeDef:
    return {
        "ServerId": ...,
    }


# CreateServerResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateUserResponseTypeDef

# CreateUserResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateUserResponseTypeDef


def get_value() -> CreateUserResponseTypeDef:
    return {
        "ServerId": ...,
    }


# CreateUserResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateWebAppResponseTypeDef

# CreateWebAppResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateWebAppResponseTypeDef


def get_value() -> CreateWebAppResponseTypeDef:
    return {
        "WebAppId": ...,
    }


# CreateWebAppResponseTypeDef definition

class CreateWebAppResponseTypeDef(TypedDict):
    WebAppId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

CreateWorkflowResponseTypeDef

# CreateWorkflowResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateWorkflowResponseTypeDef


def get_value() -> CreateWorkflowResponseTypeDef:
    return {
        "WorkflowId": ...,
    }


# CreateWorkflowResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

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

1. See ResponseMetadataTypeDef

ImportCertificateResponseTypeDef

# ImportCertificateResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ImportCertificateResponseTypeDef


def get_value() -> ImportCertificateResponseTypeDef:
    return {
        "CertificateId": ...,
    }


# ImportCertificateResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ImportHostKeyResponseTypeDef

# ImportHostKeyResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ImportHostKeyResponseTypeDef


def get_value() -> ImportHostKeyResponseTypeDef:
    return {
        "ServerId": ...,
    }


# ImportHostKeyResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ImportSshPublicKeyResponseTypeDef

# ImportSshPublicKeyResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ImportSshPublicKeyResponseTypeDef


def get_value() -> ImportSshPublicKeyResponseTypeDef:
    return {
        "ServerId": ...,
    }


# ImportSshPublicKeyResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

ListFileTransferResultsResponseTypeDef

# ListFileTransferResultsResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListFileTransferResultsResponseTypeDef


def get_value() -> ListFileTransferResultsResponseTypeDef:
    return {
        "FileTransferResults": ...,
    }


# ListFileTransferResultsResponseTypeDef definition

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

1. See List[ConnectorFileTransferResultTypeDef]
2. See ResponseMetadataTypeDef

ListSecurityPoliciesResponseTypeDef

# ListSecurityPoliciesResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListSecurityPoliciesResponseTypeDef


def get_value() -> ListSecurityPoliciesResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListSecurityPoliciesResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

StartDirectoryListingResponseTypeDef

# StartDirectoryListingResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import StartDirectoryListingResponseTypeDef


def get_value() -> StartDirectoryListingResponseTypeDef:
    return {
        "ListingId": ...,
    }


# StartDirectoryListingResponseTypeDef definition

class StartDirectoryListingResponseTypeDef(TypedDict):
    ListingId: str,
    OutputFileName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

StartFileTransferResponseTypeDef

# StartFileTransferResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import StartFileTransferResponseTypeDef


def get_value() -> StartFileTransferResponseTypeDef:
    return {
        "TransferId": ...,
    }


# StartFileTransferResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

StartRemoteDeleteResponseTypeDef

# StartRemoteDeleteResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import StartRemoteDeleteResponseTypeDef


def get_value() -> StartRemoteDeleteResponseTypeDef:
    return {
        "DeleteId": ...,
    }


# StartRemoteDeleteResponseTypeDef definition

class StartRemoteDeleteResponseTypeDef(TypedDict):
    DeleteId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

StartRemoteMoveResponseTypeDef

# StartRemoteMoveResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import StartRemoteMoveResponseTypeDef


def get_value() -> StartRemoteMoveResponseTypeDef:
    return {
        "MoveId": ...,
    }


# StartRemoteMoveResponseTypeDef definition

class StartRemoteMoveResponseTypeDef(TypedDict):
    MoveId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

TestIdentityProviderResponseTypeDef

# TestIdentityProviderResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import TestIdentityProviderResponseTypeDef


def get_value() -> TestIdentityProviderResponseTypeDef:
    return {
        "Response": ...,
    }


# TestIdentityProviderResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateAccessResponseTypeDef

# UpdateAccessResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateAccessResponseTypeDef


def get_value() -> UpdateAccessResponseTypeDef:
    return {
        "ServerId": ...,
    }


# UpdateAccessResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateAgreementResponseTypeDef

# UpdateAgreementResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateAgreementResponseTypeDef


def get_value() -> UpdateAgreementResponseTypeDef:
    return {
        "AgreementId": ...,
    }


# UpdateAgreementResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateCertificateResponseTypeDef

# UpdateCertificateResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateCertificateResponseTypeDef


def get_value() -> UpdateCertificateResponseTypeDef:
    return {
        "CertificateId": ...,
    }


# UpdateCertificateResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateConnectorResponseTypeDef

# UpdateConnectorResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateConnectorResponseTypeDef


def get_value() -> UpdateConnectorResponseTypeDef:
    return {
        "ConnectorId": ...,
    }


# UpdateConnectorResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateHostKeyResponseTypeDef

# UpdateHostKeyResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateHostKeyResponseTypeDef


def get_value() -> UpdateHostKeyResponseTypeDef:
    return {
        "ServerId": ...,
    }


# UpdateHostKeyResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateProfileResponseTypeDef

# UpdateProfileResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateProfileResponseTypeDef


def get_value() -> UpdateProfileResponseTypeDef:
    return {
        "ProfileId": ...,
    }


# UpdateProfileResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateServerResponseTypeDef

# UpdateServerResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateServerResponseTypeDef


def get_value() -> UpdateServerResponseTypeDef:
    return {
        "ServerId": ...,
    }


# UpdateServerResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateUserResponseTypeDef

# UpdateUserResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateUserResponseTypeDef


def get_value() -> UpdateUserResponseTypeDef:
    return {
        "ServerId": ...,
    }


# UpdateUserResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateWebAppCustomizationResponseTypeDef

# UpdateWebAppCustomizationResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateWebAppCustomizationResponseTypeDef


def get_value() -> UpdateWebAppCustomizationResponseTypeDef:
    return {
        "WebAppId": ...,
    }


# UpdateWebAppCustomizationResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateWebAppResponseTypeDef

# UpdateWebAppResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateWebAppResponseTypeDef


def get_value() -> UpdateWebAppResponseTypeDef:
    return {
        "WebAppId": ...,
    }


# UpdateWebAppResponseTypeDef definition

class UpdateWebAppResponseTypeDef(TypedDict):
    WebAppId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

UpdateAgreementRequestTypeDef

# UpdateAgreementRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateAgreementRequestTypeDef


def get_value() -> UpdateAgreementRequestTypeDef:
    return {
        "AgreementId": ...,
    }


# UpdateAgreementRequestTypeDef definition

class UpdateAgreementRequestTypeDef(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)
    CustomDirectories: NotRequired[CustomDirectoriesTypeTypeDef],  # (4)

1. See AgreementStatusTypeType
2. See PreserveFilenameTypeType
3. See EnforceMessageSigningTypeType
4. See CustomDirectoriesTypeTypeDef

CreateAgreementRequestTypeDef

# CreateAgreementRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateAgreementRequestTypeDef


def get_value() -> CreateAgreementRequestTypeDef:
    return {
        "ServerId": ...,
    }


# CreateAgreementRequestTypeDef definition

class CreateAgreementRequestTypeDef(TypedDict):
    ServerId: str,
    LocalProfileId: str,
    PartnerProfileId: str,
    AccessRole: str,
    Description: NotRequired[str],
    BaseDirectory: NotRequired[str],
    Status: NotRequired[AgreementStatusTypeType],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    PreserveFilename: NotRequired[PreserveFilenameTypeType],  # (3)
    EnforceMessageSigning: NotRequired[EnforceMessageSigningTypeType],  # (4)
    CustomDirectories: NotRequired[CustomDirectoriesTypeTypeDef],  # (5)

1. See AgreementStatusTypeType
2. See Sequence[TagTypeDef]
3. See PreserveFilenameTypeType
4. See EnforceMessageSigningTypeType
5. See CustomDirectoriesTypeTypeDef

CreateProfileRequestTypeDef

# CreateProfileRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateProfileRequestTypeDef


def get_value() -> CreateProfileRequestTypeDef:
    return {
        "As2Id": ...,
    }


# CreateProfileRequestTypeDef definition

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

1. See ProfileTypeType
2. See Sequence[TagTypeDef]

DescribedAgreementTypeDef

# DescribedAgreementTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedAgreementTypeDef


def get_value() -> DescribedAgreementTypeDef:
    return {
        "Arn": ...,
    }


# 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)
    CustomDirectories: NotRequired[CustomDirectoriesTypeTypeDef],  # (5)

1. See AgreementStatusTypeType
2. See List[TagTypeDef]
3. See PreserveFilenameTypeType
4. See EnforceMessageSigningTypeType
5. See CustomDirectoriesTypeTypeDef

DescribedCertificateTypeDef

# DescribedCertificateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedCertificateTypeDef


def get_value() -> DescribedCertificateTypeDef:
    return {
        "Arn": ...,
    }


# 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.datetime],
    InactiveDate: NotRequired[datetime.datetime],
    Serial: NotRequired[str],
    NotBeforeDate: NotRequired[datetime.datetime],
    NotAfterDate: NotRequired[datetime.datetime],
    Type: NotRequired[CertificateTypeType],  # (3)
    Description: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (4)

1. See CertificateUsageTypeType
2. See CertificateStatusTypeType
3. See CertificateTypeType
4. See List[TagTypeDef]

DescribedHostKeyTypeDef

# DescribedHostKeyTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedHostKeyTypeDef


def get_value() -> DescribedHostKeyTypeDef:
    return {
        "Arn": ...,
    }


# DescribedHostKeyTypeDef definition

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

1. See List[TagTypeDef]

DescribedProfileTypeDef

# DescribedProfileTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedProfileTypeDef


def get_value() -> DescribedProfileTypeDef:
    return {
        "Arn": ...,
    }


# 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 List[TagTypeDef]

ImportHostKeyRequestTypeDef

# ImportHostKeyRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ImportHostKeyRequestTypeDef


def get_value() -> ImportHostKeyRequestTypeDef:
    return {
        "ServerId": ...,
    }


# ImportHostKeyRequestTypeDef definition

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

1. See Sequence[TagTypeDef]

ListTagsForResourceResponseTypeDef

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Arn": ...,
    }


# ListTagsForResourceResponseTypeDef definition

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

1. See List[TagTypeDef]
2. See ResponseMetadataTypeDef

TagResourceRequestTypeDef

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "Arn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    Arn: str,
    Tags: Sequence[TagTypeDef],  # (1)

1. See Sequence[TagTypeDef]

DescribeSecurityPolicyResponseTypeDef

# DescribeSecurityPolicyResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeSecurityPolicyResponseTypeDef


def get_value() -> DescribeSecurityPolicyResponseTypeDef:
    return {
        "SecurityPolicy": ...,
    }


# DescribeSecurityPolicyResponseTypeDef definition

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

1. See DescribedSecurityPolicyTypeDef
2. See ResponseMetadataTypeDef

DescribeServerRequestWaitExtraTypeDef

# DescribeServerRequestWaitExtraTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeServerRequestWaitExtraTypeDef


def get_value() -> DescribeServerRequestWaitExtraTypeDef:
    return {
        "ServerId": ...,
    }


# DescribeServerRequestWaitExtraTypeDef definition

class DescribeServerRequestWaitExtraTypeDef(TypedDict):
    ServerId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)

1. See WaiterConfigTypeDef

DescribeServerRequestWaitTypeDef

# DescribeServerRequestWaitTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeServerRequestWaitTypeDef


def get_value() -> DescribeServerRequestWaitTypeDef:
    return {
        "ServerId": ...,
    }


# DescribeServerRequestWaitTypeDef definition

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

1. See WaiterConfigTypeDef

DescribeWebAppCustomizationResponseTypeDef

# DescribeWebAppCustomizationResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeWebAppCustomizationResponseTypeDef


def get_value() -> DescribeWebAppCustomizationResponseTypeDef:
    return {
        "WebAppCustomization": ...,
    }


# DescribeWebAppCustomizationResponseTypeDef definition

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

1. See DescribedWebAppCustomizationTypeDef
2. See ResponseMetadataTypeDef

DescribedAccessTypeDef

# DescribedAccessTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedAccessTypeDef


def get_value() -> DescribedAccessTypeDef:
    return {
        "HomeDirectory": ...,
    }


# 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 List[HomeDirectoryMapEntryTypeDef]
2. See HomeDirectoryTypeType
3. See PosixProfileOutputTypeDef

DescribedConnectorTypeDef

# DescribedConnectorTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedConnectorTypeDef


def get_value() -> DescribedConnectorTypeDef:
    return {
        "Arn": ...,
    }


# 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 List[TagTypeDef]
3. See SftpConnectorConfigOutputTypeDef

DescribedWebAppIdentityProviderDetailsTypeDef

# DescribedWebAppIdentityProviderDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedWebAppIdentityProviderDetailsTypeDef


def get_value() -> DescribedWebAppIdentityProviderDetailsTypeDef:
    return {
        "IdentityCenterConfig": ...,
    }


# DescribedWebAppIdentityProviderDetailsTypeDef definition

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

1. See DescribedIdentityCenterConfigTypeDef

DescribedUserTypeDef

# DescribedUserTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedUserTypeDef


def get_value() -> DescribedUserTypeDef:
    return {
        "Arn": ...,
    }


# 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 List[HomeDirectoryMapEntryTypeDef]
2. See HomeDirectoryTypeType
3. See PosixProfileOutputTypeDef
4. See List[SshPublicKeyTypeDef]
5. See List[TagTypeDef]

ExecutionStepResultTypeDef

# ExecutionStepResultTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ExecutionStepResultTypeDef


def get_value() -> ExecutionStepResultTypeDef:
    return {
        "StepType": ...,
    }


# ExecutionStepResultTypeDef definition

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

1. See WorkflowStepTypeType
2. See ExecutionErrorTypeDef

FileLocationTypeDef

# FileLocationTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import FileLocationTypeDef


def get_value() -> FileLocationTypeDef:
    return {
        "S3FileLocation": ...,
    }


# FileLocationTypeDef definition

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

1. See S3FileLocationTypeDef
2. See EfsFileLocationTypeDef

WebAppIdentityProviderDetailsTypeDef

# WebAppIdentityProviderDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import WebAppIdentityProviderDetailsTypeDef


def get_value() -> WebAppIdentityProviderDetailsTypeDef:
    return {
        "IdentityCenterConfig": ...,
    }


# WebAppIdentityProviderDetailsTypeDef definition

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

1. See IdentityCenterConfigTypeDef

ImportCertificateRequestTypeDef

# ImportCertificateRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ImportCertificateRequestTypeDef


def get_value() -> ImportCertificateRequestTypeDef:
    return {
        "Usage": ...,
    }


# ImportCertificateRequestTypeDef definition

class ImportCertificateRequestTypeDef(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 Sequence[TagTypeDef]

UpdateCertificateRequestTypeDef

# UpdateCertificateRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateCertificateRequestTypeDef


def get_value() -> UpdateCertificateRequestTypeDef:
    return {
        "CertificateId": ...,
    }


# UpdateCertificateRequestTypeDef definition

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

InputFileLocationTypeDef

# InputFileLocationTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import InputFileLocationTypeDef


def get_value() -> InputFileLocationTypeDef:
    return {
        "S3FileLocation": ...,
    }


# InputFileLocationTypeDef definition

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

1. See S3InputFileLocationTypeDef
2. See EfsFileLocationTypeDef

ListAccessesRequestPaginateTypeDef

# ListAccessesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListAccessesRequestPaginateTypeDef


def get_value() -> ListAccessesRequestPaginateTypeDef:
    return {
        "ServerId": ...,
    }


# ListAccessesRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListAgreementsRequestPaginateTypeDef

# ListAgreementsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListAgreementsRequestPaginateTypeDef


def get_value() -> ListAgreementsRequestPaginateTypeDef:
    return {
        "ServerId": ...,
    }


# ListAgreementsRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListCertificatesRequestPaginateTypeDef

# ListCertificatesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListCertificatesRequestPaginateTypeDef


def get_value() -> ListCertificatesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListCertificatesRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListConnectorsRequestPaginateTypeDef

# ListConnectorsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListConnectorsRequestPaginateTypeDef


def get_value() -> ListConnectorsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListConnectorsRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListExecutionsRequestPaginateTypeDef

# ListExecutionsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListExecutionsRequestPaginateTypeDef


def get_value() -> ListExecutionsRequestPaginateTypeDef:
    return {
        "WorkflowId": ...,
    }


# ListExecutionsRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListFileTransferResultsRequestPaginateTypeDef

# ListFileTransferResultsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListFileTransferResultsRequestPaginateTypeDef


def get_value() -> ListFileTransferResultsRequestPaginateTypeDef:
    return {
        "ConnectorId": ...,
    }


# ListFileTransferResultsRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListProfilesRequestPaginateTypeDef

# ListProfilesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListProfilesRequestPaginateTypeDef


def get_value() -> ListProfilesRequestPaginateTypeDef:
    return {
        "ProfileType": ...,
    }


# ListProfilesRequestPaginateTypeDef definition

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

1. See ProfileTypeType
2. See PaginatorConfigTypeDef

ListSecurityPoliciesRequestPaginateTypeDef

# ListSecurityPoliciesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListSecurityPoliciesRequestPaginateTypeDef


def get_value() -> ListSecurityPoliciesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListSecurityPoliciesRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListServersRequestPaginateTypeDef

# ListServersRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListServersRequestPaginateTypeDef


def get_value() -> ListServersRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListServersRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListTagsForResourceRequestPaginateTypeDef

# ListTagsForResourceRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListTagsForResourceRequestPaginateTypeDef


def get_value() -> ListTagsForResourceRequestPaginateTypeDef:
    return {
        "Arn": ...,
    }


# ListTagsForResourceRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListUsersRequestPaginateTypeDef

# ListUsersRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListUsersRequestPaginateTypeDef


def get_value() -> ListUsersRequestPaginateTypeDef:
    return {
        "ServerId": ...,
    }


# ListUsersRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListWebAppsRequestPaginateTypeDef

# ListWebAppsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListWebAppsRequestPaginateTypeDef


def get_value() -> ListWebAppsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListWebAppsRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListWorkflowsRequestPaginateTypeDef

# ListWorkflowsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListWorkflowsRequestPaginateTypeDef


def get_value() -> ListWorkflowsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListWorkflowsRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListAccessesResponseTypeDef

# ListAccessesResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListAccessesResponseTypeDef


def get_value() -> ListAccessesResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListAccessesResponseTypeDef definition

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

1. See List[ListedAccessTypeDef]
2. See ResponseMetadataTypeDef

ListAgreementsResponseTypeDef

# ListAgreementsResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListAgreementsResponseTypeDef


def get_value() -> ListAgreementsResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListAgreementsResponseTypeDef definition

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

1. See List[ListedAgreementTypeDef]
2. See ResponseMetadataTypeDef

ListCertificatesResponseTypeDef

# ListCertificatesResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListCertificatesResponseTypeDef


def get_value() -> ListCertificatesResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListCertificatesResponseTypeDef definition

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

1. See List[ListedCertificateTypeDef]
2. See ResponseMetadataTypeDef

ListConnectorsResponseTypeDef

# ListConnectorsResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListConnectorsResponseTypeDef


def get_value() -> ListConnectorsResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListConnectorsResponseTypeDef definition

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

1. See List[ListedConnectorTypeDef]
2. See ResponseMetadataTypeDef

ListHostKeysResponseTypeDef

# ListHostKeysResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListHostKeysResponseTypeDef


def get_value() -> ListHostKeysResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListHostKeysResponseTypeDef definition

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

1. See List[ListedHostKeyTypeDef]
2. See ResponseMetadataTypeDef

ListProfilesResponseTypeDef

# ListProfilesResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListProfilesResponseTypeDef


def get_value() -> ListProfilesResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListProfilesResponseTypeDef definition

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

1. See List[ListedProfileTypeDef]
2. See ResponseMetadataTypeDef

ListServersResponseTypeDef

# ListServersResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListServersResponseTypeDef


def get_value() -> ListServersResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListServersResponseTypeDef definition

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

1. See List[ListedServerTypeDef]
2. See ResponseMetadataTypeDef

ListUsersResponseTypeDef

# ListUsersResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListUsersResponseTypeDef


def get_value() -> ListUsersResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListUsersResponseTypeDef definition

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

1. See List[ListedUserTypeDef]
2. See ResponseMetadataTypeDef

ListWebAppsResponseTypeDef

# ListWebAppsResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListWebAppsResponseTypeDef


def get_value() -> ListWebAppsResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListWebAppsResponseTypeDef definition

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

1. See List[ListedWebAppTypeDef]
2. See ResponseMetadataTypeDef

ListWorkflowsResponseTypeDef

# ListWorkflowsResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListWorkflowsResponseTypeDef


def get_value() -> ListWorkflowsResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListWorkflowsResponseTypeDef definition

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

1. See List[ListedWorkflowTypeDef]
2. See ResponseMetadataTypeDef

TagStepDetailsOutputTypeDef

# TagStepDetailsOutputTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import TagStepDetailsOutputTypeDef


def get_value() -> TagStepDetailsOutputTypeDef:
    return {
        "Name": ...,
    }


# TagStepDetailsOutputTypeDef definition

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

1. See List[S3TagTypeDef]

TagStepDetailsTypeDef

# TagStepDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import TagStepDetailsTypeDef


def get_value() -> TagStepDetailsTypeDef:
    return {
        "Name": ...,
    }


# TagStepDetailsTypeDef definition

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

1. See Sequence[S3TagTypeDef]

ServiceMetadataTypeDef

# ServiceMetadataTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ServiceMetadataTypeDef


def get_value() -> ServiceMetadataTypeDef:
    return {
        "UserDetails": ...,
    }


# ServiceMetadataTypeDef definition

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

1. See UserDetailsTypeDef

TestConnectionResponseTypeDef

# TestConnectionResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import TestConnectionResponseTypeDef


def get_value() -> TestConnectionResponseTypeDef:
    return {
        "ConnectorId": ...,
    }


# TestConnectionResponseTypeDef definition

class TestConnectionResponseTypeDef(TypedDict):
    ConnectorId: str,
    Status: str,
    StatusMessage: str,
    SftpConnectionDetails: SftpConnectorConnectionDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SftpConnectorConnectionDetailsTypeDef
2. See ResponseMetadataTypeDef

UpdateWebAppIdentityProviderDetailsTypeDef

# UpdateWebAppIdentityProviderDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateWebAppIdentityProviderDetailsTypeDef


def get_value() -> UpdateWebAppIdentityProviderDetailsTypeDef:
    return {
        "IdentityCenterConfig": ...,
    }


# UpdateWebAppIdentityProviderDetailsTypeDef definition

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

1. See UpdateWebAppIdentityCenterConfigTypeDef

WorkflowDetailsOutputTypeDef

# WorkflowDetailsOutputTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import WorkflowDetailsOutputTypeDef


def get_value() -> WorkflowDetailsOutputTypeDef:
    return {
        "OnUpload": ...,
    }


# WorkflowDetailsOutputTypeDef definition

class WorkflowDetailsOutputTypeDef(TypedDict):
    OnUpload: NotRequired[List[WorkflowDetailTypeDef]],  # (1)
    OnPartialUpload: NotRequired[List[WorkflowDetailTypeDef]],  # (1)

1. See List[WorkflowDetailTypeDef]
2. See List[WorkflowDetailTypeDef]

WorkflowDetailsTypeDef

# WorkflowDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import WorkflowDetailsTypeDef


def get_value() -> WorkflowDetailsTypeDef:
    return {
        "OnUpload": ...,
    }


# WorkflowDetailsTypeDef definition

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

1. See Sequence[WorkflowDetailTypeDef]
2. See Sequence[WorkflowDetailTypeDef]

DescribeAgreementResponseTypeDef

# DescribeAgreementResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeAgreementResponseTypeDef


def get_value() -> DescribeAgreementResponseTypeDef:
    return {
        "Agreement": ...,
    }


# DescribeAgreementResponseTypeDef definition

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

1. See DescribedAgreementTypeDef
2. See ResponseMetadataTypeDef

DescribeCertificateResponseTypeDef

# DescribeCertificateResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeCertificateResponseTypeDef


def get_value() -> DescribeCertificateResponseTypeDef:
    return {
        "Certificate": ...,
    }


# DescribeCertificateResponseTypeDef definition

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

1. See DescribedCertificateTypeDef
2. See ResponseMetadataTypeDef

DescribeHostKeyResponseTypeDef

# DescribeHostKeyResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeHostKeyResponseTypeDef


def get_value() -> DescribeHostKeyResponseTypeDef:
    return {
        "HostKey": ...,
    }


# DescribeHostKeyResponseTypeDef definition

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

1. See DescribedHostKeyTypeDef
2. See ResponseMetadataTypeDef

DescribeProfileResponseTypeDef

# DescribeProfileResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeProfileResponseTypeDef


def get_value() -> DescribeProfileResponseTypeDef:
    return {
        "Profile": ...,
    }


# DescribeProfileResponseTypeDef definition

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

1. See DescribedProfileTypeDef
2. See ResponseMetadataTypeDef

DescribeAccessResponseTypeDef

# DescribeAccessResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeAccessResponseTypeDef


def get_value() -> DescribeAccessResponseTypeDef:
    return {
        "ServerId": ...,
    }


# DescribeAccessResponseTypeDef definition

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

1. See DescribedAccessTypeDef
2. See ResponseMetadataTypeDef

DescribeConnectorResponseTypeDef

# DescribeConnectorResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeConnectorResponseTypeDef


def get_value() -> DescribeConnectorResponseTypeDef:
    return {
        "Connector": ...,
    }


# DescribeConnectorResponseTypeDef definition

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

1. See DescribedConnectorTypeDef
2. See ResponseMetadataTypeDef

DescribedWebAppTypeDef

# DescribedWebAppTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedWebAppTypeDef


def get_value() -> DescribedWebAppTypeDef:
    return {
        "Arn": ...,
    }


# 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)
    WebAppEndpointPolicy: NotRequired[WebAppEndpointPolicyType],  # (4)

1. See DescribedWebAppIdentityProviderDetailsTypeDef
2. See WebAppUnitsTypeDef
3. See List[TagTypeDef]
4. See WebAppEndpointPolicyType

DescribeUserResponseTypeDef

# DescribeUserResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeUserResponseTypeDef


def get_value() -> DescribeUserResponseTypeDef:
    return {
        "ServerId": ...,
    }


# DescribeUserResponseTypeDef definition

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

1. See DescribedUserTypeDef
2. See ResponseMetadataTypeDef

ExecutionResultsTypeDef

# ExecutionResultsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ExecutionResultsTypeDef


def get_value() -> ExecutionResultsTypeDef:
    return {
        "Steps": ...,
    }


# ExecutionResultsTypeDef definition

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

1. See List[ExecutionStepResultTypeDef]
2. See List[ExecutionStepResultTypeDef]

CreateWebAppRequestTypeDef

# CreateWebAppRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateWebAppRequestTypeDef


def get_value() -> CreateWebAppRequestTypeDef:
    return {
        "IdentityProviderDetails": ...,
    }


# CreateWebAppRequestTypeDef definition

class CreateWebAppRequestTypeDef(TypedDict):
    IdentityProviderDetails: WebAppIdentityProviderDetailsTypeDef,  # (1)
    AccessEndpoint: NotRequired[str],
    WebAppUnits: NotRequired[WebAppUnitsTypeDef],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    WebAppEndpointPolicy: NotRequired[WebAppEndpointPolicyType],  # (4)

1. See WebAppIdentityProviderDetailsTypeDef
2. See WebAppUnitsTypeDef
3. See Sequence[TagTypeDef]
4. See WebAppEndpointPolicyType

CopyStepDetailsTypeDef

# CopyStepDetailsTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CopyStepDetailsTypeDef


def get_value() -> CopyStepDetailsTypeDef:
    return {
        "Name": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_transfer.type_defs import DecryptStepDetailsTypeDef


def get_value() -> DecryptStepDetailsTypeDef:
    return {
        "Name": ...,
    }


# 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

CreateAccessRequestTypeDef

# CreateAccessRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateAccessRequestTypeDef


def get_value() -> CreateAccessRequestTypeDef:
    return {
        "Role": ...,
    }


# CreateAccessRequestTypeDef definition

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

1. See HomeDirectoryTypeType
2. See Sequence[HomeDirectoryMapEntryTypeDef]
3. See PosixProfileUnionTypeDef

CreateUserRequestTypeDef

# CreateUserRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateUserRequestTypeDef


def get_value() -> CreateUserRequestTypeDef:
    return {
        "Role": ...,
    }


# CreateUserRequestTypeDef definition

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

1. See HomeDirectoryTypeType
2. See Sequence[HomeDirectoryMapEntryTypeDef]
3. See PosixProfileUnionTypeDef
4. See Sequence[TagTypeDef]

UpdateAccessRequestTypeDef

# UpdateAccessRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateAccessRequestTypeDef


def get_value() -> UpdateAccessRequestTypeDef:
    return {
        "ServerId": ...,
    }


# UpdateAccessRequestTypeDef definition

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

1. See HomeDirectoryTypeType
2. See Sequence[HomeDirectoryMapEntryTypeDef]
3. See PosixProfileUnionTypeDef

UpdateUserRequestTypeDef

# UpdateUserRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateUserRequestTypeDef


def get_value() -> UpdateUserRequestTypeDef:
    return {
        "ServerId": ...,
    }


# UpdateUserRequestTypeDef definition

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

1. See HomeDirectoryTypeType
2. See Sequence[HomeDirectoryMapEntryTypeDef]
3. See PosixProfileUnionTypeDef

ListedExecutionTypeDef

# ListedExecutionTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListedExecutionTypeDef


def get_value() -> ListedExecutionTypeDef:
    return {
        "ExecutionId": ...,
    }


# 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

CreateConnectorRequestTypeDef

# CreateConnectorRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateConnectorRequestTypeDef


def get_value() -> CreateConnectorRequestTypeDef:
    return {
        "Url": ...,
    }


# CreateConnectorRequestTypeDef definition

class CreateConnectorRequestTypeDef(TypedDict):
    Url: str,
    AccessRole: str,
    As2Config: NotRequired[As2ConnectorConfigTypeDef],  # (1)
    LoggingRole: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    SftpConfig: NotRequired[SftpConnectorConfigUnionTypeDef],  # (3)
    SecurityPolicyName: NotRequired[str],

1. See As2ConnectorConfigTypeDef
2. See Sequence[TagTypeDef]
3. See SftpConnectorConfigUnionTypeDef

UpdateConnectorRequestTypeDef

# UpdateConnectorRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateConnectorRequestTypeDef


def get_value() -> UpdateConnectorRequestTypeDef:
    return {
        "ConnectorId": ...,
    }


# UpdateConnectorRequestTypeDef definition

class UpdateConnectorRequestTypeDef(TypedDict):
    ConnectorId: str,
    Url: NotRequired[str],
    As2Config: NotRequired[As2ConnectorConfigTypeDef],  # (1)
    AccessRole: NotRequired[str],
    LoggingRole: NotRequired[str],
    SftpConfig: NotRequired[SftpConnectorConfigUnionTypeDef],  # (2)
    SecurityPolicyName: NotRequired[str],

1. See As2ConnectorConfigTypeDef
2. See SftpConnectorConfigUnionTypeDef

UpdateWebAppRequestTypeDef

# UpdateWebAppRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateWebAppRequestTypeDef


def get_value() -> UpdateWebAppRequestTypeDef:
    return {
        "WebAppId": ...,
    }


# UpdateWebAppRequestTypeDef definition

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

1. See UpdateWebAppIdentityProviderDetailsTypeDef
2. See WebAppUnitsTypeDef

DescribedServerTypeDef

# DescribedServerTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedServerTypeDef


def get_value() -> DescribedServerTypeDef:
    return {
        "Arn": ...,
    }


# 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 List[ProtocolType]
8. See StateType
9. See List[TagTypeDef]
10. See WorkflowDetailsOutputTypeDef
11. See S3StorageOptionsTypeDef

DescribeWebAppResponseTypeDef

# DescribeWebAppResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeWebAppResponseTypeDef


def get_value() -> DescribeWebAppResponseTypeDef:
    return {
        "WebApp": ...,
    }


# DescribeWebAppResponseTypeDef definition

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

1. See DescribedWebAppTypeDef
2. See ResponseMetadataTypeDef

DescribedExecutionTypeDef

# DescribedExecutionTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedExecutionTypeDef


def get_value() -> DescribedExecutionTypeDef:
    return {
        "ExecutionId": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_transfer.type_defs import WorkflowStepOutputTypeDef


def get_value() -> WorkflowStepOutputTypeDef:
    return {
        "Type": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_transfer.type_defs import WorkflowStepTypeDef


def get_value() -> WorkflowStepTypeDef:
    return {
        "Type": ...,
    }


# 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 TagStepDetailsUnionTypeDef
6. See DecryptStepDetailsTypeDef

ListExecutionsResponseTypeDef

# ListExecutionsResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import ListExecutionsResponseTypeDef


def get_value() -> ListExecutionsResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListExecutionsResponseTypeDef definition

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

1. See List[ListedExecutionTypeDef]
2. See ResponseMetadataTypeDef

DescribeServerResponseTypeDef

# DescribeServerResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeServerResponseTypeDef


def get_value() -> DescribeServerResponseTypeDef:
    return {
        "Server": ...,
    }


# DescribeServerResponseTypeDef definition

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

1. See DescribedServerTypeDef
2. See ResponseMetadataTypeDef

CreateServerRequestTypeDef

# CreateServerRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateServerRequestTypeDef


def get_value() -> CreateServerRequestTypeDef:
    return {
        "Certificate": ...,
    }


# CreateServerRequestTypeDef definition

class CreateServerRequestTypeDef(TypedDict):
    Certificate: NotRequired[str],
    Domain: NotRequired[DomainType],  # (1)
    EndpointDetails: NotRequired[EndpointDetailsUnionTypeDef],  # (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[ProtocolDetailsUnionTypeDef],  # (7)
    SecurityPolicyName: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (8)
    WorkflowDetails: NotRequired[WorkflowDetailsUnionTypeDef],  # (9)
    StructuredLogDestinations: NotRequired[Sequence[str]],
    S3StorageOptions: NotRequired[S3StorageOptionsTypeDef],  # (10)

1. See DomainType
2. See EndpointDetailsUnionTypeDef
3. See EndpointTypeType
4. See IdentityProviderDetailsTypeDef
5. See IdentityProviderTypeType
6. See Sequence[ProtocolType]
7. See ProtocolDetailsUnionTypeDef
8. See Sequence[TagTypeDef]
9. See WorkflowDetailsUnionTypeDef
10. See S3StorageOptionsTypeDef

UpdateServerRequestTypeDef

# UpdateServerRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import UpdateServerRequestTypeDef


def get_value() -> UpdateServerRequestTypeDef:
    return {
        "ServerId": ...,
    }


# UpdateServerRequestTypeDef definition

class UpdateServerRequestTypeDef(TypedDict):
    ServerId: str,
    Certificate: NotRequired[str],
    ProtocolDetails: NotRequired[ProtocolDetailsUnionTypeDef],  # (1)
    EndpointDetails: NotRequired[EndpointDetailsUnionTypeDef],  # (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[WorkflowDetailsUnionTypeDef],  # (6)
    StructuredLogDestinations: NotRequired[Sequence[str]],
    S3StorageOptions: NotRequired[S3StorageOptionsTypeDef],  # (7)

1. See ProtocolDetailsUnionTypeDef
2. See EndpointDetailsUnionTypeDef
3. See EndpointTypeType
4. See IdentityProviderDetailsTypeDef
5. See Sequence[ProtocolType]
6. See WorkflowDetailsUnionTypeDef
7. See S3StorageOptionsTypeDef

DescribeExecutionResponseTypeDef

# DescribeExecutionResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeExecutionResponseTypeDef


def get_value() -> DescribeExecutionResponseTypeDef:
    return {
        "WorkflowId": ...,
    }


# DescribeExecutionResponseTypeDef definition

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

1. See DescribedExecutionTypeDef
2. See ResponseMetadataTypeDef

DescribedWorkflowTypeDef

# DescribedWorkflowTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribedWorkflowTypeDef


def get_value() -> DescribedWorkflowTypeDef:
    return {
        "Arn": ...,
    }


# 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 List[WorkflowStepOutputTypeDef]
2. See List[WorkflowStepOutputTypeDef]
3. See List[TagTypeDef]

DescribeWorkflowResponseTypeDef

# DescribeWorkflowResponseTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import DescribeWorkflowResponseTypeDef


def get_value() -> DescribeWorkflowResponseTypeDef:
    return {
        "Workflow": ...,
    }


# DescribeWorkflowResponseTypeDef definition

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

1. See DescribedWorkflowTypeDef
2. See ResponseMetadataTypeDef

CreateWorkflowRequestTypeDef

# CreateWorkflowRequestTypeDef TypedDict usage example

from mypy_boto3_transfer.type_defs import CreateWorkflowRequestTypeDef


def get_value() -> CreateWorkflowRequestTypeDef:
    return {
        "Steps": ...,
    }


# CreateWorkflowRequestTypeDef definition

class CreateWorkflowRequestTypeDef(TypedDict):
    Steps: Sequence[WorkflowStepUnionTypeDef],  # (1)
    Description: NotRequired[str],
    OnExceptionSteps: NotRequired[Sequence[WorkflowStepUnionTypeDef]],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)

1. See Sequence[WorkflowStepUnionTypeDef]
2. See Sequence[WorkflowStepUnionTypeDef]
3. See Sequence[TagTypeDef]