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

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:
    ...

generate_presigned_url

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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: PosixProfileUnionTypeDef = ...,  # (3)
) -> CreateAccessResponseTypeDef:  # (4)
    ...

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

# create_access method usage example with argument unpacking

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

parent.create_access(**kwargs)

1. See CreateAccessRequestTypeDef

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,
    AccessRole: str,
    Description: str = ...,
    BaseDirectory: str = ...,
    Status: AgreementStatusTypeType = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    PreserveFilename: PreserveFilenameTypeType = ...,  # (3)
    EnforceMessageSigning: EnforceMessageSigningTypeType = ...,  # (4)
    CustomDirectories: CustomDirectoriesTypeTypeDef = ...,  # (5)
) -> CreateAgreementResponseTypeDef:  # (6)
    ...

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

# create_agreement method usage example with argument unpacking

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

parent.create_agreement(**kwargs)

1. See CreateAgreementRequestTypeDef

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: SftpConnectorConfigUnionTypeDef = ...,  # (3)
    SecurityPolicyName: str = ...,
) -> CreateConnectorResponseTypeDef:  # (4)
    ...

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

# create_connector method usage example with argument unpacking

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

parent.create_connector(**kwargs)

1. See CreateConnectorRequestTypeDef

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 Sequence[TagTypeDef]
3. See CreateProfileResponseTypeDef

# create_profile method usage example with argument unpacking

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

parent.create_profile(**kwargs)

1. See CreateProfileRequestTypeDef

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: EndpointDetailsUnionTypeDef = ...,  # (2)
    EndpointType: EndpointTypeType = ...,  # (3)
    HostKey: str = ...,
    IdentityProviderDetails: IdentityProviderDetailsTypeDef = ...,  # (4)
    IdentityProviderType: IdentityProviderTypeType = ...,  # (5)
    LoggingRole: str = ...,
    PostAuthenticationLoginBanner: str = ...,
    PreAuthenticationLoginBanner: str = ...,
    Protocols: Sequence[ProtocolType] = ...,  # (6)
    ProtocolDetails: ProtocolDetailsUnionTypeDef = ...,  # (7)
    SecurityPolicyName: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (8)
    WorkflowDetails: WorkflowDetailsUnionTypeDef = ...,  # (9)
    StructuredLogDestinations: Sequence[str] = ...,
    S3StorageOptions: S3StorageOptionsTypeDef = ...,  # (10)
) -> CreateServerResponseTypeDef:  # (11)
    ...

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

# create_server method usage example with argument unpacking

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

parent.create_server(**kwargs)

1. See CreateServerRequestTypeDef

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: PosixProfileUnionTypeDef = ...,  # (3)
    SshPublicKeyBody: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateUserResponseTypeDef:  # (5)
    ...

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

# create_user method usage example with argument unpacking

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

parent.create_user(**kwargs)

1. See CreateUserRequestTypeDef

create_web_app

Creates a web app based on specified parameters, and returns the ID for the new web app.

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

# create_web_app method definition

def create_web_app(
    self,
    *,
    IdentityProviderDetails: WebAppIdentityProviderDetailsTypeDef,  # (1)
    AccessEndpoint: str = ...,
    WebAppUnits: WebAppUnitsTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    WebAppEndpointPolicy: WebAppEndpointPolicyType = ...,  # (4)
) -> CreateWebAppResponseTypeDef:  # (5)
    ...

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

# create_web_app method usage example with argument unpacking

kwargs: CreateWebAppRequestTypeDef = {  # (1)
    "IdentityProviderDetails": ...,
}

parent.create_web_app(**kwargs)

1. See CreateWebAppRequestTypeDef

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[WorkflowStepUnionTypeDef],  # (1)
    Description: str = ...,
    OnExceptionSteps: Sequence[WorkflowStepUnionTypeDef] = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateWorkflowResponseTypeDef:  # (4)
    ...

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

# create_workflow method usage example with argument unpacking

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

