Typed dictionaries

Index > Transfer > Typed dictionaries

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

As2ConnectorConfigTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import As2ConnectorConfigTypeDef

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

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)

1. See CompressionEnumType
2. See EncryptionAlgType
3. See SigningAlgType
4. See MdnSigningAlgType
5. See MdnResponseType

HomeDirectoryMapEntryTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import HomeDirectoryMapEntryTypeDef

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

Definition

class HomeDirectoryMapEntryTypeDef(TypedDict):
    Entry: str,
    Target: str,

PosixProfileTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import PosixProfileTypeDef

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

Definition

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

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

TagTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import TagTypeDef

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

Definition

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

EndpointDetailsTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import EndpointDetailsTypeDef

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

Definition

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

IdentityProviderDetailsTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import IdentityProviderDetailsTypeDef

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

Definition

class IdentityProviderDetailsTypeDef(TypedDict):
    Url: NotRequired[str],
    InvocationRole: NotRequired[str],
    DirectoryId: NotRequired[str],
    Function: NotRequired[str],

ProtocolDetailsTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ProtocolDetailsTypeDef

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

Definition

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

1. See TlsSessionResumptionModeType
2. See SetStatOptionType
3. See As2TransportType

CustomStepDetailsTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CustomStepDetailsTypeDef

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

Definition

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

DeleteAccessRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteAccessRequestRequestTypeDef

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

Definition

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

DeleteAgreementRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteAgreementRequestRequestTypeDef

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

Definition

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

DeleteCertificateRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteCertificateRequestRequestTypeDef

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

Definition

class DeleteCertificateRequestRequestTypeDef(TypedDict):
    CertificateId: str,

DeleteConnectorRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteConnectorRequestRequestTypeDef

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

Definition

class DeleteConnectorRequestRequestTypeDef(TypedDict):
    ConnectorId: str,

DeleteHostKeyRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteHostKeyRequestRequestTypeDef

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

Definition

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

DeleteProfileRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteProfileRequestRequestTypeDef

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

Definition

class DeleteProfileRequestRequestTypeDef(TypedDict):
    ProfileId: str,

DeleteServerRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteServerRequestRequestTypeDef

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

Definition

class DeleteServerRequestRequestTypeDef(TypedDict):
    ServerId: str,

DeleteSshPublicKeyRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteSshPublicKeyRequestRequestTypeDef

def get_value() -> DeleteSshPublicKeyRequestRequestTypeDef:
    return {
        "ServerId": ...,
        "SshPublicKeyId": ...,
        "UserName": ...,
    }

Definition

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

DeleteStepDetailsTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteStepDetailsTypeDef

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

Definition

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

DeleteUserRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteUserRequestRequestTypeDef

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

Definition

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

DeleteWorkflowRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DeleteWorkflowRequestRequestTypeDef

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

Definition

class DeleteWorkflowRequestRequestTypeDef(TypedDict):
    WorkflowId: str,

DescribeAccessRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeAccessRequestRequestTypeDef

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

Definition

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

DescribeAgreementRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeAgreementRequestRequestTypeDef

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

Definition

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

DescribeCertificateRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeCertificateRequestRequestTypeDef

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

Definition

class DescribeCertificateRequestRequestTypeDef(TypedDict):
    CertificateId: str,

DescribeConnectorRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeConnectorRequestRequestTypeDef

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

Definition

class DescribeConnectorRequestRequestTypeDef(TypedDict):
    ConnectorId: str,

DescribeExecutionRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeExecutionRequestRequestTypeDef

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

Definition

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

DescribeHostKeyRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeHostKeyRequestRequestTypeDef

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

Definition

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

DescribeProfileRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeProfileRequestRequestTypeDef

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

Definition

class DescribeProfileRequestRequestTypeDef(TypedDict):
    ProfileId: str,

DescribeSecurityPolicyRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeSecurityPolicyRequestRequestTypeDef

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

Definition

class DescribeSecurityPolicyRequestRequestTypeDef(TypedDict):
    SecurityPolicyName: str,

DescribedSecurityPolicyTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedSecurityPolicyTypeDef

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

Definition

class DescribedSecurityPolicyTypeDef(TypedDict):
    SecurityPolicyName: str,
    Fips: NotRequired[bool],
    SshCiphers: NotRequired[List[str]],
    SshKexs: NotRequired[List[str]],
    SshMacs: NotRequired[List[str]],
    TlsCiphers: NotRequired[List[str]],

DescribeServerRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeServerRequestRequestTypeDef

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

Definition

class DescribeServerRequestRequestTypeDef(TypedDict):
    ServerId: str,

WaiterConfigTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import WaiterConfigTypeDef

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

Definition

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

DescribeUserRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeUserRequestRequestTypeDef

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

Definition

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

DescribeWorkflowRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeWorkflowRequestRequestTypeDef

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

Definition

class DescribeWorkflowRequestRequestTypeDef(TypedDict):
    WorkflowId: str,

LoggingConfigurationTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import LoggingConfigurationTypeDef

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

Definition

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

SshPublicKeyTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import SshPublicKeyTypeDef

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

Definition

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

EfsFileLocationTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import EfsFileLocationTypeDef

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

Definition

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

ExecutionErrorTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ExecutionErrorTypeDef

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

Definition

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

1. See ExecutionErrorTypeType

S3FileLocationTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import S3FileLocationTypeDef

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

Definition

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

ImportSshPublicKeyRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ImportSshPublicKeyRequestRequestTypeDef

def get_value() -> ImportSshPublicKeyRequestRequestTypeDef:
    return {
        "ServerId": ...,
        "SshPublicKeyBody": ...,
        "UserName": ...,
    }

Definition

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

S3InputFileLocationTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import S3InputFileLocationTypeDef

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

Definition

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

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import PaginatorConfigTypeDef

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

Definition

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

ListAccessesRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListAccessesRequestRequestTypeDef

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

Definition

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

ListedAccessTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListedAccessTypeDef

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

Definition

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

1. See HomeDirectoryTypeType

ListAgreementsRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListAgreementsRequestRequestTypeDef

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

Definition

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

ListedAgreementTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListedAgreementTypeDef

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

Definition

class ListedAgreementTypeDef(TypedDict):
    Arn: NotRequired[str],
    AgreementId: NotRequired[str],
    Description: NotRequired[str],
    Status: NotRequired[AgreementStatusTypeType],  # (1)
    ServerId: NotRequired[str],
    LocalProfileId: NotRequired[str],
    PartnerProfileId: NotRequired[str],

1. See AgreementStatusTypeType

ListCertificatesRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListCertificatesRequestRequestTypeDef

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

Definition

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

ListedCertificateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListedCertificateTypeDef

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

Definition

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

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

ListConnectorsRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListConnectorsRequestRequestTypeDef

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

Definition

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

ListedConnectorTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListedConnectorTypeDef

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

Definition

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

ListExecutionsRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListExecutionsRequestRequestTypeDef

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

Definition

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

ListHostKeysRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListHostKeysRequestRequestTypeDef

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

Definition

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

ListedHostKeyTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListedHostKeyTypeDef

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

Definition

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

ListProfilesRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListProfilesRequestRequestTypeDef

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

Definition

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

1. See ProfileTypeType

ListedProfileTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListedProfileTypeDef

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

Definition

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

1. See ProfileTypeType

ListSecurityPoliciesRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListSecurityPoliciesRequestRequestTypeDef

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

Definition

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

ListServersRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListServersRequestRequestTypeDef

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

Definition

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

ListedServerTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListedServerTypeDef

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

Definition

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

1. See DomainType
2. See IdentityProviderTypeType
3. See EndpointTypeType
4. See StateType

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListTagsForResourceRequestRequestTypeDef

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

Definition

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

ListUsersRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListUsersRequestRequestTypeDef

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

Definition

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

ListedUserTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListedUserTypeDef

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

Definition

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

1. See HomeDirectoryTypeType

ListWorkflowsRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListWorkflowsRequestRequestTypeDef

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

Definition

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

ListedWorkflowTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListedWorkflowTypeDef

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

Definition

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

S3TagTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import S3TagTypeDef

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

Definition

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

SendWorkflowStepStateRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import SendWorkflowStepStateRequestRequestTypeDef

def get_value() -> SendWorkflowStepStateRequestRequestTypeDef:
    return {
        "WorkflowId": ...,
        "ExecutionId": ...,
        "Token": ...,
        "Status": ...,
    }

Definition

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

1. See CustomStepStatusType

UserDetailsTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UserDetailsTypeDef

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

Definition

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

StartFileTransferRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import StartFileTransferRequestRequestTypeDef

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

Definition

class StartFileTransferRequestRequestTypeDef(TypedDict):
    ConnectorId: str,
    SendFilePaths: Sequence[str],

StartServerRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import StartServerRequestRequestTypeDef

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

Definition

class StartServerRequestRequestTypeDef(TypedDict):
    ServerId: str,

StopServerRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import StopServerRequestRequestTypeDef

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

Definition

class StopServerRequestRequestTypeDef(TypedDict):
    ServerId: str,

TestIdentityProviderRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import TestIdentityProviderRequestRequestTypeDef

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

Definition

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

1. See ProtocolType

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UntagResourceRequestRequestTypeDef

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

Definition

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

UpdateAgreementRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateAgreementRequestRequestTypeDef

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

Definition

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

1. See AgreementStatusTypeType

UpdateCertificateRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateCertificateRequestRequestTypeDef

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

Definition

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

UpdateHostKeyRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateHostKeyRequestRequestTypeDef

def get_value() -> UpdateHostKeyRequestRequestTypeDef:
    return {
        "ServerId": ...,
        "HostKeyId": ...,
        "Description": ...,
    }

Definition

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

UpdateProfileRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateProfileRequestRequestTypeDef

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

Definition

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

WorkflowDetailTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import WorkflowDetailTypeDef

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

Definition

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

UpdateConnectorRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateConnectorRequestRequestTypeDef

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

Definition

class UpdateConnectorRequestRequestTypeDef(TypedDict):
    ConnectorId: str,
    Url: NotRequired[str],
    As2Config: NotRequired[As2ConnectorConfigTypeDef],  # (1)
    AccessRole: NotRequired[str],
    LoggingRole: NotRequired[str],

1. See As2ConnectorConfigTypeDef

CreateAccessRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateAccessRequestRequestTypeDef

def get_value() -> CreateAccessRequestRequestTypeDef:
    return {
        "Role": ...,
        "ServerId": ...,
        "ExternalId": ...,
    }

Definition

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

1. See HomeDirectoryTypeType
2. See HomeDirectoryMapEntryTypeDef
3. See PosixProfileTypeDef

DescribedAccessTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedAccessTypeDef

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

Definition

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

1. See HomeDirectoryMapEntryTypeDef
2. See HomeDirectoryTypeType
3. See PosixProfileTypeDef

UpdateAccessRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateAccessRequestRequestTypeDef

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

Definition

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

1. See HomeDirectoryTypeType
2. See HomeDirectoryMapEntryTypeDef
3. See PosixProfileTypeDef

UpdateUserRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateUserRequestRequestTypeDef

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

Definition

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

1. See HomeDirectoryTypeType
2. See HomeDirectoryMapEntryTypeDef
3. See PosixProfileTypeDef

CreateAccessResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateAccessResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

CreateAgreementResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateAgreementResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

CreateConnectorResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateConnectorResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

CreateProfileResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateProfileResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

CreateServerResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateServerResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

CreateUserResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateUserResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

CreateWorkflowResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateWorkflowResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import EmptyResponseMetadataTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ImportCertificateResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ImportCertificateResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ImportHostKeyResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ImportHostKeyResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ImportSshPublicKeyResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ImportSshPublicKeyResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ListSecurityPoliciesResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListSecurityPoliciesResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

StartFileTransferResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import StartFileTransferResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

TestIdentityProviderResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import TestIdentityProviderResponseTypeDef

def get_value() -> TestIdentityProviderResponseTypeDef:
    return {
        "Response": ...,
        "StatusCode": ...,
        "Message": ...,
        "Url": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

UpdateAccessResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateAccessResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

UpdateAgreementResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateAgreementResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

UpdateCertificateResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateCertificateResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

UpdateConnectorResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateConnectorResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

UpdateHostKeyResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateHostKeyResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

UpdateProfileResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateProfileResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

UpdateServerResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateServerResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

UpdateUserResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateUserResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

CreateAgreementRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateAgreementRequestRequestTypeDef

def get_value() -> CreateAgreementRequestRequestTypeDef:
    return {
        "ServerId": ...,
        "LocalProfileId": ...,
        "PartnerProfileId": ...,
        "BaseDirectory": ...,
        "AccessRole": ...,
    }

Definition

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

1. See AgreementStatusTypeType
2. See TagTypeDef

CreateConnectorRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateConnectorRequestRequestTypeDef

def get_value() -> CreateConnectorRequestRequestTypeDef:
    return {
        "Url": ...,
        "As2Config": ...,
        "AccessRole": ...,
    }

Definition

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

1. See As2ConnectorConfigTypeDef
2. See TagTypeDef

CreateProfileRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateProfileRequestRequestTypeDef

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

Definition

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

1. See ProfileTypeType
2. See TagTypeDef

CreateUserRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateUserRequestRequestTypeDef

def get_value() -> CreateUserRequestRequestTypeDef:
    return {
        "Role": ...,
        "ServerId": ...,
        "UserName": ...,
    }

Definition

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

1. See HomeDirectoryTypeType
2. See HomeDirectoryMapEntryTypeDef
3. See PosixProfileTypeDef
4. See TagTypeDef

DescribedAgreementTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedAgreementTypeDef

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

Definition

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

1. See AgreementStatusTypeType
2. See TagTypeDef

DescribedCertificateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedCertificateTypeDef

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

Definition

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

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

DescribedConnectorTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedConnectorTypeDef

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

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)

1. See As2ConnectorConfigTypeDef
2. See TagTypeDef

DescribedHostKeyTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedHostKeyTypeDef

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

Definition

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

1. See TagTypeDef

DescribedProfileTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedProfileTypeDef

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

Definition

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

1. See ProfileTypeType
2. See TagTypeDef

ImportCertificateRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ImportCertificateRequestRequestTypeDef

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

Definition

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

1. See CertificateUsageTypeType
2. See TagTypeDef

ImportHostKeyRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ImportHostKeyRequestRequestTypeDef

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

Definition

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

1. See TagTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListTagsForResourceResponseTypeDef

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

Definition

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

1. See TagTypeDef
2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import TagResourceRequestRequestTypeDef

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

Definition

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

1. See TagTypeDef

DescribeSecurityPolicyResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeSecurityPolicyResponseTypeDef

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

Definition

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

1. See DescribedSecurityPolicyTypeDef
2. See ResponseMetadataTypeDef

DescribeServerRequestServerOfflineWaitTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeServerRequestServerOfflineWaitTypeDef

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

Definition

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

1. See WaiterConfigTypeDef

DescribeServerRequestServerOnlineWaitTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeServerRequestServerOnlineWaitTypeDef

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

Definition

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

1. See WaiterConfigTypeDef

DescribedUserTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedUserTypeDef

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

Definition

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

1. See HomeDirectoryMapEntryTypeDef
2. See HomeDirectoryTypeType
3. See PosixProfileTypeDef
4. See SshPublicKeyTypeDef
5. See TagTypeDef

ExecutionStepResultTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ExecutionStepResultTypeDef

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

Definition

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

1. See WorkflowStepTypeType
2. See ExecutionErrorTypeDef

FileLocationTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import FileLocationTypeDef

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

