Skip to content

TransferClient#

Index > Transfer > TransferClient

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

TransferClient#

Type annotations and code completion for boto3.client("transfer"). boto3 documentation

# TransferClient usage example

from boto3.session import Session
from mypy_boto3_transfer.client import TransferClient

def get_transfer_client() -> TransferClient:
    return Session().client("transfer")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("transfer").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("transfer")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServiceError,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidRequestException,
    client.exceptions.ResourceExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottlingException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_transfer.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("transfer").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("transfer").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_access#

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family.

Type annotations and code completion for boto3.client("transfer").create_access method. boto3 documentation

# create_access method definition

def create_access(
    self,
    *,
    Role: str,
    ServerId: str,
    ExternalId: str,
    HomeDirectory: str = ...,
    HomeDirectoryType: HomeDirectoryTypeType = ...,  # (1)
    HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ...,  # (2)
    Policy: str = ...,
    PosixProfile: PosixProfileTypeDef = ...,  # (3)
) -> CreateAccessResponseTypeDef:  # (4)
    ...
  1. See HomeDirectoryTypeType
  2. See HomeDirectoryMapEntryTypeDef
  3. See PosixProfileTypeDef
  4. See CreateAccessResponseTypeDef 
# create_access method usage example with argument unpacking

kwargs: CreateAccessRequestRequestTypeDef = {  # (1)
    "Role": ...,
    "ServerId": ...,
    "ExternalId": ...,
}

parent.create_access(**kwargs)
  1. See CreateAccessRequestRequestTypeDef

create_agreement#

Creates an agreement.

Type annotations and code completion for boto3.client("transfer").create_agreement method. boto3 documentation

# create_agreement method definition