parent.create_workflow(**kwargs)

1. See CreateWorkflowRequestTypeDef

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: DeleteAccessRequestTypeDef = {  # (1)
    "ServerId": ...,
    "ExternalId": ...,
}

parent.delete_access(**kwargs)

1. See DeleteAccessRequestTypeDef

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: DeleteAgreementRequestTypeDef = {  # (1)
    "AgreementId": ...,
    "ServerId": ...,
}

parent.delete_agreement(**kwargs)

1. See DeleteAgreementRequestTypeDef

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: DeleteCertificateRequestTypeDef = {  # (1)
    "CertificateId": ...,
}

parent.delete_certificate(**kwargs)

1. See DeleteCertificateRequestTypeDef

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: DeleteConnectorRequestTypeDef = {  # (1)
    "ConnectorId": ...,
}

parent.delete_connector(**kwargs)

1. See DeleteConnectorRequestTypeDef

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: DeleteHostKeyRequestTypeDef = {  # (1)
    "ServerId": ...,
    "HostKeyId": ...,
}

parent.delete_host_key(**kwargs)

1. See DeleteHostKeyRequestTypeDef

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: DeleteProfileRequestTypeDef = {  # (1)
    "ProfileId": ...,
}

parent.delete_profile(**kwargs)

1. See DeleteProfileRequestTypeDef

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: DeleteServerRequestTypeDef = {  # (1)
    "ServerId": ...,
}

parent.delete_server(**kwargs)

1. See DeleteServerRequestTypeDef

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: DeleteSshPublicKeyRequestTypeDef = {  # (1)
    "ServerId": ...,
    "SshPublicKeyId": ...,
    "UserName": ...,
}

parent.delete_ssh_public_key(**kwargs)

1. See DeleteSshPublicKeyRequestTypeDef

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: DeleteUserRequestTypeDef = {  # (1)
    "ServerId": ...,
    "UserName": ...,
}

parent.delete_user(**kwargs)

1. See DeleteUserRequestTypeDef

delete_web_app

Deletes the specified web app.

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

# delete_web_app method definition