Definition

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

1. See S3FileLocationTypeDef
2. See EfsFileLocationTypeDef

InputFileLocationTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import InputFileLocationTypeDef

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

Definition

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

1. See S3InputFileLocationTypeDef
2. See EfsFileLocationTypeDef

ListAccessesRequestListAccessesPaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListAccessesRequestListAccessesPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListAgreementsRequestListAgreementsPaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListAgreementsRequestListAgreementsPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListCertificatesRequestListCertificatesPaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListCertificatesRequestListCertificatesPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListConnectorsRequestListConnectorsPaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListConnectorsRequestListConnectorsPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListExecutionsRequestListExecutionsPaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListExecutionsRequestListExecutionsPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListProfilesRequestListProfilesPaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListProfilesRequestListProfilesPaginateTypeDef

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

Definition

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

1. See ProfileTypeType
2. See PaginatorConfigTypeDef

ListSecurityPoliciesRequestListSecurityPoliciesPaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListSecurityPoliciesRequestListSecurityPoliciesPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListServersRequestListServersPaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListServersRequestListServersPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListTagsForResourceRequestListTagsForResourcePaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListTagsForResourceRequestListTagsForResourcePaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListUsersRequestListUsersPaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListUsersRequestListUsersPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListWorkflowsRequestListWorkflowsPaginateTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListWorkflowsRequestListWorkflowsPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListAccessesResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListAccessesResponseTypeDef

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

Definition

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

1. See ListedAccessTypeDef
2. See ResponseMetadataTypeDef

ListAgreementsResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListAgreementsResponseTypeDef

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

Definition

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

1. See ListedAgreementTypeDef
2. See ResponseMetadataTypeDef

ListCertificatesResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListCertificatesResponseTypeDef

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

Definition

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

1. See ListedCertificateTypeDef
2. See ResponseMetadataTypeDef

ListConnectorsResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListConnectorsResponseTypeDef

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

Definition

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

1. See ListedConnectorTypeDef
2. See ResponseMetadataTypeDef

ListHostKeysResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListHostKeysResponseTypeDef

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

Definition

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

1. See ListedHostKeyTypeDef
2. See ResponseMetadataTypeDef

ListProfilesResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListProfilesResponseTypeDef

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

Definition

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

1. See ListedProfileTypeDef
2. See ResponseMetadataTypeDef

ListServersResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListServersResponseTypeDef

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

Definition

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

1. See ListedServerTypeDef
2. See ResponseMetadataTypeDef

ListUsersResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListUsersResponseTypeDef

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

Definition

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

1. See ListedUserTypeDef
2. See ResponseMetadataTypeDef

ListWorkflowsResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListWorkflowsResponseTypeDef

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

Definition

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

1. See ListedWorkflowTypeDef
2. See ResponseMetadataTypeDef

TagStepDetailsTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import TagStepDetailsTypeDef

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

Definition

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

1. See S3TagTypeDef

ServiceMetadataTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ServiceMetadataTypeDef

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

Definition

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

1. See UserDetailsTypeDef

WorkflowDetailsTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import WorkflowDetailsTypeDef

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

Definition

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

1. See WorkflowDetailTypeDef
2. See WorkflowDetailTypeDef

DescribeAccessResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeAccessResponseTypeDef

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

Definition

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

1. See DescribedAccessTypeDef
2. See ResponseMetadataTypeDef

DescribeAgreementResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeAgreementResponseTypeDef

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

Definition

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

1. See DescribedAgreementTypeDef
2. See ResponseMetadataTypeDef

DescribeCertificateResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeCertificateResponseTypeDef

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

Definition

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

1. See DescribedCertificateTypeDef
2. See ResponseMetadataTypeDef

DescribeConnectorResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeConnectorResponseTypeDef

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

Definition

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

1. See DescribedConnectorTypeDef
2. See ResponseMetadataTypeDef

DescribeHostKeyResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeHostKeyResponseTypeDef

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