def create_agreement(
    self,
    *,
    ServerId: str,
    LocalProfileId: str,
    PartnerProfileId: str,
    BaseDirectory: str,
    AccessRole: str,
    Description: str = ...,
    Status: AgreementStatusTypeType = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateAgreementResponseTypeDef:  # (3)
    ...
  1. See AgreementStatusTypeType
  2. See TagTypeDef
  3. See CreateAgreementResponseTypeDef 
# create_agreement method usage example with argument unpacking

kwargs: CreateAgreementRequestRequestTypeDef = {  # (1)
    "ServerId": ...,
    "LocalProfileId": ...,
    "PartnerProfileId": ...,
    "BaseDirectory": ...,
    "AccessRole": ...,
}

parent.create_agreement(**kwargs)
  1. See CreateAgreementRequestRequestTypeDef

create_connector#

Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.

Type annotations and code completion for boto3.client("transfer").create_connector method. boto3 documentation

# create_connector method definition

def create_connector(
    self,
    *,
    Url: str,
    AccessRole: str,
    As2Config: As2ConnectorConfigTypeDef = ...,  # (1)
    LoggingRole: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    SftpConfig: SftpConnectorConfigTypeDef = ...,  # (3)
) -> CreateConnectorResponseTypeDef:  # (4)
    ...
  1. See As2ConnectorConfigTypeDef
  2. See TagTypeDef
  3. See SftpConnectorConfigTypeDef
  4. See CreateConnectorResponseTypeDef 
# create_connector method usage example with argument unpacking

kwargs: CreateConnectorRequestRequestTypeDef = {  # (1)
    "Url": ...,
    "AccessRole": ...,
}

parent.create_connector(**kwargs)
  1. See CreateConnectorRequestRequestTypeDef

create_profile#

Creates the local or partner profile to use for AS2 transfers.

Type annotations and code completion for boto3.client("transfer").create_profile method. boto3 documentation

# create_profile method definition

def create_profile(
    self,
    *,
    As2Id: str,
    ProfileType: ProfileTypeType,  # (1)
    CertificateIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateProfileResponseTypeDef:  # (3)
    ...
  1. See ProfileTypeType
  2. See TagTypeDef
  3. See CreateProfileResponseTypeDef 
# create_profile method usage example with argument unpacking

kwargs: CreateProfileRequestRequestTypeDef = {  # (1)
    "As2Id": ...,
    "ProfileType": ...,
}

parent.create_profile(**kwargs)
  1. See CreateProfileRequestRequestTypeDef

create_server#

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.

Type annotations and code completion for boto3.client("transfer").create_server method. boto3 documentation

# create_server method definition

def create_server(
    self,
    *,
    Certificate: str = ...,
    Domain: DomainType = ...,  # (1)
    EndpointDetails: EndpointDetailsTypeDef = ...,  # (2)
    EndpointType: EndpointTypeType = ...,  # (3)
    HostKey: str = ...,
    IdentityProviderDetails: IdentityProviderDetailsTypeDef = ...,  # (4)
    IdentityProviderType: IdentityProviderTypeType = ...,  # (5)
    LoggingRole: str = ...,
    PostAuthenticationLoginBanner: str = ...,
    PreAuthenticationLoginBanner: str = ...,
    Protocols: Sequence[ProtocolType] = ...,  # (6)
    ProtocolDetails: ProtocolDetailsTypeDef = ...,  # (7)
    SecurityPolicyName: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (8)
    WorkflowDetails: WorkflowDetailsTypeDef = ...,  # (9)
    StructuredLogDestinations: Sequence[str] = ...,
) -> CreateServerResponseTypeDef:  # (10)
    ...
  1. See DomainType
  2. See EndpointDetailsTypeDef
  3. See EndpointTypeType
  4. See IdentityProviderDetailsTypeDef
  5. See IdentityProviderTypeType
  6. See ProtocolType
  7. See ProtocolDetailsTypeDef
  8. See TagTypeDef
  9. See WorkflowDetailsTypeDef
  10. See CreateServerResponseTypeDef 
# create_server method usage example with argument unpacking

kwargs: CreateServerRequestRequestTypeDef = {  # (1)
    "Certificate": ...,
}

parent.create_server(**kwargs)
  1. See CreateServerRequestRequestTypeDef

create_user#

Creates a user and associates them with an existing file transfer protocol-enabled server.

Type annotations and code completion for boto3.client("transfer").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    Role: str,
    ServerId: str,
    UserName: str,
    HomeDirectory: str = ...,
    HomeDirectoryType: HomeDirectoryTypeType = ...,  # (1)
    HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ...,  # (2)
    Policy: str = ...,
    PosixProfile: PosixProfileTypeDef = ...,  # (3)
    SshPublicKeyBody: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateUserResponseTypeDef:  # (5)
    ...
  1. See HomeDirectoryTypeType
  2. See HomeDirectoryMapEntryTypeDef
  3. See PosixProfileTypeDef
  4. See TagTypeDef
  5. See CreateUserResponseTypeDef 
# create_user method usage example with argument unpacking

kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "Role": ...,
    "ServerId": ...,
    "UserName": ...,
}

parent.create_user(**kwargs)
  1. See CreateUserRequestRequestTypeDef

create_workflow#

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.

Type annotations and code completion for boto3.client("transfer").create_workflow method. boto3 documentation

# create_workflow method definition

def create_workflow(
    self,
    *,
    Steps: Sequence[WorkflowStepTypeDef],  # (1)
    Description: str = ...,
    OnExceptionSteps: Sequence[WorkflowStepTypeDef] = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateWorkflowResponseTypeDef:  # (4)
    ...
  1. See WorkflowStepTypeDef
  2. See WorkflowStepTypeDef
  3. See TagTypeDef
  4. See CreateWorkflowResponseTypeDef 
# create_workflow method usage example with argument unpacking

kwargs: CreateWorkflowRequestRequestTypeDef = {  # (1)
    "Steps": ...,
}

parent.create_workflow(**kwargs)
  1. See CreateWorkflowRequestRequestTypeDef

delete_access#

Allows you to delete the access specified in the ServerID and ExternalID parameters.

Type annotations and code completion for boto3.client("transfer").delete_access method. boto3 documentation

# delete_access method definition

def delete_access(
    self,
    *,
    ServerId: str,
    ExternalId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_access method usage example with argument unpacking

kwargs: DeleteAccessRequestRequestTypeDef = {  # (1)
    "ServerId": ...,
    "ExternalId": ...,
}

parent.delete_access(**kwargs)
  1. See DeleteAccessRequestRequestTypeDef

delete_agreement#

Delete the agreement that's specified in the provided AgreementId.

Type annotations and code completion for boto3.client("transfer").delete_agreement method. boto3 documentation

# delete_agreement method definition

def delete_agreement(
    self,
    *,
    AgreementId: str,
    ServerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_agreement method usage example with argument unpacking

kwargs: DeleteAgreementRequestRequestTypeDef = {  # (1)
    "AgreementId": ...,
    "ServerId": ...,
}

parent.delete_agreement(**kwargs)
  1. See DeleteAgreementRequestRequestTypeDef

delete_certificate#

Deletes the certificate that's specified in the CertificateId parameter.

Type annotations and code completion for boto3.client("transfer").delete_certificate method. boto3 documentation

# delete_certificate method definition

def delete_certificate(
    self,
    *,
    CertificateId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_certificate method usage example with argument unpacking

kwargs: DeleteCertificateRequestRequestTypeDef = {  # (1)
    "CertificateId": ...,
}

parent.delete_certificate(**kwargs)
  1. See DeleteCertificateRequestRequestTypeDef

delete_connector#

Deletes the connector that's specified in the provided ConnectorId.

Type annotations and code completion for boto3.client("transfer").delete_connector method. boto3 documentation

# delete_connector method definition

def delete_connector(
    self,
    *,
    ConnectorId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_connector method usage example with argument unpacking

kwargs: DeleteConnectorRequestRequestTypeDef = {  # (1)
    "ConnectorId": ...,
}

parent.delete_connector(**kwargs)
  1. See DeleteConnectorRequestRequestTypeDef

delete_host_key#

Deletes the host key that's specified in the HostKeyId parameter.

Type annotations and code completion for boto3.client("transfer").delete_host_key method. boto3 documentation

# delete_host_key method definition

def delete_host_key(
    self,
    *,
    ServerId: str,
    HostKeyId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_host_key method usage example with argument unpacking

kwargs: DeleteHostKeyRequestRequestTypeDef = {  # (1)
    "ServerId": ...,
    "HostKeyId": ...,
}

parent.delete_host_key(**kwargs)
  1. See DeleteHostKeyRequestRequestTypeDef

delete_profile#

Deletes the profile that's specified in the ProfileId parameter.

Type annotations and code completion for boto3.client("transfer").delete_profile method. boto3 documentation

# delete_profile method definition

def delete_profile(
    self,
    *,
    ProfileId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_profile method usage example with argument unpacking

kwargs: DeleteProfileRequestRequestTypeDef = {  # (1)
    "ProfileId": ...,
}

parent.delete_profile(**kwargs)
  1. See DeleteProfileRequestRequestTypeDef

delete_server#

Deletes the file transfer protocol-enabled server that you specify.

Type annotations and code completion for boto3.client("transfer").delete_server method. boto3 documentation

# delete_server method definition

def delete_server(
    self,
    *,
    ServerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_server method usage example with argument unpacking

kwargs: DeleteServerRequestRequestTypeDef = {  # (1)
    "ServerId": ...,
}

parent.delete_server(**kwargs)
  1. See DeleteServerRequestRequestTypeDef

delete_ssh_public_key#

Deletes a user's Secure Shell (SSH) public key.

Type annotations and code completion for boto3.client("transfer").delete_ssh_public_key method. boto3 documentation

# delete_ssh_public_key method definition

def delete_ssh_public_key(
    self,
    *,
    ServerId: str,
    SshPublicKeyId: str,
    UserName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_ssh_public_key method usage example with argument unpacking

kwargs: DeleteSshPublicKeyRequestRequestTypeDef = {  # (1)
    "ServerId": ...,
    "SshPublicKeyId": ...,
    "UserName": ...,
}

parent.delete_ssh_public_key(**kwargs)
  1. See DeleteSshPublicKeyRequestRequestTypeDef

delete_user#

Deletes the user belonging to a file transfer protocol-enabled server you specify.

Type annotations and code completion for boto3.client("transfer").delete_user method. boto3 documentation

# delete_user method definition

def delete_user(
    self,
    *,
    ServerId: str,
    UserName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "ServerId": ...,
    "UserName": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserRequestRequestTypeDef

delete_workflow#

Deletes the specified workflow.

Type annotations and code completion for boto3.client("transfer").delete_workflow method. boto3 documentation

# delete_workflow method definition

def delete_workflow(
    self,
    *,
    WorkflowId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_workflow method usage example with argument unpacking

kwargs: DeleteWorkflowRequestRequestTypeDef = {  # (1)
    "WorkflowId": ...,
}

parent.delete_workflow(**kwargs)
  1. See DeleteWorkflowRequestRequestTypeDef

describe_access#

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.

Type annotations and code completion for boto3.client("transfer").describe_access method. boto3 documentation

# describe_access method definition

def describe_access(
    self,
    *,
    ServerId: str,
    ExternalId: str,
) -> DescribeAccessResponseTypeDef:  # (1)
    ...
  1. See DescribeAccessResponseTypeDef 
# describe_access method usage example with argument unpacking

kwargs: DescribeAccessRequestRequestTypeDef = {  # (1)
    "ServerId": ...,
    "ExternalId": ...,
}

parent.describe_access(**kwargs)
  1. See DescribeAccessRequestRequestTypeDef

describe_agreement#

Describes the agreement that's identified by the AgreementId.

Type annotations and code completion for boto3.client("transfer").describe_agreement method. boto3 documentation

# describe_agreement method definition

def describe_agreement(
    self,
    *,
    AgreementId: str,
    ServerId: str,
) -> DescribeAgreementResponseTypeDef:  # (1)
    ...
  1. See DescribeAgreementResponseTypeDef 
# describe_agreement method usage example with argument unpacking

kwargs: DescribeAgreementRequestRequestTypeDef = {  # (1)
    "AgreementId": ...,
    "ServerId": ...,
}

parent.describe_agreement(**kwargs)
  1. See DescribeAgreementRequestRequestTypeDef

describe_certificate#

Describes the certificate that's identified by the CertificateId.

Type annotations and code completion for boto3.client("transfer").describe_certificate method. boto3 documentation

# describe_certificate method definition

def describe_certificate(
    self,
    *,
    CertificateId: str,
) -> DescribeCertificateResponseTypeDef:  # (1)
    ...
  1. See DescribeCertificateResponseTypeDef 
# describe_certificate method usage example with argument unpacking

kwargs: DescribeCertificateRequestRequestTypeDef = {  # (1)
    "CertificateId": ...,
}

parent.describe_certificate(**kwargs)
  1. See DescribeCertificateRequestRequestTypeDef

describe_connector#

Describes the connector that's identified by the ConnectorId. See also: AWS API Documentation.

Type annotations and code completion for boto3.client("transfer").describe_connector method. boto3 documentation

# describe_connector method definition

def describe_connector(
    self,
    *,
    ConnectorId: str,
) -> DescribeConnectorResponseTypeDef:  # (1)
    ...
  1. See DescribeConnectorResponseTypeDef 
# describe_connector method usage example with argument unpacking

kwargs: DescribeConnectorRequestRequestTypeDef = {  # (1)
    "ConnectorId": ...,
}

parent.describe_connector(**kwargs)
  1. See DescribeConnectorRequestRequestTypeDef

describe_execution#

You can use DescribeExecution to check the details of the execution of the specified workflow.

Type annotations and code completion for boto3.client("transfer").describe_execution method. boto3 documentation

# describe_execution method definition

def describe_execution(
    self,
    *,
    ExecutionId: str,
    WorkflowId: str,
) -> DescribeExecutionResponseTypeDef:  # (1)
    ...
  1. See DescribeExecutionResponseTypeDef 
# describe_execution method usage example with argument unpacking

kwargs: DescribeExecutionRequestRequestTypeDef = {  # (1)
    "ExecutionId": ...,
    "WorkflowId": ...,
}

parent.describe_execution(**kwargs)
  1. See DescribeExecutionRequestRequestTypeDef

describe_host_key#

Returns the details of the host key that's specified by the HostKeyId and ServerId.

Type annotations and code completion for boto3.client("transfer").describe_host_key method. boto3 documentation

# describe_host_key method definition

def describe_host_key(
    self,
    *,
    ServerId: str,
    HostKeyId: str,
) -> DescribeHostKeyResponseTypeDef:  # (1)
    ...
  1. See DescribeHostKeyResponseTypeDef 
# describe_host_key method usage example with argument unpacking

kwargs: DescribeHostKeyRequestRequestTypeDef = {  # (1)
    "ServerId": ...,
    "HostKeyId": ...,
}

parent.describe_host_key(**kwargs)
  1. See DescribeHostKeyRequestRequestTypeDef

describe_profile#

Returns the details of the profile that's specified by the ProfileId.

Type annotations and code completion for boto3.client("transfer").describe_profile method. boto3 documentation

# describe_profile method definition

def describe_profile(
    self,
    *,
    ProfileId: str,
) -> DescribeProfileResponseTypeDef:  # (1)
    ...
  1. See DescribeProfileResponseTypeDef 
# describe_profile method usage example with argument unpacking

kwargs: DescribeProfileRequestRequestTypeDef = {  # (1)
    "ProfileId": ...,
}

parent.describe_profile(**kwargs)
  1. See