def delete_web_app(
    self,
    *,
    WebAppId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_web_app method usage example with argument unpacking

kwargs: DeleteWebAppRequestTypeDef = {  # (1)
    "WebAppId": ...,
}

parent.delete_web_app(**kwargs)

1. See DeleteWebAppRequestTypeDef

delete_web_app_customization

Deletes the WebAppCustomization object that corresponds to the web app ID specified.

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

# delete_web_app_customization method definition

def delete_web_app_customization(
    self,
    *,
    WebAppId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_web_app_customization method usage example with argument unpacking

kwargs: DeleteWebAppCustomizationRequestTypeDef = {  # (1)
    "WebAppId": ...,
}

parent.delete_web_app_customization(**kwargs)

1. See DeleteWebAppCustomizationRequestTypeDef

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: DeleteWorkflowRequestTypeDef = {  # (1)
    "WorkflowId": ...,
}

parent.delete_workflow(**kwargs)

1. See DeleteWorkflowRequestTypeDef

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: DescribeAccessRequestTypeDef = {  # (1)
    "ServerId": ...,
    "ExternalId": ...,
}

parent.describe_access(**kwargs)

1. See DescribeAccessRequestTypeDef

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: DescribeAgreementRequestTypeDef = {  # (1)
    "AgreementId": ...,
    "ServerId": ...,
}

parent.describe_agreement(**kwargs)

1. See DescribeAgreementRequestTypeDef

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: DescribeCertificateRequestTypeDef = {  # (1)
    "CertificateId": ...,
}

parent.describe_certificate(**kwargs)

1. See DescribeCertificateRequestTypeDef

describe_connector

Describes the connector that's identified by the ConnectorId..

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: DescribeConnectorRequestTypeDef = {  # (1)
    "ConnectorId": ...,
}

parent.describe_connector(**kwargs)

1. See DescribeConnectorRequestTypeDef

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: DescribeExecutionRequestTypeDef = {  # (1)
    "ExecutionId": ...,
    "WorkflowId": ...,
}

parent.describe_execution(**kwargs)

1. See DescribeExecutionRequestTypeDef

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: DescribeHostKeyRequestTypeDef = {  # (1)
    "ServerId": ...,
    "HostKeyId": ...,
}

parent.describe_host_key(**kwargs)

1. See DescribeHostKeyRequestTypeDef

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: DescribeProfileRequestTypeDef = {  # (1)
    "ProfileId": ...,
}

parent.describe_profile(**kwargs)

1. See DescribeProfileRequestTypeDef

describe_security_policy

Describes the security policy that is attached to your server or SFTP connector.

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

# describe_security_policy method definition

def describe_security_policy(
    self,
    *,
    SecurityPolicyName: str,
) -> DescribeSecurityPolicyResponseTypeDef:  # (1)
    ...

1. See DescribeSecurityPolicyResponseTypeDef

# describe_security_policy method usage example with argument unpacking

kwargs: DescribeSecurityPolicyRequestTypeDef = {  # (1)
    "SecurityPolicyName": ...,
}

parent.describe_security_policy(**kwargs)

1. See DescribeSecurityPolicyRequestTypeDef

describe_server

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

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

# describe_server method definition

def describe_server(
    self,
    *,
    ServerId: str,
) -> DescribeServerResponseTypeDef:  # (1)
    ...

1. See DescribeServerResponseTypeDef

# describe_server method usage example with argument unpacking

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

parent.describe_server(**kwargs)

1. See DescribeServerRequestTypeDef

describe_user

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

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

# describe_user method definition

def describe_user(
    self,
    *,
    ServerId: str,
    UserName: str,
) -> DescribeUserResponseTypeDef:  # (1)
    ...

1. See DescribeUserResponseTypeDef

# describe_user method usage example with argument unpacking

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

parent.describe_user(**kwargs)

1. See DescribeUserRequestTypeDef

describe_web_app

Describes the web app that's identified by WebAppId.

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

# describe_web_app method definition

def describe_web_app(
    self,
    *,
    WebAppId: str,
) -> DescribeWebAppResponseTypeDef:  # (1)
    ...

1. See DescribeWebAppResponseTypeDef

# describe_web_app method usage example with argument unpacking

kwargs: DescribeWebAppRequestTypeDef = {  # (1)
    "WebAppId": ...,
}

parent.describe_web_app(**kwargs)

1. See DescribeWebAppRequestTypeDef

describe_web_app_customization

Describes the web app customization object that's identified by WebAppId.

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

# describe_web_app_customization method definition

def describe_web_app_customization(
    self,
    *,
    WebAppId: str,
) -> DescribeWebAppCustomizationResponseTypeDef:  # (1)
    ...

1. See DescribeWebAppCustomizationResponseTypeDef

# describe_web_app_customization method usage example with argument unpacking

kwargs: DescribeWebAppCustomizationRequestTypeDef = {  # (1)
    "WebAppId": ...,
}

parent.describe_web_app_customization(**kwargs)

1. See DescribeWebAppCustomizationRequestTypeDef

describe_workflow

Describes the specified workflow.

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

# describe_workflow method definition

def describe_workflow(
    self,
    *,
    WorkflowId: str,
) -> DescribeWorkflowResponseTypeDef:  # (1)
    ...

1. See DescribeWorkflowResponseTypeDef

# describe_workflow method usage example with argument unpacking

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

parent.describe_workflow(**kwargs)

1. See DescribeWorkflowRequestTypeDef

import_certificate

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

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

# import_certificate method definition

def import_certificate(
    self,
    *,
    Usage: CertificateUsageTypeType,  # (1)
    Certificate: str,
    CertificateChain: str = ...,
    PrivateKey: str = ...,
    ActiveDate: TimestampTypeDef = ...,
    InactiveDate: TimestampTypeDef = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> ImportCertificateResponseTypeDef:  # (3)
    ...

1. See CertificateUsageTypeType
2. See Sequence[TagTypeDef]
3. See ImportCertificateResponseTypeDef

# import_certificate method usage example with argument unpacking

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

parent.import_certificate(**kwargs)

1. See ImportCertificateRequestTypeDef

import_host_key

Adds a host key to the server that's specified by the ServerId parameter.

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

# import_host_key method definition

def import_host_key(
    self,
    *,
    ServerId: str,
    HostKeyBody: str,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> ImportHostKeyResponseTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See ImportHostKeyResponseTypeDef

# import_host_key method usage example with argument unpacking

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

parent.import_host_key(**kwargs)

1. See ImportHostKeyRequestTypeDef

import_ssh_public_key

Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

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

# import_ssh_public_key method definition

def import_ssh_public_key(
    self,
    *,
    ServerId: str,
    SshPublicKeyBody: str,
    UserName: str,
) -> ImportSshPublicKeyResponseTypeDef:  # (1)
    ...

1. See ImportSshPublicKeyResponseTypeDef

# import_ssh_public_key method usage example with argument unpacking

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

parent.import_ssh_public_key(**kwargs)

1. See ImportSshPublicKeyRequestTypeDef

list_accesses

Lists the details for all the accesses you have on your server.

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

# list_accesses method definition

def list_accesses(
    self,
    *,
    ServerId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAccessesResponseTypeDef:  # (1)
    ...

1. See ListAccessesResponseTypeDef

# list_accesses method usage example with argument unpacking

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

parent.list_accesses(**kwargs)

1. See ListAccessesRequestTypeDef

list_agreements

Returns a list of the agreements for the server that's identified by the ServerId that you supply.

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

# list_agreements method definition

def list_agreements(
    self,
    *,
    ServerId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAgreementsResponseTypeDef:  # (1)
    ...

1. See ListAgreementsResponseTypeDef

# list_agreements method usage example with argument unpacking

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

parent.list_agreements(**kwargs)

1. See ListAgreementsRequestTypeDef

list_certificates

Returns a list of the current certificates that have been imported into Transfer Family.

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

# list_certificates method definition

def list_certificates(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCertificatesResponseTypeDef:  # (1)
    ...

1. See ListCertificatesResponseTypeDef

# list_certificates method usage example with argument unpacking

kwargs: ListCertificatesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_certificates(**kwargs)

1. See ListCertificatesRequestTypeDef

list_connectors

Lists the connectors for the specified Region.

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

# list_connectors method definition

def list_connectors(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConnectorsResponseTypeDef:  # (1)
    ...

1. See ListConnectorsResponseTypeDef

# list_connectors method usage example with argument unpacking

kwargs: ListConnectorsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_connectors(**kwargs)

1. See ListConnectorsRequestTypeDef

list_executions

Lists all in-progress executions for the specified workflow.

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

# list_executions method definition

def list_executions(
    self,
    *,
    WorkflowId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListExecutionsResponseTypeDef:  # (1)
    ...

1. See ListExecutionsResponseTypeDef

# list_executions method usage example with argument unpacking

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

parent.list_executions(**kwargs)

1. See ListExecutionsRequestTypeDef

list_file_transfer_results

Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation.

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

# list_file_transfer_results method definition

def list_file_transfer_results(
    self,
    *,
    ConnectorId: str,
    TransferId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFileTransferResultsResponseTypeDef:  # (1)
    ...

1. See ListFileTransferResultsResponseTypeDef

# list_file_transfer_results method usage example with argument unpacking

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

parent.list_file_transfer_results(**kwargs)

1. See ListFileTransferResultsRequestTypeDef

list_host_keys

Returns a list of host keys for the server that's specified by the ServerId parameter.

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

# list_host_keys method definition

def list_host_keys(
    self,
    *,
    ServerId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHostKeysResponseTypeDef:  # (1)
    ...

1. See ListHostKeysResponseTypeDef

# list_host_keys method usage example with argument unpacking

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

parent.list_host_keys(**kwargs)

1. See ListHostKeysRequestTypeDef

list_profiles

Returns a list of the profiles for your system.

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

# list_profiles method definition

def list_profiles(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    ProfileType: ProfileTypeType = ...,  # (1)
) -> ListProfilesResponseTypeDef:  # (2)
    ...

1. See ProfileTypeType
2. See ListProfilesResponseTypeDef

# list_profiles method usage example with argument unpacking

kwargs: ListProfilesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_profiles(**kwargs)

1. See ListProfilesRequestTypeDef

list_security_policies

Lists the security policies that are attached to your servers and SFTP connectors.

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

# list_security_policies method definition

def list_security_policies(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSecurityPoliciesResponseTypeDef:  # (1)
    ...

1. See ListSecurityPoliciesResponseTypeDef

# list_security_policies method usage example with argument unpacking

kwargs: ListSecurityPoliciesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_security_policies(**kwargs)

1. See ListSecurityPoliciesRequestTypeDef

list_servers

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

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

# list_servers method definition

def list_servers(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListServersResponseTypeDef:  # (1)
    ...

1. See ListServersResponseTypeDef

# list_servers method usage example with argument unpacking

kwargs: ListServersRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_servers(**kwargs)

1. See ListServersRequestTypeDef

list_tags_for_resource

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    Arn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_users

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

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

# list_users method definition

def list_users(
    self,
    *,
    ServerId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...

1. See ListUsersResponseTypeDef

# list_users method usage example with argument unpacking

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

parent.list_users(**kwargs)

1. See ListUsersRequestTypeDef

list_web_apps

Lists all web apps associated with your Amazon Web Services account for your current region.

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

# list_web_apps method definition

def list_web_apps(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListWebAppsResponseTypeDef:  # (1)
    ...

1. See ListWebAppsResponseTypeDef

# list_web_apps method usage example with argument unpacking

kwargs: ListWebAppsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_web_apps(**kwargs)

1. See ListWebAppsRequestTypeDef

list_workflows

Lists all workflows associated with your Amazon Web Services account for your current region.

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

# list_workflows method definition

def list_workflows(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListWorkflowsResponseTypeDef:  # (1)
    ...

1. See ListWorkflowsResponseTypeDef

# list_workflows method usage example with argument unpacking

kwargs: ListWorkflowsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_workflows(**kwargs)

1. See ListWorkflowsRequestTypeDef

send_workflow_step_state

Sends a callback for asynchronous custom steps.

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

# send_workflow_step_state method definition

def send_workflow_step_state(
    self,
    *,
    WorkflowId: str,
    ExecutionId: str,
    Token: str,
    Status: CustomStepStatusType,  # (1)
) -> Dict[str, Any]:
    ...

1. See CustomStepStatusType

# send_workflow_step_state method usage example with argument unpacking

kwargs: SendWorkflowStepStateRequestTypeDef = {  # (1)
    "WorkflowId": ...,
    "ExecutionId": ...,
    "Token": ...,
    "Status": ...,
}

parent.send_workflow_step_state(**kwargs)

1. See SendWorkflowStepStateRequestTypeDef

start_directory_listing

Retrieves a list of the contents of a directory from a remote SFTP server.

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

# start_directory_listing method definition

def start_directory_listing(
    self,
    *,
    ConnectorId: str,
    RemoteDirectoryPath: str,
    OutputDirectoryPath: str,
    MaxItems: int = ...,
) -> StartDirectoryListingResponseTypeDef:  # (1)
    ...

1. See StartDirectoryListingResponseTypeDef

# start_directory_listing method usage example with argument unpacking

kwargs: StartDirectoryListingRequestTypeDef = {  # (1)
    "ConnectorId": ...,
    "RemoteDirectoryPath": ...,
    "OutputDirectoryPath": ...,
}

parent.start_directory_listing(**kwargs)

1. See StartDirectoryListingRequestTypeDef

start_file_transfer

Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

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

# start_file_transfer method definition

def start_file_transfer(
    self,
    *,
    ConnectorId: str,
    SendFilePaths: Sequence[str] = ...,
    RetrieveFilePaths: Sequence[str] = ...,
    LocalDirectoryPath: str = ...,
    RemoteDirectoryPath: str = ...,
) -> StartFileTransferResponseTypeDef:  # (1)
    ...

1. See StartFileTransferResponseTypeDef

# start_file_transfer method usage example with argument unpacking

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

parent.start_file_transfer(**kwargs)

1. See StartFileTransferRequestTypeDef

start_remote_delete

Deletes a file or directory on the remote SFTP server.

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

# start_remote_delete method definition

def start_remote_delete(
    self,
    *,
    ConnectorId: str,
    DeletePath: str,
) -> StartRemoteDeleteResponseTypeDef:  # (1)
    ...

1. See StartRemoteDeleteResponseTypeDef

# start_remote_delete method usage example with argument unpacking

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

parent.start_remote_delete(**kwargs)

1. See StartRemoteDeleteRequestTypeDef

start_remote_move

Moves or renames a file or directory on the remote SFTP server.

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

# start_remote_move method definition

def start_remote_move(
    self,
    *,
    ConnectorId: str,
    SourcePath: str,
    TargetPath: str,
) -> StartRemoteMoveResponseTypeDef:  # (1)
    ...

1. See StartRemoteMoveResponseTypeDef

# start_remote_move method usage example with argument unpacking

kwargs: StartRemoteMoveRequestTypeDef = {  # (1)
    "ConnectorId": ...,
    "SourcePath": ...,
    "TargetPath": ...,
}

parent.start_remote_move(**kwargs)

1. See StartRemoteMoveRequestTypeDef

start_server

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE.

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

# start_server method definition

def start_server(
    self,
    *,
    ServerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# start_server method usage example with argument unpacking

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

parent.start_server(**kwargs)

1. See StartServerRequestTypeDef

stop_server

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE.

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

# stop_server method definition

def stop_server(
    self,
    *,
    ServerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_server method usage example with argument unpacking

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

parent.stop_server(**kwargs)

1. See StopServerRequestTypeDef

tag_resource

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    Arn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "Arn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

test_connection

Tests whether your SFTP connector is set up successfully.

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

# test_connection method definition

def test_connection(
    self,
    *,
    ConnectorId: str,
) -> TestConnectionResponseTypeDef:  # (1)
    ...

1. See TestConnectionResponseTypeDef

# test_connection method usage example with argument unpacking

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

parent.test_connection(**kwargs)

1. See TestConnectionRequestTypeDef

test_identity_provider

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully.

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

# test_identity_provider method definition

def test_identity_provider(
    self,
    *,
    ServerId: str,
    UserName: str,
    ServerProtocol: ProtocolType = ...,  # (1)
    SourceIp: str = ...,
    UserPassword: str = ...,
) -> TestIdentityProviderResponseTypeDef:  # (2)
    ...

1. See ProtocolType
2. See TestIdentityProviderResponseTypeDef

# test_identity_provider method usage example with argument unpacking

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

parent.test_identity_provider(**kwargs)

1. See TestIdentityProviderRequestTypeDef

untag_resource

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    Arn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "Arn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_access

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

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

# update_access method definition

def update_access(
    self,
    *,
    ServerId: str,
    ExternalId: str,
    HomeDirectory: str = ...,
    HomeDirectoryType: HomeDirectoryTypeType = ...,  # (1)
    HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ...,  # (2)
    Policy: str = ...,
    PosixProfile: PosixProfileUnionTypeDef = ...,  # (3)
    Role: str = ...,
) -> UpdateAccessResponseTypeDef:  # (4)
    ...

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

# update_access method usage example with argument unpacking

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

parent.update_access(**kwargs)

1. See UpdateAccessRequestTypeDef

update_agreement

Updates some of the parameters for an existing agreement.

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

# update_agreement method definition

def update_agreement(
    self,
    *,
    AgreementId: str,
    ServerId: str,
    Description: str = ...,
    Status: AgreementStatusTypeType = ...,  # (1)
    LocalProfileId: str = ...,
    PartnerProfileId: str = ...,
    BaseDirectory: str = ...,
    AccessRole: str = ...,
    PreserveFilename: PreserveFilenameTypeType = ...,  # (2)
    EnforceMessageSigning: EnforceMessageSigningTypeType = ...,  # (3)
    CustomDirectories: CustomDirectoriesTypeTypeDef = ...,  # (4)
) -> UpdateAgreementResponseTypeDef:  # (5)
    ...

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

# update_agreement method usage example with argument unpacking

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

parent.update_agreement(**kwargs)

1. See UpdateAgreementRequestTypeDef

update_certificate

Updates the active and inactive dates for a certificate.

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

# update_certificate method definition

def update_certificate(
    self,
    *,
    CertificateId: str,
    ActiveDate: TimestampTypeDef = ...,
    InactiveDate: TimestampTypeDef = ...,
    Description: str = ...,
) -> UpdateCertificateResponseTypeDef:  # (1)
    ...

1. See UpdateCertificateResponseTypeDef

# update_certificate method usage example with argument unpacking

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

parent.update_certificate(**kwargs)

1. See UpdateCertificateRequestTypeDef

update_connector

Updates some of the parameters for an existing connector.

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

# update_connector method definition

def update_connector(
    self,
    *,
    ConnectorId: str,
    Url: str = ...,
    As2Config: As2ConnectorConfigTypeDef = ...,  # (1)
    AccessRole: str = ...,
    LoggingRole: str = ...,
    SftpConfig: SftpConnectorConfigUnionTypeDef = ...,  # (2)
    SecurityPolicyName: str = ...,
) -> UpdateConnectorResponseTypeDef:  # (3)
    ...

1. See As2ConnectorConfigTypeDef
2. See SftpConnectorConfigUnionTypeDef
3. See UpdateConnectorResponseTypeDef

# update_connector method usage example with argument unpacking

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

parent.update_connector(**kwargs)

1. See UpdateConnectorRequestTypeDef

update_host_key

Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.

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

# update_host_key method definition

def update_host_key(
    self,
    *,
    ServerId: str,
    HostKeyId: str,
    Description: str,
) -> UpdateHostKeyResponseTypeDef:  # (1)
    ...

1. See UpdateHostKeyResponseTypeDef

# update_host_key method usage example with argument unpacking

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

parent.update_host_key(**kwargs)

1. See UpdateHostKeyRequestTypeDef

update_profile

Updates some of the parameters for an existing profile.

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

# update_profile method definition

def update_profile(
    self,
    *,
    ProfileId: str,
    CertificateIds: Sequence[str] = ...,
) -> UpdateProfileResponseTypeDef:  # (1)
    ...

1. See UpdateProfileResponseTypeDef

# update_profile method usage example with argument unpacking

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

parent.update_profile(**kwargs)

1. See UpdateProfileRequestTypeDef

update_server

Updates the file transfer protocol-enabled server's properties after that server has been created.

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

# update_server method definition

def update_server(
    self,
    *,
    ServerId: str,
    Certificate: str = ...,
    ProtocolDetails: ProtocolDetailsUnionTypeDef = ...,  # (1)
    EndpointDetails: EndpointDetailsUnionTypeDef = ...,  # (2)
    EndpointType: EndpointTypeType = ...,  # (3)
    HostKey: str = ...,
    IdentityProviderDetails: IdentityProviderDetailsTypeDef = ...,  # (4)
    LoggingRole: str = ...,
    PostAuthenticationLoginBanner: str = ...,
    PreAuthenticationLoginBanner: str = ...,
    Protocols: Sequence[ProtocolType] = ...,  # (5)
    SecurityPolicyName: str = ...,
    WorkflowDetails: WorkflowDetailsUnionTypeDef = ...,  # (6)
    StructuredLogDestinations: Sequence[str] = ...,
    S3StorageOptions: S3StorageOptionsTypeDef = ...,  # (7)
) -> UpdateServerResponseTypeDef:  # (8)
    ...

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

# update_server method usage example with argument unpacking

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

parent.update_server(**kwargs)

1. See UpdateServerRequestTypeDef

update_user

Assigns new properties to a user.

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

# update_user method definition

def update_user(
    self,
    *,
    ServerId: str,
    UserName: str,
    HomeDirectory: str = ...,
    HomeDirectoryType: HomeDirectoryTypeType = ...,  # (1)
    HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ...,  # (2)
    Policy: str = ...,
    PosixProfile: PosixProfileUnionTypeDef = ...,  # (3)
    Role: str = ...,
) -> UpdateUserResponseTypeDef:  # (4)
    ...

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

# update_user method usage example with argument unpacking

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

parent.update_user(**kwargs)

1. See UpdateUserRequestTypeDef

update_web_app

Assigns new properties to a web app.

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

# update_web_app method definition

def update_web_app(
    self,
    *,
    WebAppId: str,
    IdentityProviderDetails: UpdateWebAppIdentityProviderDetailsTypeDef = ...,  # (1)
    AccessEndpoint: str = ...,
    WebAppUnits: WebAppUnitsTypeDef = ...,  # (2)
) -> UpdateWebAppResponseTypeDef:  # (3)
    ...

1. See UpdateWebAppIdentityProviderDetailsTypeDef
2. See WebAppUnitsTypeDef
3. See UpdateWebAppResponseTypeDef

# update_web_app method usage example with argument unpacking

kwargs: UpdateWebAppRequestTypeDef = {  # (1)
    "WebAppId": ...,
}

parent.update_web_app(**kwargs)

1. See UpdateWebAppRequestTypeDef

update_web_app_customization

Assigns new customization properties to a web app.

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

# update_web_app_customization method definition

def update_web_app_customization(
    self,
    *,
    WebAppId: str,
    Title: str = ...,
    LogoFile: BlobTypeDef = ...,
    FaviconFile: BlobTypeDef = ...,
) -> UpdateWebAppCustomizationResponseTypeDef:  # (1)
    ...

1. See UpdateWebAppCustomizationResponseTypeDef

# update_web_app_customization method usage example with argument unpacking

kwargs: UpdateWebAppCustomizationRequestTypeDef = {  # (1)
    "WebAppId": ...,
}

parent.update_web_app_customization(**kwargs)

1. See UpdateWebAppCustomizationRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("transfer").get_paginator method with overloads.

• client.get_paginator("list_accesses") -> ListAccessesPaginator
• client.get_paginator("list_agreements") -> ListAgreementsPaginator
• client.get_paginator("list_certificates") -> ListCertificatesPaginator
• client.get_paginator("list_connectors") -> ListConnectorsPaginator
• client.get_paginator("list_executions") -> ListExecutionsPaginator
• client.get_paginator("list_file_transfer_results") -> ListFileTransferResultsPaginator
• client.get_paginator("list_profiles") -> ListProfilesPaginator
• client.get_paginator("list_security_policies") -> ListSecurityPoliciesPaginator
• client.get_paginator("list_servers") -> ListServersPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator
• client.get_paginator("list_users") -> ListUsersPaginator
• client.get_paginator("list_web_apps") -> ListWebAppsPaginator
• client.get_paginator("list_workflows") -> ListWorkflowsPaginator

get_waiter

Type annotations and code completion for boto3.client("transfer").get_waiter method with overloads.

• client.get_waiter("server_offline") -> ServerOfflineWaiter
• client.get_waiter("server_online") -> ServerOnlineWaiter