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
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.
client = boto3.client("transfer")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServiceError,
client.InvalidNextTokenException,
client.InvalidRequestException,
client.ResourceExistsException,
client.ResourceNotFoundException,
client.ServiceUnavailableException,
client.ThrottlingException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("transfer").close
method.
boto3 documentation
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
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)
...
- See HomeDirectoryTypeType
- See HomeDirectoryMapEntryTypeDef
- See PosixProfileTypeDef
- See CreateAccessResponseTypeDef
kwargs: CreateAccessRequestRequestTypeDef = { # (1)
"Role": ...,
"ServerId": ...,
"ExternalId": ...,
}
parent.create_access(**kwargs)
create_agreement
Creates an agreement.
Type annotations and code completion for boto3.client("transfer").create_agreement
method.
boto3 documentation
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)
...
kwargs: CreateAgreementRequestRequestTypeDef = { # (1)
"ServerId": ...,
"LocalProfileId": ...,
"PartnerProfileId": ...,
"BaseDirectory": ...,
"AccessRole": ...,
}
parent.create_agreement(**kwargs)
create_connector
Creates the connector, which captures the parameters for an outbound connection for the AS2 protocol.
Type annotations and code completion for boto3.client("transfer").create_connector
method.
boto3 documentation
def create_connector(
self,
*,
Url: str,
As2Config: As2ConnectorConfigTypeDef, # (1)
AccessRole: str,
LoggingRole: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateConnectorResponseTypeDef: # (3)
...
kwargs: CreateConnectorRequestRequestTypeDef = { # (1)
"Url": ...,
"As2Config": ...,
"AccessRole": ...,
}
parent.create_connector(**kwargs)
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
def create_profile(
self,
*,
As2Id: str,
ProfileType: ProfileTypeType, # (1)
CertificateIds: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateProfileResponseTypeDef: # (3)
...
- See ProfileTypeType
- See TagTypeDef
- See CreateProfileResponseTypeDef
kwargs: CreateProfileRequestRequestTypeDef = { # (1)
"As2Id": ...,
"ProfileType": ...,
}
parent.create_profile(**kwargs)
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
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)
) -> CreateServerResponseTypeDef: # (10)
...
- See DomainType
- See EndpointDetailsTypeDef
- See EndpointTypeType
- See IdentityProviderDetailsTypeDef
- See IdentityProviderTypeType
- See ProtocolType
- See ProtocolDetailsTypeDef
- See TagTypeDef
- See WorkflowDetailsTypeDef
- See CreateServerResponseTypeDef
kwargs: CreateServerRequestRequestTypeDef = { # (1)
"Certificate": ...,
}
parent.create_server(**kwargs)
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
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)
...
- See HomeDirectoryTypeType
- See HomeDirectoryMapEntryTypeDef
- See PosixProfileTypeDef
- See TagTypeDef
- See CreateUserResponseTypeDef
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"Role": ...,
"ServerId": ...,
"UserName": ...,
}
parent.create_user(**kwargs)
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
def create_workflow(
self,
*,
Steps: Sequence[WorkflowStepTypeDef], # (1)
Description: str = ...,
OnExceptionSteps: Sequence[WorkflowStepTypeDef] = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateWorkflowResponseTypeDef: # (4)
...
kwargs: CreateWorkflowRequestRequestTypeDef = { # (1)
"Steps": ...,
}
parent.create_workflow(**kwargs)
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
def delete_access(
self,
*,
ServerId: str,
ExternalId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAccessRequestRequestTypeDef = { # (1)
"ServerId": ...,
"ExternalId": ...,
}
parent.delete_access(**kwargs)
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
def delete_agreement(
self,
*,
AgreementId: str,
ServerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAgreementRequestRequestTypeDef = { # (1)
"AgreementId": ...,
"ServerId": ...,
}
parent.delete_agreement(**kwargs)
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
def delete_certificate(
self,
*,
CertificateId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCertificateRequestRequestTypeDef = { # (1)
"CertificateId": ...,
}
parent.delete_certificate(**kwargs)
delete_connector
Deletes the agreement that's specified in the provided ConnectorId
.
Type annotations and code completion for boto3.client("transfer").delete_connector
method.
boto3 documentation
def delete_connector(
self,
*,
ConnectorId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteConnectorRequestRequestTypeDef = { # (1)
"ConnectorId": ...,
}
parent.delete_connector(**kwargs)
delete_host_key
Deletes the host key that's specified in the HoskKeyId
parameter.
Type annotations and code completion for boto3.client("transfer").delete_host_key
method.
boto3 documentation
def delete_host_key(
self,
*,
ServerId: str,
HostKeyId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteHostKeyRequestRequestTypeDef = { # (1)
"ServerId": ...,
"HostKeyId": ...,
}
parent.delete_host_key(**kwargs)
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
def delete_profile(
self,
*,
ProfileId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteProfileRequestRequestTypeDef = { # (1)
"ProfileId": ...,
}
parent.delete_profile(**kwargs)
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
def delete_server(
self,
*,
ServerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteServerRequestRequestTypeDef = { # (1)
"ServerId": ...,
}
parent.delete_server(**kwargs)
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
def delete_ssh_public_key(
self,
*,
ServerId: str,
SshPublicKeyId: str,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteSshPublicKeyRequestRequestTypeDef = { # (1)
"ServerId": ...,
"SshPublicKeyId": ...,
"UserName": ...,
}
parent.delete_ssh_public_key(**kwargs)
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
def delete_user(
self,
*,
ServerId: str,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"ServerId": ...,
"UserName": ...,
}
parent.delete_user(**kwargs)
delete_workflow
Deletes the specified workflow.
Type annotations and code completion for boto3.client("transfer").delete_workflow
method.
boto3 documentation
def delete_workflow(
self,
*,
WorkflowId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteWorkflowRequestRequestTypeDef = { # (1)
"WorkflowId": ...,
}
parent.delete_workflow(**kwargs)
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
def describe_access(
self,
*,
ServerId: str,
ExternalId: str,
) -> DescribeAccessResponseTypeDef: # (1)
...
kwargs: DescribeAccessRequestRequestTypeDef = { # (1)
"ServerId": ...,
"ExternalId": ...,
}
parent.describe_access(**kwargs)
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
def describe_agreement(
self,
*,
AgreementId: str,
ServerId: str,
) -> DescribeAgreementResponseTypeDef: # (1)
...
kwargs: DescribeAgreementRequestRequestTypeDef = { # (1)
"AgreementId": ...,
"ServerId": ...,
}
parent.describe_agreement(**kwargs)
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
def describe_certificate(
self,
*,
CertificateId: str,
) -> DescribeCertificateResponseTypeDef: # (1)
...
kwargs: DescribeCertificateRequestRequestTypeDef = { # (1)
"CertificateId": ...,
}
parent.describe_certificate(**kwargs)
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
def describe_connector(
self,
*,
ConnectorId: str,
) -> DescribeConnectorResponseTypeDef: # (1)
...
kwargs: DescribeConnectorRequestRequestTypeDef = { # (1)
"ConnectorId": ...,
}
parent.describe_connector(**kwargs)
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
def describe_execution(
self,
*,
ExecutionId: str,
WorkflowId: str,
) -> DescribeExecutionResponseTypeDef: # (1)
...
kwargs: DescribeExecutionRequestRequestTypeDef = { # (1)
"ExecutionId": ...,
"WorkflowId": ...,
}
parent.describe_execution(**kwargs)
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
def describe_host_key(
self,
*,
ServerId: str,
HostKeyId: str,
) -> DescribeHostKeyResponseTypeDef: # (1)
...
kwargs: DescribeHostKeyRequestRequestTypeDef = { # (1)
"ServerId": ...,
"HostKeyId": ...,
}
parent.describe_host_key(**kwargs)
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
def describe_profile(
self,
*,
ProfileId: str,
) -> DescribeProfileResponseTypeDef: # (1)
...
kwargs: DescribeProfileRequestRequestTypeDef = { # (1)
"ProfileId": ...,
}
parent.describe_profile(**kwargs)
describe_security_policy
Describes the security policy that is attached to your file transfer protocol- enabled server.
Type annotations and code completion for boto3.client("transfer").describe_security_policy
method.
boto3 documentation
def describe_security_policy(
self,
*,
SecurityPolicyName: str,
) -> DescribeSecurityPolicyResponseTypeDef: # (1)
...
kwargs: DescribeSecurityPolicyRequestRequestTypeDef = { # (1)
"SecurityPolicyName": ...,
}
parent.describe_security_policy(**kwargs)
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
def describe_server(
self,
*,
ServerId: str,
) -> DescribeServerResponseTypeDef: # (1)
...
kwargs: DescribeServerRequestRequestTypeDef = { # (1)
"ServerId": ...,
}
parent.describe_server(**kwargs)
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
def describe_user(
self,
*,
ServerId: str,
UserName: str,
) -> DescribeUserResponseTypeDef: # (1)
...
kwargs: DescribeUserRequestRequestTypeDef = { # (1)
"ServerId": ...,
"UserName": ...,
}
parent.describe_user(**kwargs)
describe_workflow
Describes the specified workflow.
Type annotations and code completion for boto3.client("transfer").describe_workflow
method.
boto3 documentation
def describe_workflow(
self,
*,
WorkflowId: str,
) -> DescribeWorkflowResponseTypeDef: # (1)
...
kwargs: DescribeWorkflowRequestRequestTypeDef = { # (1)
"WorkflowId": ...,
}
parent.describe_workflow(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("transfer").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
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
def import_certificate(
self,
*,
Usage: CertificateUsageTypeType, # (1)
Certificate: str,
CertificateChain: str = ...,
PrivateKey: str = ...,
ActiveDate: Union[datetime, str] = ...,
InactiveDate: Union[datetime, str] = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> ImportCertificateResponseTypeDef: # (3)
...
kwargs: ImportCertificateRequestRequestTypeDef = { # (1)
"Usage": ...,
"Certificate": ...,
}
parent.import_certificate(**kwargs)
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
def import_host_key(
self,
*,
ServerId: str,
HostKeyBody: str,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> ImportHostKeyResponseTypeDef: # (2)
...
kwargs: ImportHostKeyRequestRequestTypeDef = { # (1)
"ServerId": ...,
"HostKeyBody": ...,
}
parent.import_host_key(**kwargs)
import_ssh_public_key
Adds a Secure Shell (SSH) public key to a user account 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
def import_ssh_public_key(
self,
*,
ServerId: str,
SshPublicKeyBody: str,
UserName: str,
) -> ImportSshPublicKeyResponseTypeDef: # (1)
...
kwargs: ImportSshPublicKeyRequestRequestTypeDef = { # (1)
"ServerId": ...,
"SshPublicKeyBody": ...,
"UserName": ...,
}
parent.import_ssh_public_key(**kwargs)
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
def list_accesses(
self,
*,
ServerId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAccessesResponseTypeDef: # (1)
...
kwargs: ListAccessesRequestRequestTypeDef = { # (1)
"ServerId": ...,
}
parent.list_accesses(**kwargs)
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
def list_agreements(
self,
*,
ServerId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAgreementsResponseTypeDef: # (1)
...
kwargs: ListAgreementsRequestRequestTypeDef = { # (1)
"ServerId": ...,
}
parent.list_agreements(**kwargs)
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
def list_certificates(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListCertificatesResponseTypeDef: # (1)
...
kwargs: ListCertificatesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_certificates(**kwargs)
list_connectors
Lists the connectors for the specified Region.
Type annotations and code completion for boto3.client("transfer").list_connectors
method.
boto3 documentation
def list_connectors(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListConnectorsResponseTypeDef: # (1)
...
kwargs: ListConnectorsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_connectors(**kwargs)
list_executions
Lists all executions for the specified workflow.
Type annotations and code completion for boto3.client("transfer").list_executions
method.
boto3 documentation
def list_executions(
self,
*,
WorkflowId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListExecutionsResponseTypeDef: # (1)
...
kwargs: ListExecutionsRequestRequestTypeDef = { # (1)
"WorkflowId": ...,
}
parent.list_executions(**kwargs)
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
def list_host_keys(
self,
*,
ServerId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListHostKeysResponseTypeDef: # (1)
...
kwargs: ListHostKeysRequestRequestTypeDef = { # (1)
"ServerId": ...,
}
parent.list_host_keys(**kwargs)
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
def list_profiles(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
ProfileType: ProfileTypeType = ..., # (1)
) -> ListProfilesResponseTypeDef: # (2)
...
kwargs: ListProfilesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_profiles(**kwargs)
list_security_policies
Lists the security policies that are attached to your file transfer protocol- enabled servers.
Type annotations and code completion for boto3.client("transfer").list_security_policies
method.
boto3 documentation
def list_security_policies(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSecurityPoliciesResponseTypeDef: # (1)
...
kwargs: ListSecurityPoliciesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_security_policies(**kwargs)
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
def list_servers(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListServersResponseTypeDef: # (1)
...
kwargs: ListServersRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_servers(**kwargs)
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
def list_tags_for_resource(
self,
*,
Arn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def list_users(
self,
*,
ServerId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListUsersResponseTypeDef: # (1)
...
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"ServerId": ...,
}
parent.list_users(**kwargs)
list_workflows
Lists all of your workflows.
Type annotations and code completion for boto3.client("transfer").list_workflows
method.
boto3 documentation
def list_workflows(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListWorkflowsResponseTypeDef: # (1)
...
kwargs: ListWorkflowsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_workflows(**kwargs)
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
def send_workflow_step_state(
self,
*,
WorkflowId: str,
ExecutionId: str,
Token: str,
Status: CustomStepStatusType, # (1)
) -> Dict[str, Any]:
...
kwargs: SendWorkflowStepStateRequestRequestTypeDef = { # (1)
"WorkflowId": ...,
"ExecutionId": ...,
"Token": ...,
"Status": ...,
}
parent.send_workflow_step_state(**kwargs)
start_file_transfer
Begins an outbound file transfer to a remote AS2 server.
Type annotations and code completion for boto3.client("transfer").start_file_transfer
method.
boto3 documentation
def start_file_transfer(
self,
*,
ConnectorId: str,
SendFilePaths: Sequence[str],
) -> StartFileTransferResponseTypeDef: # (1)
...
kwargs: StartFileTransferRequestRequestTypeDef = { # (1)
"ConnectorId": ...,
"SendFilePaths": ...,
}
parent.start_file_transfer(**kwargs)
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
def start_server(
self,
*,
ServerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StartServerRequestRequestTypeDef = { # (1)
"ServerId": ...,
}
parent.start_server(**kwargs)
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
def stop_server(
self,
*,
ServerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StopServerRequestRequestTypeDef = { # (1)
"ServerId": ...,
}
parent.stop_server(**kwargs)
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
def tag_resource(
self,
*,
Arn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"Arn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
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
def test_identity_provider(
self,
*,
ServerId: str,
UserName: str,
ServerProtocol: ProtocolType = ..., # (1)
SourceIp: str = ...,
UserPassword: str = ...,
) -> TestIdentityProviderResponseTypeDef: # (2)
...
kwargs: TestIdentityProviderRequestRequestTypeDef = { # (1)
"ServerId": ...,
"UserName": ...,
}
parent.test_identity_provider(**kwargs)
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
def untag_resource(
self,
*,
Arn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"Arn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
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
def update_access(
self,
*,
ServerId: str,
ExternalId: str,
HomeDirectory: str = ...,
HomeDirectoryType: HomeDirectoryTypeType = ..., # (1)
HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ..., # (2)
Policy: str = ...,
PosixProfile: PosixProfileTypeDef = ..., # (3)
Role: str = ...,
) -> UpdateAccessResponseTypeDef: # (4)
...
- See HomeDirectoryTypeType
- See HomeDirectoryMapEntryTypeDef
- See PosixProfileTypeDef
- See UpdateAccessResponseTypeDef
kwargs: UpdateAccessRequestRequestTypeDef = { # (1)
"ServerId": ...,
"ExternalId": ...,
}
parent.update_access(**kwargs)
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
def update_agreement(
self,
*,
AgreementId: str,
ServerId: str,
Description: str = ...,
Status: AgreementStatusTypeType = ..., # (1)
LocalProfileId: str = ...,
PartnerProfileId: str = ...,
BaseDirectory: str = ...,
AccessRole: str = ...,
) -> UpdateAgreementResponseTypeDef: # (2)
...
kwargs: UpdateAgreementRequestRequestTypeDef = { # (1)
"AgreementId": ...,
"ServerId": ...,
}
parent.update_agreement(**kwargs)
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
def update_certificate(
self,
*,
CertificateId: str,
ActiveDate: Union[datetime, str] = ...,
InactiveDate: Union[datetime, str] = ...,
Description: str = ...,
) -> UpdateCertificateResponseTypeDef: # (1)
...
kwargs: UpdateCertificateRequestRequestTypeDef = { # (1)
"CertificateId": ...,
}
parent.update_certificate(**kwargs)
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
def update_connector(
self,
*,
ConnectorId: str,
Url: str = ...,
As2Config: As2ConnectorConfigTypeDef = ..., # (1)
AccessRole: str = ...,
LoggingRole: str = ...,
) -> UpdateConnectorResponseTypeDef: # (2)
...
kwargs: UpdateConnectorRequestRequestTypeDef = { # (1)
"ConnectorId": ...,
}
parent.update_connector(**kwargs)
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
def update_host_key(
self,
*,
ServerId: str,
HostKeyId: str,
Description: str,
) -> UpdateHostKeyResponseTypeDef: # (1)
...
kwargs: UpdateHostKeyRequestRequestTypeDef = { # (1)
"ServerId": ...,
"HostKeyId": ...,
"Description": ...,
}
parent.update_host_key(**kwargs)
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
def update_profile(
self,
*,
ProfileId: str,
CertificateIds: Sequence[str] = ...,
) -> UpdateProfileResponseTypeDef: # (1)
...
kwargs: UpdateProfileRequestRequestTypeDef = { # (1)
"ProfileId": ...,
}
parent.update_profile(**kwargs)
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
def update_server(
self,
*,
ServerId: str,
Certificate: str = ...,
ProtocolDetails: ProtocolDetailsTypeDef = ..., # (1)
EndpointDetails: EndpointDetailsTypeDef = ..., # (2)
EndpointType: EndpointTypeType = ..., # (3)
HostKey: str = ...,
IdentityProviderDetails: IdentityProviderDetailsTypeDef = ..., # (4)
LoggingRole: str = ...,
PostAuthenticationLoginBanner: str = ...,
PreAuthenticationLoginBanner: str = ...,
Protocols: Sequence[ProtocolType] = ..., # (5)
SecurityPolicyName: str = ...,
WorkflowDetails: WorkflowDetailsTypeDef = ..., # (6)
) -> UpdateServerResponseTypeDef: # (7)
...
- See ProtocolDetailsTypeDef
- See EndpointDetailsTypeDef
- See EndpointTypeType
- See IdentityProviderDetailsTypeDef
- See ProtocolType
- See WorkflowDetailsTypeDef
- See UpdateServerResponseTypeDef
kwargs: UpdateServerRequestRequestTypeDef = { # (1)
"ServerId": ...,
}
parent.update_server(**kwargs)
update_user
Assigns new properties to a user.
Type annotations and code completion for boto3.client("transfer").update_user
method.
boto3 documentation
def update_user(
self,
*,
ServerId: str,
UserName: str,
HomeDirectory: str = ...,
HomeDirectoryType: HomeDirectoryTypeType = ..., # (1)
HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ..., # (2)
Policy: str = ...,
PosixProfile: PosixProfileTypeDef = ..., # (3)
Role: str = ...,
) -> UpdateUserResponseTypeDef: # (4)
...
- See HomeDirectoryTypeType
- See HomeDirectoryMapEntryTypeDef
- See PosixProfileTypeDef
- See UpdateUserResponseTypeDef
kwargs: UpdateUserRequestRequestTypeDef = { # (1)
"ServerId": ...,
"UserName": ...,
}
parent.update_user(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("transfer").get_paginator
method with overloads.
client.get_paginator("list_accesses")
-> ListAccessesPaginatorclient.get_paginator("list_agreements")
-> ListAgreementsPaginatorclient.get_paginator("list_certificates")
-> ListCertificatesPaginatorclient.get_paginator("list_connectors")
-> ListConnectorsPaginatorclient.get_paginator("list_executions")
-> ListExecutionsPaginatorclient.get_paginator("list_profiles")
-> ListProfilesPaginatorclient.get_paginator("list_security_policies")
-> ListSecurityPoliciesPaginatorclient.get_paginator("list_servers")
-> ListServersPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginatorclient.get_paginator("list_users")
-> ListUsersPaginatorclient.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")
-> ServerOfflineWaiterclient.get_waiter("server_online")
-> ServerOnlineWaiter