Definition

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

1. See DescribedHostKeyTypeDef
2. See ResponseMetadataTypeDef

DescribeProfileResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeProfileResponseTypeDef

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

Definition

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

1. See DescribedProfileTypeDef
2. See ResponseMetadataTypeDef

DescribeUserResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeUserResponseTypeDef

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

Definition

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

1. See DescribedUserTypeDef
2. See ResponseMetadataTypeDef

ExecutionResultsTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ExecutionResultsTypeDef

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

Definition

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

1. See ExecutionStepResultTypeDef
2. See ExecutionStepResultTypeDef

CopyStepDetailsTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CopyStepDetailsTypeDef

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

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

Usage Example

from mypy_boto3_transfer.type_defs import DecryptStepDetailsTypeDef

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

Definition

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

1. See EncryptionTypeType
2. See OverwriteExistingType
3. See InputFileLocationTypeDef

ListedExecutionTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListedExecutionTypeDef

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

Definition

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

1. See FileLocationTypeDef
2. See ServiceMetadataTypeDef
3. See ExecutionStatusType

CreateServerRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateServerRequestRequestTypeDef

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

Definition

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

1. See DomainType
2. See EndpointDetailsTypeDef
3. See EndpointTypeType
4. See IdentityProviderDetailsTypeDef
5. See IdentityProviderTypeType
6. See ProtocolType
7. See ProtocolDetailsTypeDef
8. See TagTypeDef
9. See WorkflowDetailsTypeDef

DescribedServerTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedServerTypeDef

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

Definition

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

1. See ProtocolDetailsTypeDef
2. See DomainType
3. See EndpointDetailsTypeDef
4. See EndpointTypeType
5. See IdentityProviderDetailsTypeDef
6. See IdentityProviderTypeType
7. See ProtocolType
8. See StateType
9. See TagTypeDef
10. See WorkflowDetailsTypeDef

UpdateServerRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import UpdateServerRequestRequestTypeDef

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

Definition

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

1. See ProtocolDetailsTypeDef
2. See EndpointDetailsTypeDef
3. See EndpointTypeType
4. See IdentityProviderDetailsTypeDef
5. See ProtocolType
6. See WorkflowDetailsTypeDef

DescribedExecutionTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedExecutionTypeDef

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

Definition

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

1. See FileLocationTypeDef
2. See ServiceMetadataTypeDef
3. See LoggingConfigurationTypeDef
4. See PosixProfileTypeDef
5. See ExecutionStatusType
6. See ExecutionResultsTypeDef

WorkflowStepTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import WorkflowStepTypeDef

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

Definition

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

1. See WorkflowStepTypeType
2. See CopyStepDetailsTypeDef
3. See CustomStepDetailsTypeDef
4. See DeleteStepDetailsTypeDef
5. See TagStepDetailsTypeDef
6. See DecryptStepDetailsTypeDef

ListExecutionsResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import ListExecutionsResponseTypeDef

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

Definition

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

1. See ListedExecutionTypeDef
2. See ResponseMetadataTypeDef

DescribeServerResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeServerResponseTypeDef

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

Definition

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

1. See DescribedServerTypeDef
2. See ResponseMetadataTypeDef

DescribeExecutionResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeExecutionResponseTypeDef

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

Definition

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

1. See DescribedExecutionTypeDef
2. See ResponseMetadataTypeDef

CreateWorkflowRequestRequestTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import CreateWorkflowRequestRequestTypeDef

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

Definition

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

1. See WorkflowStepTypeDef
2. See WorkflowStepTypeDef
3. See TagTypeDef

DescribedWorkflowTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribedWorkflowTypeDef

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

Definition

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

1. See WorkflowStepTypeDef
2. See WorkflowStepTypeDef
3. See TagTypeDef

DescribeWorkflowResponseTypeDef

Usage Example

from mypy_boto3_transfer.type_defs import DescribeWorkflowResponseTypeDef

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

Definition

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

1. See DescribedWorkflowTypeDef
2. See ResponseMetadataTypeDef