AWS SDK for C++  1.9.44
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::Transfer::TransferClient Class Reference

#include <TransferClient.h>

+ Inheritance diagram for Aws::Transfer::TransferClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 TransferClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 TransferClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 TransferClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~TransferClient ()
 
virtual Model::CreateAccessOutcome CreateAccess (const Model::CreateAccessRequest &request) const
 
virtual Model::CreateAccessOutcomeCallable CreateAccessCallable (const Model::CreateAccessRequest &request) const
 
virtual void CreateAccessAsync (const Model::CreateAccessRequest &request, const CreateAccessResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateServerOutcome CreateServer (const Model::CreateServerRequest &request) const
 
virtual Model::CreateServerOutcomeCallable CreateServerCallable (const Model::CreateServerRequest &request) const
 
virtual void CreateServerAsync (const Model::CreateServerRequest &request, const CreateServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateUserOutcome CreateUser (const Model::CreateUserRequest &request) const
 
virtual Model::CreateUserOutcomeCallable CreateUserCallable (const Model::CreateUserRequest &request) const
 
virtual void CreateUserAsync (const Model::CreateUserRequest &request, const CreateUserResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteAccessOutcome DeleteAccess (const Model::DeleteAccessRequest &request) const
 
virtual Model::DeleteAccessOutcomeCallable DeleteAccessCallable (const Model::DeleteAccessRequest &request) const
 
virtual void DeleteAccessAsync (const Model::DeleteAccessRequest &request, const DeleteAccessResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteServerOutcome DeleteServer (const Model::DeleteServerRequest &request) const
 
virtual Model::DeleteServerOutcomeCallable DeleteServerCallable (const Model::DeleteServerRequest &request) const
 
virtual void DeleteServerAsync (const Model::DeleteServerRequest &request, const DeleteServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteSshPublicKeyOutcome DeleteSshPublicKey (const Model::DeleteSshPublicKeyRequest &request) const
 
virtual Model::DeleteSshPublicKeyOutcomeCallable DeleteSshPublicKeyCallable (const Model::DeleteSshPublicKeyRequest &request) const
 
virtual void DeleteSshPublicKeyAsync (const Model::DeleteSshPublicKeyRequest &request, const DeleteSshPublicKeyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteUserOutcome DeleteUser (const Model::DeleteUserRequest &request) const
 
virtual Model::DeleteUserOutcomeCallable DeleteUserCallable (const Model::DeleteUserRequest &request) const
 
virtual void DeleteUserAsync (const Model::DeleteUserRequest &request, const DeleteUserResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeAccessOutcome DescribeAccess (const Model::DescribeAccessRequest &request) const
 
virtual Model::DescribeAccessOutcomeCallable DescribeAccessCallable (const Model::DescribeAccessRequest &request) const
 
virtual void DescribeAccessAsync (const Model::DescribeAccessRequest &request, const DescribeAccessResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeSecurityPolicyOutcome DescribeSecurityPolicy (const Model::DescribeSecurityPolicyRequest &request) const
 
virtual Model::DescribeSecurityPolicyOutcomeCallable DescribeSecurityPolicyCallable (const Model::DescribeSecurityPolicyRequest &request) const
 
virtual void DescribeSecurityPolicyAsync (const Model::DescribeSecurityPolicyRequest &request, const DescribeSecurityPolicyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeServerOutcome DescribeServer (const Model::DescribeServerRequest &request) const
 
virtual Model::DescribeServerOutcomeCallable DescribeServerCallable (const Model::DescribeServerRequest &request) const
 
virtual void DescribeServerAsync (const Model::DescribeServerRequest &request, const DescribeServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeUserOutcome DescribeUser (const Model::DescribeUserRequest &request) const
 
virtual Model::DescribeUserOutcomeCallable DescribeUserCallable (const Model::DescribeUserRequest &request) const
 
virtual void DescribeUserAsync (const Model::DescribeUserRequest &request, const DescribeUserResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ImportSshPublicKeyOutcome ImportSshPublicKey (const Model::ImportSshPublicKeyRequest &request) const
 
virtual Model::ImportSshPublicKeyOutcomeCallable ImportSshPublicKeyCallable (const Model::ImportSshPublicKeyRequest &request) const
 
virtual void ImportSshPublicKeyAsync (const Model::ImportSshPublicKeyRequest &request, const ImportSshPublicKeyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListAccessesOutcome ListAccesses (const Model::ListAccessesRequest &request) const
 
virtual Model::ListAccessesOutcomeCallable ListAccessesCallable (const Model::ListAccessesRequest &request) const
 
virtual void ListAccessesAsync (const Model::ListAccessesRequest &request, const ListAccessesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListSecurityPoliciesOutcome ListSecurityPolicies (const Model::ListSecurityPoliciesRequest &request) const
 
virtual Model::ListSecurityPoliciesOutcomeCallable ListSecurityPoliciesCallable (const Model::ListSecurityPoliciesRequest &request) const
 
virtual void ListSecurityPoliciesAsync (const Model::ListSecurityPoliciesRequest &request, const ListSecurityPoliciesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListServersOutcome ListServers (const Model::ListServersRequest &request) const
 
virtual Model::ListServersOutcomeCallable ListServersCallable (const Model::ListServersRequest &request) const
 
virtual void ListServersAsync (const Model::ListServersRequest &request, const ListServersResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const
 
virtual Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const Model::ListTagsForResourceRequest &request) const
 
virtual void ListTagsForResourceAsync (const Model::ListTagsForResourceRequest &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListUsersOutcome ListUsers (const Model::ListUsersRequest &request) const
 
virtual Model::ListUsersOutcomeCallable ListUsersCallable (const Model::ListUsersRequest &request) const
 
virtual void ListUsersAsync (const Model::ListUsersRequest &request, const ListUsersResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::StartServerOutcome StartServer (const Model::StartServerRequest &request) const
 
virtual Model::StartServerOutcomeCallable StartServerCallable (const Model::StartServerRequest &request) const
 
virtual void StartServerAsync (const Model::StartServerRequest &request, const StartServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::StopServerOutcome StopServer (const Model::StopServerRequest &request) const
 
virtual Model::StopServerOutcomeCallable StopServerCallable (const Model::StopServerRequest &request) const
 
virtual void StopServerAsync (const Model::StopServerRequest &request, const StopServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const
 
virtual Model::TagResourceOutcomeCallable TagResourceCallable (const Model::TagResourceRequest &request) const
 
virtual void TagResourceAsync (const Model::TagResourceRequest &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TestIdentityProviderOutcome TestIdentityProvider (const Model::TestIdentityProviderRequest &request) const
 
virtual Model::TestIdentityProviderOutcomeCallable TestIdentityProviderCallable (const Model::TestIdentityProviderRequest &request) const
 
virtual void TestIdentityProviderAsync (const Model::TestIdentityProviderRequest &request, const TestIdentityProviderResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const
 
virtual Model::UntagResourceOutcomeCallable UntagResourceCallable (const Model::UntagResourceRequest &request) const
 
virtual void UntagResourceAsync (const Model::UntagResourceRequest &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateAccessOutcome UpdateAccess (const Model::UpdateAccessRequest &request) const
 
virtual Model::UpdateAccessOutcomeCallable UpdateAccessCallable (const Model::UpdateAccessRequest &request) const
 
virtual void UpdateAccessAsync (const Model::UpdateAccessRequest &request, const UpdateAccessResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateServerOutcome UpdateServer (const Model::UpdateServerRequest &request) const
 
virtual Model::UpdateServerOutcomeCallable UpdateServerCallable (const Model::UpdateServerRequest &request) const
 
virtual void UpdateServerAsync (const Model::UpdateServerRequest &request, const UpdateServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateUserOutcome UpdateUser (const Model::UpdateUserRequest &request) const
 
virtual Model::UpdateUserOutcomeCallable UpdateUserCallable (const Model::UpdateUserRequest &request) const
 
virtual void UpdateUserAsync (const Model::UpdateUserRequest &request, const UpdateUserResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

AWS Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.

Definition at line 190 of file TransferClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 193 of file TransferClient.h.

Constructor & Destructor Documentation

◆ TransferClient() [1/3]

Aws::Transfer::TransferClient::TransferClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ TransferClient() [2/3]

Aws::Transfer::TransferClient::TransferClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ TransferClient() [3/3]

Aws::Transfer::TransferClient::TransferClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~TransferClient()

virtual Aws::Transfer::TransferClient::~TransferClient ( )
virtual

Member Function Documentation

◆ CreateAccess()

virtual Model::CreateAccessOutcome Aws::Transfer::TransferClient::CreateAccess ( const Model::CreateAccessRequest request) const
virtual

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using AWS Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

See Also:

AWS API Reference

◆ CreateAccessAsync()

virtual void Aws::Transfer::TransferClient::CreateAccessAsync ( const Model::CreateAccessRequest request,
const CreateAccessResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using AWS Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateAccessCallable()

virtual Model::CreateAccessOutcomeCallable Aws::Transfer::TransferClient::CreateAccessCallable ( const Model::CreateAccessRequest request) const
virtual

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using AWS Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateServer()

virtual Model::CreateServerOutcome Aws::Transfer::TransferClient::CreateServer ( const Model::CreateServerRequest request) const
virtual

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

See Also:

AWS API Reference

◆ CreateServerAsync()

virtual void Aws::Transfer::TransferClient::CreateServerAsync ( const Model::CreateServerRequest request,
const CreateServerResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateServerCallable()

virtual Model::CreateServerOutcomeCallable Aws::Transfer::TransferClient::CreateServerCallable ( const Model::CreateServerRequest request) const
virtual

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateUser()

virtual Model::CreateUserOutcome Aws::Transfer::TransferClient::CreateUser ( const Model::CreateUserRequest request) const
virtual

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

See Also:

AWS API Reference

◆ CreateUserAsync()

virtual void Aws::Transfer::TransferClient::CreateUserAsync ( const Model::CreateUserRequest request,
const CreateUserResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateUserCallable()

virtual Model::CreateUserOutcomeCallable Aws::Transfer::TransferClient::CreateUserCallable ( const Model::CreateUserRequest request) const
virtual

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteAccess()

virtual Model::DeleteAccessOutcome Aws::Transfer::TransferClient::DeleteAccess ( const Model::DeleteAccessRequest request) const
virtual

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

See Also:

AWS API Reference

◆ DeleteAccessAsync()

virtual void Aws::Transfer::TransferClient::DeleteAccessAsync ( const Model::DeleteAccessRequest request,
const DeleteAccessResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteAccessCallable()

virtual Model::DeleteAccessOutcomeCallable Aws::Transfer::TransferClient::DeleteAccessCallable ( const Model::DeleteAccessRequest request) const
virtual

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteServer()

virtual Model::DeleteServerOutcome Aws::Transfer::TransferClient::DeleteServer ( const Model::DeleteServerRequest request) const
virtual

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

No response returns from this operation.

See Also:

AWS API Reference

◆ DeleteServerAsync()

virtual void Aws::Transfer::TransferClient::DeleteServerAsync ( const Model::DeleteServerRequest request,
const DeleteServerResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

No response returns from this operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteServerCallable()

virtual Model::DeleteServerOutcomeCallable Aws::Transfer::TransferClient::DeleteServerCallable ( const Model::DeleteServerRequest request) const
virtual

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

No response returns from this operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteSshPublicKey()

virtual Model::DeleteSshPublicKeyOutcome Aws::Transfer::TransferClient::DeleteSshPublicKey ( const Model::DeleteSshPublicKeyRequest request) const
virtual

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

No response is returned from this operation.

See Also:

AWS API Reference

◆ DeleteSshPublicKeyAsync()

virtual void Aws::Transfer::TransferClient::DeleteSshPublicKeyAsync ( const Model::DeleteSshPublicKeyRequest request,
const DeleteSshPublicKeyResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

No response is returned from this operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteSshPublicKeyCallable()

virtual Model::DeleteSshPublicKeyOutcomeCallable Aws::Transfer::TransferClient::DeleteSshPublicKeyCallable ( const Model::DeleteSshPublicKeyRequest request) const
virtual

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

No response is returned from this operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteUser()

virtual Model::DeleteUserOutcome Aws::Transfer::TransferClient::DeleteUser ( const Model::DeleteUserRequest request) const
virtual

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

No response returns from this operation.

When you delete a user from a server, the user's information is lost.

See Also:

AWS API Reference

◆ DeleteUserAsync()

virtual void Aws::Transfer::TransferClient::DeleteUserAsync ( const Model::DeleteUserRequest request,
const DeleteUserResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

No response returns from this operation.

When you delete a user from a server, the user's information is lost.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteUserCallable()

virtual Model::DeleteUserOutcomeCallable Aws::Transfer::TransferClient::DeleteUserCallable ( const Model::DeleteUserRequest request) const
virtual

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

No response returns from this operation.

When you delete a user from a server, the user's information is lost.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeAccess()

virtual Model::DescribeAccessOutcome Aws::Transfer::TransferClient::DescribeAccess ( const Model::DescribeAccessRequest request) const
virtual

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

The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

See Also:

AWS API Reference

◆ DescribeAccessAsync()

virtual void Aws::Transfer::TransferClient::DescribeAccessAsync ( const Model::DescribeAccessRequest request,
const DescribeAccessResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeAccessCallable()

virtual Model::DescribeAccessOutcomeCallable Aws::Transfer::TransferClient::DescribeAccessCallable ( const Model::DescribeAccessRequest request) const
virtual

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

The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeSecurityPolicy()

virtual Model::DescribeSecurityPolicyOutcome Aws::Transfer::TransferClient::DescribeSecurityPolicy ( const Model::DescribeSecurityPolicyRequest request) const
virtual

Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.

See Also:

AWS API Reference

◆ DescribeSecurityPolicyAsync()

virtual void Aws::Transfer::TransferClient::DescribeSecurityPolicyAsync ( const Model::DescribeSecurityPolicyRequest request,
const DescribeSecurityPolicyResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeSecurityPolicyCallable()

virtual Model::DescribeSecurityPolicyOutcomeCallable Aws::Transfer::TransferClient::DescribeSecurityPolicyCallable ( const Model::DescribeSecurityPolicyRequest request) const
virtual

Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeServer()

virtual Model::DescribeServerOutcome Aws::Transfer::TransferClient::DescribeServer ( const Model::DescribeServerRequest request) const
virtual

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

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

See Also:

AWS API Reference

◆ DescribeServerAsync()

virtual void Aws::Transfer::TransferClient::DescribeServerAsync ( const Model::DescribeServerRequest request,
const DescribeServerResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeServerCallable()

virtual Model::DescribeServerOutcomeCallable Aws::Transfer::TransferClient::DescribeServerCallable ( const Model::DescribeServerRequest request) const
virtual

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

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeUser()

virtual Model::DescribeUserOutcome Aws::Transfer::TransferClient::DescribeUser ( const Model::DescribeUserRequest request) const
virtual

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

The response from this call returns the properties of the user associated with the ServerId value that was specified.

See Also:

AWS API Reference

◆ DescribeUserAsync()

virtual void Aws::Transfer::TransferClient::DescribeUserAsync ( const Model::DescribeUserRequest request,
const DescribeUserResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

The response from this call returns the properties of the user associated with the ServerId value that was specified.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeUserCallable()

virtual Model::DescribeUserOutcomeCallable Aws::Transfer::TransferClient::DescribeUserCallable ( const Model::DescribeUserRequest request) const
virtual

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

The response from this call returns the properties of the user associated with the ServerId value that was specified.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ImportSshPublicKey()

virtual Model::ImportSshPublicKeyOutcome Aws::Transfer::TransferClient::ImportSshPublicKey ( const Model::ImportSshPublicKeyRequest request) const
virtual

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.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

See Also:

AWS API Reference

◆ ImportSshPublicKeyAsync()

virtual void Aws::Transfer::TransferClient::ImportSshPublicKeyAsync ( const Model::ImportSshPublicKeyRequest request,
const ImportSshPublicKeyResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ImportSshPublicKeyCallable()

virtual Model::ImportSshPublicKeyOutcomeCallable Aws::Transfer::TransferClient::ImportSshPublicKeyCallable ( const Model::ImportSshPublicKeyRequest request) const
virtual

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.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListAccesses()

virtual Model::ListAccessesOutcome Aws::Transfer::TransferClient::ListAccesses ( const Model::ListAccessesRequest request) const
virtual

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

See Also:

AWS API Reference

◆ ListAccessesAsync()

virtual void Aws::Transfer::TransferClient::ListAccessesAsync ( const Model::ListAccessesRequest request,
const ListAccessesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListAccessesCallable()

virtual Model::ListAccessesOutcomeCallable Aws::Transfer::TransferClient::ListAccessesCallable ( const Model::ListAccessesRequest request) const
virtual

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListSecurityPolicies()

virtual Model::ListSecurityPoliciesOutcome Aws::Transfer::TransferClient::ListSecurityPolicies ( const Model::ListSecurityPoliciesRequest request) const
virtual

Lists the security policies that are attached to your file transfer protocol-enabled servers.

See Also:

AWS API Reference

◆ ListSecurityPoliciesAsync()

virtual void Aws::Transfer::TransferClient::ListSecurityPoliciesAsync ( const Model::ListSecurityPoliciesRequest request,
const ListSecurityPoliciesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists the security policies that are attached to your file transfer protocol-enabled servers.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListSecurityPoliciesCallable()

virtual Model::ListSecurityPoliciesOutcomeCallable Aws::Transfer::TransferClient::ListSecurityPoliciesCallable ( const Model::ListSecurityPoliciesRequest request) const
virtual

Lists the security policies that are attached to your file transfer protocol-enabled servers.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListServers()

virtual Model::ListServersOutcome Aws::Transfer::TransferClient::ListServers ( const Model::ListServersRequest request) const
virtual

Lists the file transfer protocol-enabled servers that are associated with your AWS account.

See Also:

AWS API Reference

◆ ListServersAsync()

virtual void Aws::Transfer::TransferClient::ListServersAsync ( const Model::ListServersRequest request,
const ListServersResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists the file transfer protocol-enabled servers that are associated with your AWS account.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListServersCallable()

virtual Model::ListServersOutcomeCallable Aws::Transfer::TransferClient::ListServersCallable ( const Model::ListServersRequest request) const
virtual

Lists the file transfer protocol-enabled servers that are associated with your AWS account.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::Transfer::TransferClient::ListTagsForResource ( const Model::ListTagsForResourceRequest request) const
virtual

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

See Also:


AWS API Reference

◆ ListTagsForResourceAsync()

virtual void Aws::Transfer::TransferClient::ListTagsForResourceAsync ( const Model::ListTagsForResourceRequest request,
const ListTagsForResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

See Also:


AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListTagsForResourceCallable()

virtual Model::ListTagsForResourceOutcomeCallable Aws::Transfer::TransferClient::ListTagsForResourceCallable ( const Model::ListTagsForResourceRequest request) const
virtual

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

See Also:


AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListUsers()

virtual Model::ListUsersOutcome Aws::Transfer::TransferClient::ListUsers ( const Model::ListUsersRequest request) const
virtual

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

See Also:

AWS API Reference

◆ ListUsersAsync()

virtual void Aws::Transfer::TransferClient::ListUsersAsync ( const Model::ListUsersRequest request,
const ListUsersResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListUsersCallable()

virtual Model::ListUsersOutcomeCallable Aws::Transfer::TransferClient::ListUsersCallable ( const Model::ListUsersRequest request) const
virtual

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::Transfer::TransferClient::OverrideEndpoint ( const Aws::String endpoint)

◆ StartServer()

virtual Model::StartServerOutcome Aws::Transfer::TransferClient::StartServer ( const Model::StartServerRequest request) const
virtual

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

See Also:

AWS API Reference

◆ StartServerAsync()

virtual void Aws::Transfer::TransferClient::StartServerAsync ( const Model::StartServerRequest request,
const StartServerResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ StartServerCallable()

virtual Model::StartServerOutcomeCallable Aws::Transfer::TransferClient::StartServerCallable ( const Model::StartServerRequest request) const
virtual

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ StopServer()

virtual Model::StopServerOutcome Aws::Transfer::TransferClient::StopServer ( const Model::StopServerRequest request) const
virtual

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Stopping the server will not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

See Also:

AWS API Reference

◆ StopServerAsync()

virtual void Aws::Transfer::TransferClient::StopServerAsync ( const Model::StopServerRequest request,
const StopServerResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Stopping the server will not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ StopServerCallable()

virtual Model::StopServerOutcomeCallable Aws::Transfer::TransferClient::StopServerCallable ( const Model::StopServerRequest request) const
virtual

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Stopping the server will not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TagResource()

virtual Model::TagResourceOutcome Aws::Transfer::TransferClient::TagResource ( const Model::TagResourceRequest request) const
virtual

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

See Also:

AWS API Reference

◆ TagResourceAsync()

virtual void Aws::Transfer::TransferClient::TagResourceAsync ( const Model::TagResourceRequest request,
const TagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagResourceCallable()

virtual Model::TagResourceOutcomeCallable Aws::Transfer::TransferClient::TagResourceCallable ( const Model::TagResourceRequest request) const
virtual

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TestIdentityProvider()

virtual Model::TestIdentityProviderOutcome Aws::Transfer::TransferClient::TestIdentityProvider ( const Model::TestIdentityProviderRequest request) const
virtual

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. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

See Also:

AWS API Reference

◆ TestIdentityProviderAsync()

virtual void Aws::Transfer::TransferClient::TestIdentityProviderAsync ( const Model::TestIdentityProviderRequest request,
const TestIdentityProviderResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TestIdentityProviderCallable()

virtual Model::TestIdentityProviderOutcomeCallable Aws::Transfer::TransferClient::TestIdentityProviderCallable ( const Model::TestIdentityProviderRequest request) const
virtual

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. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UntagResource()

virtual Model::UntagResourceOutcome Aws::Transfer::TransferClient::UntagResource ( const Model::UntagResourceRequest request) const
virtual

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

See Also:

AWS API Reference

◆ UntagResourceAsync()

virtual void Aws::Transfer::TransferClient::UntagResourceAsync ( const Model::UntagResourceRequest request,
const UntagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagResourceCallable()

virtual Model::UntagResourceOutcomeCallable Aws::Transfer::TransferClient::UntagResourceCallable ( const Model::UntagResourceRequest request) const
virtual

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateAccess()

virtual Model::UpdateAccessOutcome Aws::Transfer::TransferClient::UpdateAccess ( const Model::UpdateAccessRequest request) const
virtual

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

See Also:

AWS API Reference

◆ UpdateAccessAsync()

virtual void Aws::Transfer::TransferClient::UpdateAccessAsync ( const Model::UpdateAccessRequest request,
const UpdateAccessResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateAccessCallable()

virtual Model::UpdateAccessOutcomeCallable Aws::Transfer::TransferClient::UpdateAccessCallable ( const Model::UpdateAccessRequest request) const
virtual

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateServer()

virtual Model::UpdateServerOutcome Aws::Transfer::TransferClient::UpdateServer ( const Model::UpdateServerRequest request) const
virtual

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

The UpdateServer call returns the ServerId of the server you updated.

See Also:

AWS API Reference

◆ UpdateServerAsync()

virtual void Aws::Transfer::TransferClient::UpdateServerAsync ( const Model::UpdateServerRequest request,
const UpdateServerResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

The UpdateServer call returns the ServerId of the server you updated.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateServerCallable()

virtual Model::UpdateServerOutcomeCallable Aws::Transfer::TransferClient::UpdateServerCallable ( const Model::UpdateServerRequest request) const
virtual

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

The UpdateServer call returns the ServerId of the server you updated.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateUser()

virtual Model::UpdateUserOutcome Aws::Transfer::TransferClient::UpdateUser ( const Model::UpdateUserRequest request) const
virtual

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

See Also:

AWS API Reference

◆ UpdateUserAsync()

virtual void Aws::Transfer::TransferClient::UpdateUserAsync ( const Model::UpdateUserRequest request,
const UpdateUserResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateUserCallable()

virtual Model::UpdateUserOutcomeCallable Aws::Transfer::TransferClient::UpdateUserCallable ( const Model::UpdateUserRequest request) const
virtual

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


The documentation for this class was generated from the following file: