#include <TransferClient.h>

Inheritance diagram for Aws::Transfer::TransferClient:

[legend]

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS

typedef TransferClientConfiguration ClientConfigurationType

typedef TransferEndpointProvider EndpointProviderType

Public Types inherited from Aws::Client::AWSJsonClient

typedef AWSClient BASECLASS

Public Member Functions

TransferClient (const Aws::Transfer::TransferClientConfiguration &clientConfiguration=Aws::Transfer::TransferClientConfiguration(), std::shared_ptr< TransferEndpointProviderBase > endpointProvider=nullptr)

TransferClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< TransferEndpointProviderBase > endpointProvider=nullptr, const Aws::Transfer::TransferClientConfiguration &clientConfiguration=Aws::Transfer::TransferClientConfiguration())

TransferClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< TransferEndpointProviderBase > endpointProvider=nullptr, const Aws::Transfer::TransferClientConfiguration &clientConfiguration=Aws::Transfer::TransferClientConfiguration())

TransferClient (const Aws::Client::ClientConfiguration &clientConfiguration)

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

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

virtual ~TransferClient ()

virtual Model::CreateAccessOutcome CreateAccess (const Model::CreateAccessRequest &request) const

template<typename CreateAccessRequestT = Model::CreateAccessRequest>

Model::CreateAccessOutcomeCallable CreateAccessCallable (const CreateAccessRequestT &request) const

template<typename CreateAccessRequestT = Model::CreateAccessRequest>

void CreateAccessAsync (const CreateAccessRequestT &request, const CreateAccessResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::CreateAgreementOutcome CreateAgreement (const Model::CreateAgreementRequest &request) const

template<typename CreateAgreementRequestT = Model::CreateAgreementRequest>

Model::CreateAgreementOutcomeCallable CreateAgreementCallable (const CreateAgreementRequestT &request) const

template<typename CreateAgreementRequestT = Model::CreateAgreementRequest>

void CreateAgreementAsync (const CreateAgreementRequestT &request, const CreateAgreementResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::CreateConnectorOutcome CreateConnector (const Model::CreateConnectorRequest &request) const

template<typename CreateConnectorRequestT = Model::CreateConnectorRequest>

Model::CreateConnectorOutcomeCallable CreateConnectorCallable (const CreateConnectorRequestT &request) const

template<typename CreateConnectorRequestT = Model::CreateConnectorRequest>

void CreateConnectorAsync (const CreateConnectorRequestT &request, const CreateConnectorResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::CreateProfileOutcome CreateProfile (const Model::CreateProfileRequest &request) const

template<typename CreateProfileRequestT = Model::CreateProfileRequest>

Model::CreateProfileOutcomeCallable CreateProfileCallable (const CreateProfileRequestT &request) const

template<typename CreateProfileRequestT = Model::CreateProfileRequest>

void CreateProfileAsync (const CreateProfileRequestT &request, const CreateProfileResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::CreateServerOutcome CreateServer (const Model::CreateServerRequest &request={}) const

template<typename CreateServerRequestT = Model::CreateServerRequest>

Model::CreateServerOutcomeCallable CreateServerCallable (const CreateServerRequestT &request={}) const

template<typename CreateServerRequestT = Model::CreateServerRequest>

void CreateServerAsync (const CreateServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const CreateServerRequestT &request={}) const

virtual Model::CreateUserOutcome CreateUser (const Model::CreateUserRequest &request) const

template<typename CreateUserRequestT = Model::CreateUserRequest>

Model::CreateUserOutcomeCallable CreateUserCallable (const CreateUserRequestT &request) const

template<typename CreateUserRequestT = Model::CreateUserRequest>

void CreateUserAsync (const CreateUserRequestT &request, const CreateUserResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::CreateWorkflowOutcome CreateWorkflow (const Model::CreateWorkflowRequest &request) const

template<typename CreateWorkflowRequestT = Model::CreateWorkflowRequest>

Model::CreateWorkflowOutcomeCallable CreateWorkflowCallable (const CreateWorkflowRequestT &request) const

template<typename CreateWorkflowRequestT = Model::CreateWorkflowRequest>

void CreateWorkflowAsync (const CreateWorkflowRequestT &request, const CreateWorkflowResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DeleteAccessOutcome DeleteAccess (const Model::DeleteAccessRequest &request) const

template<typename DeleteAccessRequestT = Model::DeleteAccessRequest>

Model::DeleteAccessOutcomeCallable DeleteAccessCallable (const DeleteAccessRequestT &request) const

template<typename DeleteAccessRequestT = Model::DeleteAccessRequest>

void DeleteAccessAsync (const DeleteAccessRequestT &request, const DeleteAccessResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DeleteAgreementOutcome DeleteAgreement (const Model::DeleteAgreementRequest &request) const

template<typename DeleteAgreementRequestT = Model::DeleteAgreementRequest>

Model::DeleteAgreementOutcomeCallable DeleteAgreementCallable (const DeleteAgreementRequestT &request) const

template<typename DeleteAgreementRequestT = Model::DeleteAgreementRequest>

void DeleteAgreementAsync (const DeleteAgreementRequestT &request, const DeleteAgreementResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DeleteCertificateOutcome DeleteCertificate (const Model::DeleteCertificateRequest &request) const

template<typename DeleteCertificateRequestT = Model::DeleteCertificateRequest>

Model::DeleteCertificateOutcomeCallable DeleteCertificateCallable (const DeleteCertificateRequestT &request) const

template<typename DeleteCertificateRequestT = Model::DeleteCertificateRequest>

void DeleteCertificateAsync (const DeleteCertificateRequestT &request, const DeleteCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DeleteConnectorOutcome DeleteConnector (const Model::DeleteConnectorRequest &request) const

template<typename DeleteConnectorRequestT = Model::DeleteConnectorRequest>

Model::DeleteConnectorOutcomeCallable DeleteConnectorCallable (const DeleteConnectorRequestT &request) const

template<typename DeleteConnectorRequestT = Model::DeleteConnectorRequest>

void DeleteConnectorAsync (const DeleteConnectorRequestT &request, const DeleteConnectorResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DeleteHostKeyOutcome DeleteHostKey (const Model::DeleteHostKeyRequest &request) const

template<typename DeleteHostKeyRequestT = Model::DeleteHostKeyRequest>

Model::DeleteHostKeyOutcomeCallable DeleteHostKeyCallable (const DeleteHostKeyRequestT &request) const

template<typename DeleteHostKeyRequestT = Model::DeleteHostKeyRequest>

void DeleteHostKeyAsync (const DeleteHostKeyRequestT &request, const DeleteHostKeyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DeleteProfileOutcome DeleteProfile (const Model::DeleteProfileRequest &request) const

template<typename DeleteProfileRequestT = Model::DeleteProfileRequest>

Model::DeleteProfileOutcomeCallable DeleteProfileCallable (const DeleteProfileRequestT &request) const

template<typename DeleteProfileRequestT = Model::DeleteProfileRequest>

void DeleteProfileAsync (const DeleteProfileRequestT &request, const DeleteProfileResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DeleteServerOutcome DeleteServer (const Model::DeleteServerRequest &request) const

template<typename DeleteServerRequestT = Model::DeleteServerRequest>

Model::DeleteServerOutcomeCallable DeleteServerCallable (const DeleteServerRequestT &request) const

template<typename DeleteServerRequestT = Model::DeleteServerRequest>

void DeleteServerAsync (const DeleteServerRequestT &request, const DeleteServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DeleteSshPublicKeyOutcome DeleteSshPublicKey (const Model::DeleteSshPublicKeyRequest &request) const

template<typename DeleteSshPublicKeyRequestT = Model::DeleteSshPublicKeyRequest>

Model::DeleteSshPublicKeyOutcomeCallable DeleteSshPublicKeyCallable (const DeleteSshPublicKeyRequestT &request) const

template<typename DeleteSshPublicKeyRequestT = Model::DeleteSshPublicKeyRequest>

void DeleteSshPublicKeyAsync (const DeleteSshPublicKeyRequestT &request, const DeleteSshPublicKeyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DeleteUserOutcome DeleteUser (const Model::DeleteUserRequest &request) const

template<typename DeleteUserRequestT = Model::DeleteUserRequest>

Model::DeleteUserOutcomeCallable DeleteUserCallable (const DeleteUserRequestT &request) const

template<typename DeleteUserRequestT = Model::DeleteUserRequest>

void DeleteUserAsync (const DeleteUserRequestT &request, const DeleteUserResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DeleteWorkflowOutcome DeleteWorkflow (const Model::DeleteWorkflowRequest &request) const

template<typename DeleteWorkflowRequestT = Model::DeleteWorkflowRequest>

Model::DeleteWorkflowOutcomeCallable DeleteWorkflowCallable (const DeleteWorkflowRequestT &request) const

template<typename DeleteWorkflowRequestT = Model::DeleteWorkflowRequest>

void DeleteWorkflowAsync (const DeleteWorkflowRequestT &request, const DeleteWorkflowResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeAccessOutcome DescribeAccess (const Model::DescribeAccessRequest &request) const

template<typename DescribeAccessRequestT = Model::DescribeAccessRequest>

Model::DescribeAccessOutcomeCallable DescribeAccessCallable (const DescribeAccessRequestT &request) const

template<typename DescribeAccessRequestT = Model::DescribeAccessRequest>

void DescribeAccessAsync (const DescribeAccessRequestT &request, const DescribeAccessResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeAgreementOutcome DescribeAgreement (const Model::DescribeAgreementRequest &request) const

template<typename DescribeAgreementRequestT = Model::DescribeAgreementRequest>

Model::DescribeAgreementOutcomeCallable DescribeAgreementCallable (const DescribeAgreementRequestT &request) const

template<typename DescribeAgreementRequestT = Model::DescribeAgreementRequest>

void DescribeAgreementAsync (const DescribeAgreementRequestT &request, const DescribeAgreementResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeCertificateOutcome DescribeCertificate (const Model::DescribeCertificateRequest &request) const

template<typename DescribeCertificateRequestT = Model::DescribeCertificateRequest>

Model::DescribeCertificateOutcomeCallable DescribeCertificateCallable (const DescribeCertificateRequestT &request) const

template<typename DescribeCertificateRequestT = Model::DescribeCertificateRequest>

void DescribeCertificateAsync (const DescribeCertificateRequestT &request, const DescribeCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeConnectorOutcome DescribeConnector (const Model::DescribeConnectorRequest &request) const

template<typename DescribeConnectorRequestT = Model::DescribeConnectorRequest>

Model::DescribeConnectorOutcomeCallable DescribeConnectorCallable (const DescribeConnectorRequestT &request) const

template<typename DescribeConnectorRequestT = Model::DescribeConnectorRequest>

void DescribeConnectorAsync (const DescribeConnectorRequestT &request, const DescribeConnectorResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeExecutionOutcome DescribeExecution (const Model::DescribeExecutionRequest &request) const

template<typename DescribeExecutionRequestT = Model::DescribeExecutionRequest>

Model::DescribeExecutionOutcomeCallable DescribeExecutionCallable (const DescribeExecutionRequestT &request) const

template<typename DescribeExecutionRequestT = Model::DescribeExecutionRequest>

void DescribeExecutionAsync (const DescribeExecutionRequestT &request, const DescribeExecutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeHostKeyOutcome DescribeHostKey (const Model::DescribeHostKeyRequest &request) const

template<typename DescribeHostKeyRequestT = Model::DescribeHostKeyRequest>

Model::DescribeHostKeyOutcomeCallable DescribeHostKeyCallable (const DescribeHostKeyRequestT &request) const

template<typename DescribeHostKeyRequestT = Model::DescribeHostKeyRequest>

void DescribeHostKeyAsync (const DescribeHostKeyRequestT &request, const DescribeHostKeyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeProfileOutcome DescribeProfile (const Model::DescribeProfileRequest &request) const

template<typename DescribeProfileRequestT = Model::DescribeProfileRequest>

Model::DescribeProfileOutcomeCallable DescribeProfileCallable (const DescribeProfileRequestT &request) const

template<typename DescribeProfileRequestT = Model::DescribeProfileRequest>

void DescribeProfileAsync (const DescribeProfileRequestT &request, const DescribeProfileResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeSecurityPolicyOutcome DescribeSecurityPolicy (const Model::DescribeSecurityPolicyRequest &request) const

template<typename DescribeSecurityPolicyRequestT = Model::DescribeSecurityPolicyRequest>

Model::DescribeSecurityPolicyOutcomeCallable DescribeSecurityPolicyCallable (const DescribeSecurityPolicyRequestT &request) const

template<typename DescribeSecurityPolicyRequestT = Model::DescribeSecurityPolicyRequest>

void DescribeSecurityPolicyAsync (const DescribeSecurityPolicyRequestT &request, const DescribeSecurityPolicyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeServerOutcome DescribeServer (const Model::DescribeServerRequest &request) const

template<typename DescribeServerRequestT = Model::DescribeServerRequest>

Model::DescribeServerOutcomeCallable DescribeServerCallable (const DescribeServerRequestT &request) const

template<typename DescribeServerRequestT = Model::DescribeServerRequest>

void DescribeServerAsync (const DescribeServerRequestT &request, const DescribeServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeUserOutcome DescribeUser (const Model::DescribeUserRequest &request) const

template<typename DescribeUserRequestT = Model::DescribeUserRequest>

Model::DescribeUserOutcomeCallable DescribeUserCallable (const DescribeUserRequestT &request) const

template<typename DescribeUserRequestT = Model::DescribeUserRequest>

void DescribeUserAsync (const DescribeUserRequestT &request, const DescribeUserResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeWorkflowOutcome DescribeWorkflow (const Model::DescribeWorkflowRequest &request) const

template<typename DescribeWorkflowRequestT = Model::DescribeWorkflowRequest>

Model::DescribeWorkflowOutcomeCallable DescribeWorkflowCallable (const DescribeWorkflowRequestT &request) const

template<typename DescribeWorkflowRequestT = Model::DescribeWorkflowRequest>

void DescribeWorkflowAsync (const DescribeWorkflowRequestT &request, const DescribeWorkflowResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ImportCertificateOutcome ImportCertificate (const Model::ImportCertificateRequest &request) const

template<typename ImportCertificateRequestT = Model::ImportCertificateRequest>

Model::ImportCertificateOutcomeCallable ImportCertificateCallable (const ImportCertificateRequestT &request) const

template<typename ImportCertificateRequestT = Model::ImportCertificateRequest>

void ImportCertificateAsync (const ImportCertificateRequestT &request, const ImportCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ImportHostKeyOutcome ImportHostKey (const Model::ImportHostKeyRequest &request) const

template<typename ImportHostKeyRequestT = Model::ImportHostKeyRequest>

Model::ImportHostKeyOutcomeCallable ImportHostKeyCallable (const ImportHostKeyRequestT &request) const

template<typename ImportHostKeyRequestT = Model::ImportHostKeyRequest>

void ImportHostKeyAsync (const ImportHostKeyRequestT &request, const ImportHostKeyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ImportSshPublicKeyOutcome ImportSshPublicKey (const Model::ImportSshPublicKeyRequest &request) const

template<typename ImportSshPublicKeyRequestT = Model::ImportSshPublicKeyRequest>

Model::ImportSshPublicKeyOutcomeCallable ImportSshPublicKeyCallable (const ImportSshPublicKeyRequestT &request) const

template<typename ImportSshPublicKeyRequestT = Model::ImportSshPublicKeyRequest>

void ImportSshPublicKeyAsync (const ImportSshPublicKeyRequestT &request, const ImportSshPublicKeyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ListAccessesOutcome ListAccesses (const Model::ListAccessesRequest &request) const

template<typename ListAccessesRequestT = Model::ListAccessesRequest>

Model::ListAccessesOutcomeCallable ListAccessesCallable (const ListAccessesRequestT &request) const

template<typename ListAccessesRequestT = Model::ListAccessesRequest>

void ListAccessesAsync (const ListAccessesRequestT &request, const ListAccessesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ListAgreementsOutcome ListAgreements (const Model::ListAgreementsRequest &request) const

template<typename ListAgreementsRequestT = Model::ListAgreementsRequest>

Model::ListAgreementsOutcomeCallable ListAgreementsCallable (const ListAgreementsRequestT &request) const

template<typename ListAgreementsRequestT = Model::ListAgreementsRequest>

void ListAgreementsAsync (const ListAgreementsRequestT &request, const ListAgreementsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ListCertificatesOutcome ListCertificates (const Model::ListCertificatesRequest &request={}) const

template<typename ListCertificatesRequestT = Model::ListCertificatesRequest>

Model::ListCertificatesOutcomeCallable ListCertificatesCallable (const ListCertificatesRequestT &request={}) const

template<typename ListCertificatesRequestT = Model::ListCertificatesRequest>

void ListCertificatesAsync (const ListCertificatesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListCertificatesRequestT &request={}) const

virtual Model::ListConnectorsOutcome ListConnectors (const Model::ListConnectorsRequest &request={}) const

template<typename ListConnectorsRequestT = Model::ListConnectorsRequest>

Model::ListConnectorsOutcomeCallable ListConnectorsCallable (const ListConnectorsRequestT &request={}) const

template<typename ListConnectorsRequestT = Model::ListConnectorsRequest>

void ListConnectorsAsync (const ListConnectorsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListConnectorsRequestT &request={}) const

virtual Model::ListExecutionsOutcome ListExecutions (const Model::ListExecutionsRequest &request) const

template<typename ListExecutionsRequestT = Model::ListExecutionsRequest>

Model::ListExecutionsOutcomeCallable ListExecutionsCallable (const ListExecutionsRequestT &request) const

template<typename ListExecutionsRequestT = Model::ListExecutionsRequest>

void ListExecutionsAsync (const ListExecutionsRequestT &request, const ListExecutionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ListFileTransferResultsOutcome ListFileTransferResults (const Model::ListFileTransferResultsRequest &request) const

template<typename ListFileTransferResultsRequestT = Model::ListFileTransferResultsRequest>

Model::ListFileTransferResultsOutcomeCallable ListFileTransferResultsCallable (const ListFileTransferResultsRequestT &request) const

template<typename ListFileTransferResultsRequestT = Model::ListFileTransferResultsRequest>

void ListFileTransferResultsAsync (const ListFileTransferResultsRequestT &request, const ListFileTransferResultsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ListHostKeysOutcome ListHostKeys (const Model::ListHostKeysRequest &request) const

template<typename ListHostKeysRequestT = Model::ListHostKeysRequest>

Model::ListHostKeysOutcomeCallable ListHostKeysCallable (const ListHostKeysRequestT &request) const

template<typename ListHostKeysRequestT = Model::ListHostKeysRequest>

void ListHostKeysAsync (const ListHostKeysRequestT &request, const ListHostKeysResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ListProfilesOutcome ListProfiles (const Model::ListProfilesRequest &request={}) const

template<typename ListProfilesRequestT = Model::ListProfilesRequest>

Model::ListProfilesOutcomeCallable ListProfilesCallable (const ListProfilesRequestT &request={}) const

template<typename ListProfilesRequestT = Model::ListProfilesRequest>

void ListProfilesAsync (const ListProfilesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListProfilesRequestT &request={}) const

virtual Model::ListSecurityPoliciesOutcome ListSecurityPolicies (const Model::ListSecurityPoliciesRequest &request={}) const

template<typename ListSecurityPoliciesRequestT = Model::ListSecurityPoliciesRequest>

Model::ListSecurityPoliciesOutcomeCallable ListSecurityPoliciesCallable (const ListSecurityPoliciesRequestT &request={}) const

template<typename ListSecurityPoliciesRequestT = Model::ListSecurityPoliciesRequest>

void ListSecurityPoliciesAsync (const ListSecurityPoliciesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListSecurityPoliciesRequestT &request={}) const

virtual Model::ListServersOutcome ListServers (const Model::ListServersRequest &request={}) const

template<typename ListServersRequestT = Model::ListServersRequest>

Model::ListServersOutcomeCallable ListServersCallable (const ListServersRequestT &request={}) const

template<typename ListServersRequestT = Model::ListServersRequest>

void ListServersAsync (const ListServersResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListServersRequestT &request={}) const

virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const ListTagsForResourceRequestT &request) const

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void ListTagsForResourceAsync (const ListTagsForResourceRequestT &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ListUsersOutcome ListUsers (const Model::ListUsersRequest &request) const

template<typename ListUsersRequestT = Model::ListUsersRequest>

Model::ListUsersOutcomeCallable ListUsersCallable (const ListUsersRequestT &request) const

template<typename ListUsersRequestT = Model::ListUsersRequest>

void ListUsersAsync (const ListUsersRequestT &request, const ListUsersResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ListWorkflowsOutcome ListWorkflows (const Model::ListWorkflowsRequest &request={}) const

template<typename ListWorkflowsRequestT = Model::ListWorkflowsRequest>

Model::ListWorkflowsOutcomeCallable ListWorkflowsCallable (const ListWorkflowsRequestT &request={}) const

template<typename ListWorkflowsRequestT = Model::ListWorkflowsRequest>

void ListWorkflowsAsync (const ListWorkflowsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListWorkflowsRequestT &request={}) const

virtual Model::SendWorkflowStepStateOutcome SendWorkflowStepState (const Model::SendWorkflowStepStateRequest &request) const

template<typename SendWorkflowStepStateRequestT = Model::SendWorkflowStepStateRequest>

Model::SendWorkflowStepStateOutcomeCallable SendWorkflowStepStateCallable (const SendWorkflowStepStateRequestT &request) const

template<typename SendWorkflowStepStateRequestT = Model::SendWorkflowStepStateRequest>

void SendWorkflowStepStateAsync (const SendWorkflowStepStateRequestT &request, const SendWorkflowStepStateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::StartDirectoryListingOutcome StartDirectoryListing (const Model::StartDirectoryListingRequest &request) const

template<typename StartDirectoryListingRequestT = Model::StartDirectoryListingRequest>

Model::StartDirectoryListingOutcomeCallable StartDirectoryListingCallable (const StartDirectoryListingRequestT &request) const

template<typename StartDirectoryListingRequestT = Model::StartDirectoryListingRequest>

void StartDirectoryListingAsync (const StartDirectoryListingRequestT &request, const StartDirectoryListingResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::StartFileTransferOutcome StartFileTransfer (const Model::StartFileTransferRequest &request) const

template<typename StartFileTransferRequestT = Model::StartFileTransferRequest>

Model::StartFileTransferOutcomeCallable StartFileTransferCallable (const StartFileTransferRequestT &request) const

template<typename StartFileTransferRequestT = Model::StartFileTransferRequest>

void StartFileTransferAsync (const StartFileTransferRequestT &request, const StartFileTransferResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::StartServerOutcome StartServer (const Model::StartServerRequest &request) const

template<typename StartServerRequestT = Model::StartServerRequest>

Model::StartServerOutcomeCallable StartServerCallable (const StartServerRequestT &request) const

template<typename StartServerRequestT = Model::StartServerRequest>

void StartServerAsync (const StartServerRequestT &request, const StartServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::StopServerOutcome StopServer (const Model::StopServerRequest &request) const

template<typename StopServerRequestT = Model::StopServerRequest>

Model::StopServerOutcomeCallable StopServerCallable (const StopServerRequestT &request) const

template<typename StopServerRequestT = Model::StopServerRequest>

void StopServerAsync (const StopServerRequestT &request, const StopServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable TagResourceCallable (const TagResourceRequestT &request) const

template<typename TagResourceRequestT = Model::TagResourceRequest>

void TagResourceAsync (const TagResourceRequestT &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::TestConnectionOutcome TestConnection (const Model::TestConnectionRequest &request) const

template<typename TestConnectionRequestT = Model::TestConnectionRequest>

Model::TestConnectionOutcomeCallable TestConnectionCallable (const TestConnectionRequestT &request) const

template<typename TestConnectionRequestT = Model::TestConnectionRequest>

void TestConnectionAsync (const TestConnectionRequestT &request, const TestConnectionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::TestIdentityProviderOutcome TestIdentityProvider (const Model::TestIdentityProviderRequest &request) const

template<typename TestIdentityProviderRequestT = Model::TestIdentityProviderRequest>

Model::TestIdentityProviderOutcomeCallable TestIdentityProviderCallable (const TestIdentityProviderRequestT &request) const

template<typename TestIdentityProviderRequestT = Model::TestIdentityProviderRequest>

void TestIdentityProviderAsync (const TestIdentityProviderRequestT &request, const TestIdentityProviderResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable UntagResourceCallable (const UntagResourceRequestT &request) const

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void UntagResourceAsync (const UntagResourceRequestT &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::UpdateAccessOutcome UpdateAccess (const Model::UpdateAccessRequest &request) const

template<typename UpdateAccessRequestT = Model::UpdateAccessRequest>

Model::UpdateAccessOutcomeCallable UpdateAccessCallable (const UpdateAccessRequestT &request) const

template<typename UpdateAccessRequestT = Model::UpdateAccessRequest>

void UpdateAccessAsync (const UpdateAccessRequestT &request, const UpdateAccessResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::UpdateAgreementOutcome UpdateAgreement (const Model::UpdateAgreementRequest &request) const

template<typename UpdateAgreementRequestT = Model::UpdateAgreementRequest>

Model::UpdateAgreementOutcomeCallable UpdateAgreementCallable (const UpdateAgreementRequestT &request) const

template<typename UpdateAgreementRequestT = Model::UpdateAgreementRequest>

void UpdateAgreementAsync (const UpdateAgreementRequestT &request, const UpdateAgreementResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::UpdateCertificateOutcome UpdateCertificate (const Model::UpdateCertificateRequest &request) const

template<typename UpdateCertificateRequestT = Model::UpdateCertificateRequest>

Model::UpdateCertificateOutcomeCallable UpdateCertificateCallable (const UpdateCertificateRequestT &request) const

template<typename UpdateCertificateRequestT = Model::UpdateCertificateRequest>

void UpdateCertificateAsync (const UpdateCertificateRequestT &request, const UpdateCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::UpdateConnectorOutcome UpdateConnector (const Model::UpdateConnectorRequest &request) const

template<typename UpdateConnectorRequestT = Model::UpdateConnectorRequest>

Model::UpdateConnectorOutcomeCallable UpdateConnectorCallable (const UpdateConnectorRequestT &request) const

template<typename UpdateConnectorRequestT = Model::UpdateConnectorRequest>

void UpdateConnectorAsync (const UpdateConnectorRequestT &request, const UpdateConnectorResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::UpdateHostKeyOutcome UpdateHostKey (const Model::UpdateHostKeyRequest &request) const

template<typename UpdateHostKeyRequestT = Model::UpdateHostKeyRequest>

Model::UpdateHostKeyOutcomeCallable UpdateHostKeyCallable (const UpdateHostKeyRequestT &request) const

template<typename UpdateHostKeyRequestT = Model::UpdateHostKeyRequest>

void UpdateHostKeyAsync (const UpdateHostKeyRequestT &request, const UpdateHostKeyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::UpdateProfileOutcome UpdateProfile (const Model::UpdateProfileRequest &request) const

template<typename UpdateProfileRequestT = Model::UpdateProfileRequest>

Model::UpdateProfileOutcomeCallable UpdateProfileCallable (const UpdateProfileRequestT &request) const

template<typename UpdateProfileRequestT = Model::UpdateProfileRequest>

void UpdateProfileAsync (const UpdateProfileRequestT &request, const UpdateProfileResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::UpdateServerOutcome UpdateServer (const Model::UpdateServerRequest &request) const

template<typename UpdateServerRequestT = Model::UpdateServerRequest>

Model::UpdateServerOutcomeCallable UpdateServerCallable (const UpdateServerRequestT &request) const

template<typename UpdateServerRequestT = Model::UpdateServerRequest>

void UpdateServerAsync (const UpdateServerRequestT &request, const UpdateServerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::UpdateUserOutcome UpdateUser (const Model::UpdateUserRequest &request) const

template<typename UpdateUserRequestT = Model::UpdateUserRequest>

Model::UpdateUserOutcomeCallable UpdateUserCallable (const UpdateUserRequestT &request) const

template<typename UpdateUserRequestT = Model::UpdateUserRequest>

void UpdateUserAsync (const UpdateUserRequestT &request, const UpdateUserResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

void OverrideEndpoint (const Aws::String &endpoint)

std::shared_ptr< TransferEndpointProviderBase > & accessEndpointProvider ()

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 (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

Aws::String GeneratePresignedUrl (const Aws::Endpoint::AWSEndpoint &endpoint, Aws::Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const Aws::Http::HeaderValueCollection &customizedHeaders={}, uint64_t expirationInSeconds=0, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const 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 std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

const std::shared_ptr< Aws::Http::HttpClient > & GetHttpClient () const

void DisableRequestProcessing ()

void EnableRequestProcessing ()

virtual const char * GetServiceClientName () const

virtual void SetServiceClientName (const Aws::String &name)

void AppendToUserAgent (const Aws::String &valueToAppend)

Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< TransferClient >

ClientWithAsyncTemplateMethods ()

ClientWithAsyncTemplateMethods (const ClientWithAsyncTemplateMethods &other)

ClientWithAsyncTemplateMethods & operator= (const ClientWithAsyncTemplateMethods &other)

virtual ~ClientWithAsyncTemplateMethods ()

void SubmitAsync (OperationFuncT operationFunc, const RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

void SubmitAsync (OperationFuncT operationFunc, RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

void SubmitAsync (OperationFuncT operationFunc, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

auto SubmitCallable (OperationFuncT operationFunc, const RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

auto SubmitCallable (OperationFuncT operationFunc, RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

auto SubmitCallable (OperationFuncT operationFunc) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)())>

Static Public Member Functions

static const char * GetServiceName ()

static const char * GetAllocationTag ()

Static Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< TransferClient >

static void ShutdownSdkClient (void *pThis, int64_t timeoutMs=-1)

Friends

class Aws::Client::ClientWithAsyncTemplateMethods< TransferClient >

Additional Inherited Members

Protected Member Functions inherited from Aws::Client::AWSJsonClient

virtual AWSError< CoreErrors > BuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override

JsonOutcome MakeRequest (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, 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::Endpoint::AWSEndpoint &endpoint, 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, 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

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, 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::AWSAuthSigner * GetSignerByName (const char *name) const

std::shared_ptr< Auth::AWSCredentialsProvider > GetCredentialsProvider () const

std::shared_ptr< Aws::Http::HttpRequest > BuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const

std::shared_ptr< Aws::Http::HttpResponse > MakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const

Static Protected Member Functions inherited from Aws::Client::AWSClient

static void AppendRecursionDetectionHeader (std::shared_ptr< Aws::Http::HttpRequest > ioRequest)

static CoreErrors GuessBodylessErrorType (Aws::Http::HttpResponseCode responseCode)

static bool DoesResponseGenerateError (const std::shared_ptr< Aws::Http::HttpResponse > &response)

Protected Attributes inherited from Aws::Client::AWSClient

Aws::String m_region

std::shared_ptr< smithy::components::tracing::TelemetryProvider > m_telemetryProvider

std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > m_signerProvider

Protected Attributes inherited from Aws::Client::ClientWithAsyncTemplateMethods< TransferClient >

std::atomic< bool > m_isInitialized

std::atomic< size_t > m_operationsProcessed

std::condition_variable m_shutdownSignal

std::mutex m_shutdownMutex

Detailed Description

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) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to 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 Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.

Definition at line 32 of file TransferClient.h.

Member Typedef Documentation

◆ BASECLASS

typedef Aws::Client::AWSJsonClient Aws::Transfer::TransferClient::BASECLASS

Definition at line 35 of file TransferClient.h.

◆ ClientConfigurationType

typedef TransferClientConfiguration Aws::Transfer::TransferClient::ClientConfigurationType

Definition at line 39 of file TransferClient.h.

◆ EndpointProviderType

typedef TransferEndpointProvider Aws::Transfer::TransferClient::EndpointProviderType

Definition at line 40 of file TransferClient.h.

Constructor & Destructor Documentation

◆ TransferClient() [1/6]

Aws::Transfer::TransferClient::TransferClient ( const Aws::Transfer::TransferClientConfiguration & clientConfiguration = Aws::Transfer::TransferClientConfiguration(),

std::shared_ptr< TransferEndpointProviderBase > endpointProvider = nullptr

)

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/6]

Aws::Transfer::TransferClient::TransferClient ( const Aws::Auth::AWSCredentials & credentials,

std::shared_ptr< TransferEndpointProviderBase > endpointProvider = nullptr,

const Aws::Transfer::TransferClientConfiguration & clientConfiguration = Aws::Transfer::TransferClientConfiguration()

)

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/6]

Aws::Transfer::TransferClient::TransferClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > & credentialsProvider,

std::shared_ptr< TransferEndpointProviderBase > endpointProvider = nullptr,

const Aws::Transfer::TransferClientConfiguration & clientConfiguration = Aws::Transfer::TransferClientConfiguration()

)

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() [4/6]

Aws::Transfer::TransferClient::TransferClient ( const Aws::Client::ClientConfiguration & 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() [5/6]

Aws::Transfer::TransferClient::TransferClient ( const Aws::Auth::AWSCredentials & credentials,

const Aws::Client::ClientConfiguration & 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() [6/6]

Aws::Transfer::TransferClient::TransferClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > & credentialsProvider,

const Aws::Client::ClientConfiguration & 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

◆ accessEndpointProvider()

std::shared_ptr< TransferEndpointProviderBase > & Aws::Transfer::TransferClient::accessEndpointProvider ( )

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

◆ CreateAccessAsync()

template<typename CreateAccessRequestT = Model::CreateAccessRequest>

void Aws::Transfer::TransferClient::CreateAccessAsync ( const CreateAccessRequestT & request,

const CreateAccessResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for CreateAccess that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 115 of file TransferClient.h.

◆ CreateAccessCallable()

template<typename CreateAccessRequestT = Model::CreateAccessRequest>

Model::CreateAccessOutcomeCallable Aws::Transfer::TransferClient::CreateAccessCallable ( const CreateAccessRequestT & request) const

inline

A Callable wrapper for CreateAccess that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 106 of file TransferClient.h.

◆ CreateAgreement()

virtual Model::CreateAgreementOutcome Aws::Transfer::TransferClient::CreateAgreement ( const Model::CreateAgreementRequest & request) const

virtual

Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

◆ CreateAgreementAsync()

template<typename CreateAgreementRequestT = Model::CreateAgreementRequest>

void Aws::Transfer::TransferClient::CreateAgreementAsync ( const CreateAgreementRequestT & request,

const CreateAgreementResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for CreateAgreement that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 147 of file TransferClient.h.

◆ CreateAgreementCallable()

template<typename CreateAgreementRequestT = Model::CreateAgreementRequest>

Model::CreateAgreementOutcomeCallable Aws::Transfer::TransferClient::CreateAgreementCallable ( const CreateAgreementRequestT & request) const

inline

A Callable wrapper for CreateAgreement that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 138 of file TransferClient.h.

◆ CreateConnector()

virtual Model::CreateConnectorOutcome Aws::Transfer::TransferClient::CreateConnector ( const Model::CreateConnectorRequest & request) const

virtual

Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors.

You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

◆ CreateConnectorAsync()

template<typename CreateConnectorRequestT = Model::CreateConnectorRequest>

void Aws::Transfer::TransferClient::CreateConnectorAsync ( const CreateConnectorRequestT & request,

const CreateConnectorResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for CreateConnector that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 182 of file TransferClient.h.

◆ CreateConnectorCallable()

template<typename CreateConnectorRequestT = Model::CreateConnectorRequest>

Model::CreateConnectorOutcomeCallable Aws::Transfer::TransferClient::CreateConnectorCallable ( const CreateConnectorRequestT & request) const

inline

A Callable wrapper for CreateConnector that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 173 of file TransferClient.h.

◆ CreateProfile()

virtual Model::CreateProfileOutcome Aws::Transfer::TransferClient::CreateProfile ( const Model::CreateProfileRequest & request) const

virtual

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

◆ CreateProfileAsync()

template<typename CreateProfileRequestT = Model::CreateProfileRequest>

void Aws::Transfer::TransferClient::CreateProfileAsync ( const CreateProfileRequestT & request,

const CreateProfileResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for CreateProfile that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 208 of file TransferClient.h.

◆ CreateProfileCallable()

template<typename CreateProfileRequestT = Model::CreateProfileRequest>

Model::CreateProfileOutcomeCallable Aws::Transfer::TransferClient::CreateProfileCallable ( const CreateProfileRequestT & request) const

inline

A Callable wrapper for CreateProfile that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 199 of file TransferClient.h.

◆ 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 Amazon Web Services. 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.

◆ CreateServerAsync()

template<typename CreateServerRequestT = Model::CreateServerRequest>

void Aws::Transfer::TransferClient::CreateServerAsync ( const CreateServerResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr,

const CreateServerRequestT & request = {}

) const

inline

An Async wrapper for CreateServer that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 237 of file TransferClient.h.

◆ CreateServerCallable()

template<typename CreateServerRequestT = Model::CreateServerRequest>

Model::CreateServerOutcomeCallable Aws::Transfer::TransferClient::CreateServerCallable ( const CreateServerRequestT & request = {}) const

inline

A Callable wrapper for CreateServer that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 228 of file TransferClient.h.

◆ 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 Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.

◆ CreateUserAsync()

template<typename CreateUserRequestT = Model::CreateUserRequest>

void Aws::Transfer::TransferClient::CreateUserAsync ( const CreateUserRequestT & request,

const CreateUserResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for CreateUser that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 269 of file TransferClient.h.

◆ CreateUserCallable()

template<typename CreateUserRequestT = Model::CreateUserRequest>

Model::CreateUserOutcomeCallable Aws::Transfer::TransferClient::CreateUserCallable ( const CreateUserRequestT & request) const

inline

A Callable wrapper for CreateUser that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 260 of file TransferClient.h.

◆ CreateWorkflow()

virtual Model::CreateWorkflowOutcome Aws::Transfer::TransferClient::CreateWorkflow ( const Model::CreateWorkflowRequest & request) const

virtual

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

◆ CreateWorkflowAsync()

template<typename CreateWorkflowRequestT = Model::CreateWorkflowRequest>

void Aws::Transfer::TransferClient::CreateWorkflowAsync ( const CreateWorkflowRequestT & request,

const CreateWorkflowResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for CreateWorkflow that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 298 of file TransferClient.h.

◆ CreateWorkflowCallable()

template<typename CreateWorkflowRequestT = Model::CreateWorkflowRequest>

Model::CreateWorkflowOutcomeCallable Aws::Transfer::TransferClient::CreateWorkflowCallable ( const CreateWorkflowRequestT & request) const

inline

A Callable wrapper for CreateWorkflow that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 289 of file TransferClient.h.

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

◆ DeleteAccessAsync()

template<typename DeleteAccessRequestT = Model::DeleteAccessRequest>

void Aws::Transfer::TransferClient::DeleteAccessAsync ( const DeleteAccessRequestT & request,

const DeleteAccessResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DeleteAccess that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 324 of file TransferClient.h.

◆ DeleteAccessCallable()

template<typename DeleteAccessRequestT = Model::DeleteAccessRequest>

Model::DeleteAccessOutcomeCallable Aws::Transfer::TransferClient::DeleteAccessCallable ( const DeleteAccessRequestT & request) const

inline

A Callable wrapper for DeleteAccess that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 315 of file TransferClient.h.

◆ DeleteAgreement()

virtual Model::DeleteAgreementOutcome Aws::Transfer::TransferClient::DeleteAgreement ( const Model::DeleteAgreementRequest & request) const

virtual

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

◆ DeleteAgreementAsync()

template<typename DeleteAgreementRequestT = Model::DeleteAgreementRequest>

void Aws::Transfer::TransferClient::DeleteAgreementAsync ( const DeleteAgreementRequestT & request,

const DeleteAgreementResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DeleteAgreement that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 350 of file TransferClient.h.

◆ DeleteAgreementCallable()

template<typename DeleteAgreementRequestT = Model::DeleteAgreementRequest>

Model::DeleteAgreementOutcomeCallable Aws::Transfer::TransferClient::DeleteAgreementCallable ( const DeleteAgreementRequestT & request) const

inline

A Callable wrapper for DeleteAgreement that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 341 of file TransferClient.h.

◆ DeleteCertificate()

virtual Model::DeleteCertificateOutcome Aws::Transfer::TransferClient::DeleteCertificate ( const Model::DeleteCertificateRequest & request) const

virtual

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

◆ DeleteCertificateAsync()

template<typename DeleteCertificateRequestT = Model::DeleteCertificateRequest>

void Aws::Transfer::TransferClient::DeleteCertificateAsync ( const DeleteCertificateRequestT & request,

const DeleteCertificateResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DeleteCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 376 of file TransferClient.h.

◆ DeleteCertificateCallable()

template<typename DeleteCertificateRequestT = Model::DeleteCertificateRequest>

Model::DeleteCertificateOutcomeCallable Aws::Transfer::TransferClient::DeleteCertificateCallable ( const DeleteCertificateRequestT & request) const

inline

A Callable wrapper for DeleteCertificate that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 367 of file TransferClient.h.

◆ DeleteConnector()

virtual Model::DeleteConnectorOutcome Aws::Transfer::TransferClient::DeleteConnector ( const Model::DeleteConnectorRequest & request) const

virtual

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

◆ DeleteConnectorAsync()

template<typename DeleteConnectorRequestT = Model::DeleteConnectorRequest>

void Aws::Transfer::TransferClient::DeleteConnectorAsync ( const DeleteConnectorRequestT & request,

const DeleteConnectorResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DeleteConnector that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 402 of file TransferClient.h.

◆ DeleteConnectorCallable()

template<typename DeleteConnectorRequestT = Model::DeleteConnectorRequest>

Model::DeleteConnectorOutcomeCallable Aws::Transfer::TransferClient::DeleteConnectorCallable ( const DeleteConnectorRequestT & request) const

inline

A Callable wrapper for DeleteConnector that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 393 of file TransferClient.h.

◆ DeleteHostKey()

virtual Model::DeleteHostKeyOutcome Aws::Transfer::TransferClient::DeleteHostKey ( const Model::DeleteHostKeyRequest & request) const

virtual

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

◆ DeleteHostKeyAsync()

template<typename DeleteHostKeyRequestT = Model::DeleteHostKeyRequest>

void Aws::Transfer::TransferClient::DeleteHostKeyAsync ( const DeleteHostKeyRequestT & request,

const DeleteHostKeyResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DeleteHostKey that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 428 of file TransferClient.h.

◆ DeleteHostKeyCallable()

template<typename DeleteHostKeyRequestT = Model::DeleteHostKeyRequest>

Model::DeleteHostKeyOutcomeCallable Aws::Transfer::TransferClient::DeleteHostKeyCallable ( const DeleteHostKeyRequestT & request) const

inline

A Callable wrapper for DeleteHostKey that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 419 of file TransferClient.h.

◆ DeleteProfile()

virtual Model::DeleteProfileOutcome Aws::Transfer::TransferClient::DeleteProfile ( const Model::DeleteProfileRequest & request) const

virtual

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

◆ DeleteProfileAsync()

template<typename DeleteProfileRequestT = Model::DeleteProfileRequest>

void Aws::Transfer::TransferClient::DeleteProfileAsync ( const DeleteProfileRequestT & request,

const DeleteProfileResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DeleteProfile that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 454 of file TransferClient.h.

◆ DeleteProfileCallable()

template<typename DeleteProfileRequestT = Model::DeleteProfileRequest>

Model::DeleteProfileOutcomeCallable Aws::Transfer::TransferClient::DeleteProfileCallable ( const DeleteProfileRequestT & request) const

inline

A Callable wrapper for DeleteProfile that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 445 of file TransferClient.h.

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

◆ DeleteServerAsync()

template<typename DeleteServerRequestT = Model::DeleteServerRequest>

void Aws::Transfer::TransferClient::DeleteServerAsync ( const DeleteServerRequestT & request,

const DeleteServerResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DeleteServer that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 480 of file TransferClient.h.

◆ DeleteServerCallable()

template<typename DeleteServerRequestT = Model::DeleteServerRequest>

Model::DeleteServerOutcomeCallable Aws::Transfer::TransferClient::DeleteServerCallable ( const DeleteServerRequestT & request) const

inline

A Callable wrapper for DeleteServer that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 471 of file TransferClient.h.

◆ DeleteSshPublicKey()

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

virtual

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

◆ DeleteSshPublicKeyAsync()

template<typename DeleteSshPublicKeyRequestT = Model::DeleteSshPublicKeyRequest>

void Aws::Transfer::TransferClient::DeleteSshPublicKeyAsync ( const DeleteSshPublicKeyRequestT & request,

const DeleteSshPublicKeyResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DeleteSshPublicKey that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 505 of file TransferClient.h.

◆ DeleteSshPublicKeyCallable()

template<typename DeleteSshPublicKeyRequestT = Model::DeleteSshPublicKeyRequest>

Model::DeleteSshPublicKeyOutcomeCallable Aws::Transfer::TransferClient::DeleteSshPublicKeyCallable ( const DeleteSshPublicKeyRequestT & request) const

inline

A Callable wrapper for DeleteSshPublicKey that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 496 of file TransferClient.h.

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

◆ DeleteUserAsync()

template<typename DeleteUserRequestT = Model::DeleteUserRequest>

void Aws::Transfer::TransferClient::DeleteUserAsync ( const DeleteUserRequestT & request,

const DeleteUserResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DeleteUser that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 533 of file TransferClient.h.

◆ DeleteUserCallable()

template<typename DeleteUserRequestT = Model::DeleteUserRequest>

Model::DeleteUserOutcomeCallable Aws::Transfer::TransferClient::DeleteUserCallable ( const DeleteUserRequestT & request) const

inline

A Callable wrapper for DeleteUser that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 524 of file TransferClient.h.

◆ DeleteWorkflow()

virtual Model::DeleteWorkflowOutcome Aws::Transfer::TransferClient::DeleteWorkflow ( const Model::DeleteWorkflowRequest & request) const

virtual

Deletes the specified workflow.

◆ DeleteWorkflowAsync()

template<typename DeleteWorkflowRequestT = Model::DeleteWorkflowRequest>

void Aws::Transfer::TransferClient::DeleteWorkflowAsync ( const DeleteWorkflowRequestT & request,

const DeleteWorkflowResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DeleteWorkflow that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 558 of file TransferClient.h.

◆ DeleteWorkflowCallable()

template<typename DeleteWorkflowRequestT = Model::DeleteWorkflowRequest>

Model::DeleteWorkflowOutcomeCallable Aws::Transfer::TransferClient::DeleteWorkflowCallable ( const DeleteWorkflowRequestT & request) const

inline

A Callable wrapper for DeleteWorkflow that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 549 of file TransferClient.h.

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

◆ DescribeAccessAsync()

template<typename DescribeAccessRequestT = Model::DescribeAccessRequest>

void Aws::Transfer::TransferClient::DescribeAccessAsync ( const DescribeAccessRequestT & request,

const DescribeAccessResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeAccess that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 587 of file TransferClient.h.

◆ DescribeAccessCallable()

template<typename DescribeAccessRequestT = Model::DescribeAccessRequest>

Model::DescribeAccessOutcomeCallable Aws::Transfer::TransferClient::DescribeAccessCallable ( const DescribeAccessRequestT & request) const

inline

A Callable wrapper for DescribeAccess that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 578 of file TransferClient.h.

◆ DescribeAgreement()

virtual Model::DescribeAgreementOutcome Aws::Transfer::TransferClient::DescribeAgreement ( const Model::DescribeAgreementRequest & request) const

virtual

Describes the agreement that's identified by the AgreementId.

◆ DescribeAgreementAsync()

template<typename DescribeAgreementRequestT = Model::DescribeAgreementRequest>

void Aws::Transfer::TransferClient::DescribeAgreementAsync ( const DescribeAgreementRequestT & request,

const DescribeAgreementResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeAgreement that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 613 of file TransferClient.h.

◆ DescribeAgreementCallable()

template<typename DescribeAgreementRequestT = Model::DescribeAgreementRequest>

Model::DescribeAgreementOutcomeCallable Aws::Transfer::TransferClient::DescribeAgreementCallable ( const DescribeAgreementRequestT & request) const

inline

A Callable wrapper for DescribeAgreement that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 604 of file TransferClient.h.

◆ DescribeCertificate()

virtual Model::DescribeCertificateOutcome Aws::Transfer::TransferClient::DescribeCertificate ( const Model::DescribeCertificateRequest & request) const

virtual

Describes the certificate that's identified by the CertificateId.

◆ DescribeCertificateAsync()

template<typename DescribeCertificateRequestT = Model::DescribeCertificateRequest>

void Aws::Transfer::TransferClient::DescribeCertificateAsync ( const DescribeCertificateRequestT & request,

const DescribeCertificateResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 639 of file TransferClient.h.

◆ DescribeCertificateCallable()

template<typename DescribeCertificateRequestT = Model::DescribeCertificateRequest>

Model::DescribeCertificateOutcomeCallable Aws::Transfer::TransferClient::DescribeCertificateCallable ( const DescribeCertificateRequestT & request) const

inline

A Callable wrapper for DescribeCertificate that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 630 of file TransferClient.h.

◆ DescribeConnector()

virtual Model::DescribeConnectorOutcome Aws::Transfer::TransferClient::DescribeConnector ( const Model::DescribeConnectorRequest & request) const

virtual

Describes the connector that's identified by the ConnectorId.

◆ DescribeConnectorAsync()

template<typename DescribeConnectorRequestT = Model::DescribeConnectorRequest>

void Aws::Transfer::TransferClient::DescribeConnectorAsync ( const DescribeConnectorRequestT & request,

const DescribeConnectorResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeConnector that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 665 of file TransferClient.h.

◆ DescribeConnectorCallable()

template<typename DescribeConnectorRequestT = Model::DescribeConnectorRequest>

Model::DescribeConnectorOutcomeCallable Aws::Transfer::TransferClient::DescribeConnectorCallable ( const DescribeConnectorRequestT & request) const

inline

A Callable wrapper for DescribeConnector that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 656 of file TransferClient.h.

◆ DescribeExecution()

virtual Model::DescribeExecutionOutcome Aws::Transfer::TransferClient::DescribeExecution ( const Model::DescribeExecutionRequest & request) const

virtual

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

This API call only returns details for in-progress workflows.

If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.

◆ DescribeExecutionAsync()

template<typename DescribeExecutionRequestT = Model::DescribeExecutionRequest>

void Aws::Transfer::TransferClient::DescribeExecutionAsync ( const DescribeExecutionRequestT & request,

const DescribeExecutionResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeExecution that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 695 of file TransferClient.h.

◆ DescribeExecutionCallable()

template<typename DescribeExecutionRequestT = Model::DescribeExecutionRequest>

Model::DescribeExecutionOutcomeCallable Aws::Transfer::TransferClient::DescribeExecutionCallable ( const DescribeExecutionRequestT & request) const

inline

A Callable wrapper for DescribeExecution that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 686 of file TransferClient.h.

◆ DescribeHostKey()

virtual Model::DescribeHostKeyOutcome Aws::Transfer::TransferClient::DescribeHostKey ( const Model::DescribeHostKeyRequest & request) const

virtual

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

◆ DescribeHostKeyAsync()

template<typename DescribeHostKeyRequestT = Model::DescribeHostKeyRequest>

void Aws::Transfer::TransferClient::DescribeHostKeyAsync ( const DescribeHostKeyRequestT & request,

const DescribeHostKeyResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeHostKey that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 721 of file TransferClient.h.

◆ DescribeHostKeyCallable()

template<typename DescribeHostKeyRequestT = Model::DescribeHostKeyRequest>

Model::DescribeHostKeyOutcomeCallable Aws::Transfer::TransferClient::DescribeHostKeyCallable ( const DescribeHostKeyRequestT & request) const

inline

A Callable wrapper for DescribeHostKey that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 712 of file TransferClient.h.

◆ DescribeProfile()

virtual Model::DescribeProfileOutcome Aws::Transfer::TransferClient::DescribeProfile ( const Model::DescribeProfileRequest & request) const

virtual

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

◆ DescribeProfileAsync()

template<typename DescribeProfileRequestT = Model::DescribeProfileRequest>

void Aws::Transfer::TransferClient::DescribeProfileAsync ( const DescribeProfileRequestT & request,

const DescribeProfileResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeProfile that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 747 of file TransferClient.h.

◆ DescribeProfileCallable()

template<typename DescribeProfileRequestT = Model::DescribeProfileRequest>

Model::DescribeProfileOutcomeCallable Aws::Transfer::TransferClient::DescribeProfileCallable ( const DescribeProfileRequestT & request) const

inline

A Callable wrapper for DescribeProfile that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 738 of file TransferClient.h.

◆ DescribeSecurityPolicy()

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

virtual

Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

◆ DescribeSecurityPolicyAsync()

template<typename DescribeSecurityPolicyRequestT = Model::DescribeSecurityPolicyRequest>

void Aws::Transfer::TransferClient::DescribeSecurityPolicyAsync ( const DescribeSecurityPolicyRequestT & request,

const DescribeSecurityPolicyResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeSecurityPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 778 of file TransferClient.h.

◆ DescribeSecurityPolicyCallable()

template<typename DescribeSecurityPolicyRequestT = Model::DescribeSecurityPolicyRequest>

Model::DescribeSecurityPolicyOutcomeCallable Aws::Transfer::TransferClient::DescribeSecurityPolicyCallable ( const DescribeSecurityPolicyRequestT & request) const

inline

A Callable wrapper for DescribeSecurityPolicy that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 769 of file TransferClient.h.

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

◆ DescribeServerAsync()

template<typename DescribeServerRequestT = Model::DescribeServerRequest>

void Aws::Transfer::TransferClient::DescribeServerAsync ( const DescribeServerRequestT & request,

const DescribeServerResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeServer that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 807 of file TransferClient.h.

◆ DescribeServerCallable()

template<typename DescribeServerRequestT = Model::DescribeServerRequest>

Model::DescribeServerOutcomeCallable Aws::Transfer::TransferClient::DescribeServerCallable ( const DescribeServerRequestT & request) const

inline

A Callable wrapper for DescribeServer that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 798 of file TransferClient.h.

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

◆ DescribeUserAsync()

template<typename DescribeUserRequestT = Model::DescribeUserRequest>

void Aws::Transfer::TransferClient::DescribeUserAsync ( const DescribeUserRequestT & request,

const DescribeUserResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeUser that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 835 of file TransferClient.h.

◆ DescribeUserCallable()

template<typename DescribeUserRequestT = Model::DescribeUserRequest>

Model::DescribeUserOutcomeCallable Aws::Transfer::TransferClient::DescribeUserCallable ( const DescribeUserRequestT & request) const

inline

A Callable wrapper for DescribeUser that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 826 of file TransferClient.h.

◆ DescribeWorkflow()

virtual Model::DescribeWorkflowOutcome Aws::Transfer::TransferClient::DescribeWorkflow ( const Model::DescribeWorkflowRequest & request) const

virtual

Describes the specified workflow.

◆ DescribeWorkflowAsync()

template<typename DescribeWorkflowRequestT = Model::DescribeWorkflowRequest>

void Aws::Transfer::TransferClient::DescribeWorkflowAsync ( const DescribeWorkflowRequestT & request,

const DescribeWorkflowResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for DescribeWorkflow that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 860 of file TransferClient.h.

◆ DescribeWorkflowCallable()

template<typename DescribeWorkflowRequestT = Model::DescribeWorkflowRequest>

Model::DescribeWorkflowOutcomeCallable Aws::Transfer::TransferClient::DescribeWorkflowCallable ( const DescribeWorkflowRequestT & request) const

inline

A Callable wrapper for DescribeWorkflow that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 851 of file TransferClient.h.

◆ GetAllocationTag()

static const char * Aws::Transfer::TransferClient::GetAllocationTag ( )

static

◆ GetServiceName()

static const char * Aws::Transfer::TransferClient::GetServiceName ( )

static

◆ ImportCertificate()

virtual Model::ImportCertificateOutcome Aws::Transfer::TransferClient::ImportCertificate ( const Model::ImportCertificateRequest & request) const

virtual

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

◆ ImportCertificateAsync()

template<typename ImportCertificateRequestT = Model::ImportCertificateRequest>

void Aws::Transfer::TransferClient::ImportCertificateAsync ( const ImportCertificateRequestT & request,

const ImportCertificateResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for ImportCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 886 of file TransferClient.h.

◆ ImportCertificateCallable()

template<typename ImportCertificateRequestT = Model::ImportCertificateRequest>

Model::ImportCertificateOutcomeCallable Aws::Transfer::TransferClient::ImportCertificateCallable ( const ImportCertificateRequestT & request) const

inline

A Callable wrapper for ImportCertificate that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 877 of file TransferClient.h.

◆ ImportHostKey()

virtual Model::ImportHostKeyOutcome Aws::Transfer::TransferClient::ImportHostKey ( const Model::ImportHostKeyRequest & request) const

virtual

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

◆ ImportHostKeyAsync()

template<typename ImportHostKeyRequestT = Model::ImportHostKeyRequest>

void Aws::Transfer::TransferClient::ImportHostKeyAsync ( const ImportHostKeyRequestT & request,

const ImportHostKeyResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for ImportHostKey that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 912 of file TransferClient.h.

◆ ImportHostKeyCallable()

template<typename ImportHostKeyRequestT = Model::ImportHostKeyRequest>

Model::ImportHostKeyOutcomeCallable Aws::Transfer::TransferClient::ImportHostKeyCallable ( const ImportHostKeyRequestT & request) const

inline

A Callable wrapper for ImportHostKey that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 903 of file TransferClient.h.

◆ ImportSshPublicKey()

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

virtual

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

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

◆ ImportSshPublicKeyAsync()

template<typename ImportSshPublicKeyRequestT = Model::ImportSshPublicKeyRequest>

void Aws::Transfer::TransferClient::ImportSshPublicKeyAsync ( const ImportSshPublicKeyRequestT & request,

const ImportSshPublicKeyResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for ImportSshPublicKey that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 942 of file TransferClient.h.

◆ ImportSshPublicKeyCallable()

template<typename ImportSshPublicKeyRequestT = Model::ImportSshPublicKeyRequest>

Model::ImportSshPublicKeyOutcomeCallable Aws::Transfer::TransferClient::ImportSshPublicKeyCallable ( const ImportSshPublicKeyRequestT & request) const

inline

A Callable wrapper for ImportSshPublicKey that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 933 of file TransferClient.h.

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

◆ ListAccessesAsync()

template<typename ListAccessesRequestT = Model::ListAccessesRequest>

void Aws::Transfer::TransferClient::ListAccessesAsync ( const ListAccessesRequestT & request,

const ListAccessesResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for ListAccesses that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 968 of file TransferClient.h.

◆ ListAccessesCallable()

template<typename ListAccessesRequestT = Model::ListAccessesRequest>

Model::ListAccessesOutcomeCallable Aws::Transfer::TransferClient::ListAccessesCallable ( const ListAccessesRequestT & request) const

inline

A Callable wrapper for ListAccesses that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 959 of file TransferClient.h.

◆ ListAgreements()

virtual Model::ListAgreementsOutcome Aws::Transfer::TransferClient::ListAgreements ( const Model::ListAgreementsRequest & request) const

virtual

Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.

◆ ListAgreementsAsync()

template<typename ListAgreementsRequestT = Model::ListAgreementsRequest>

void Aws::Transfer::TransferClient::ListAgreementsAsync ( const ListAgreementsRequestT & request,

const ListAgreementsResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for ListAgreements that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 998 of file TransferClient.h.

◆ ListAgreementsCallable()

template<typename ListAgreementsRequestT = Model::ListAgreementsRequest>

Model::ListAgreementsOutcomeCallable Aws::Transfer::TransferClient::ListAgreementsCallable ( const ListAgreementsRequestT & request) const

inline

A Callable wrapper for ListAgreements that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 989 of file TransferClient.h.

◆ ListCertificates()

virtual Model::ListCertificatesOutcome Aws::Transfer::TransferClient::ListCertificates ( const Model::ListCertificatesRequest & request = {}) const

virtual

Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.

◆ ListCertificatesAsync()

template<typename ListCertificatesRequestT = Model::ListCertificatesRequest>

void Aws::Transfer::TransferClient::ListCertificatesAsync ( const ListCertificatesResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr,

const ListCertificatesRequestT & request = {}

) const

inline

An Async wrapper for ListCertificates that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1028 of file TransferClient.h.

◆ ListCertificatesCallable()

template<typename ListCertificatesRequestT = Model::ListCertificatesRequest>

Model::ListCertificatesOutcomeCallable Aws::Transfer::TransferClient::ListCertificatesCallable ( const ListCertificatesRequestT & request = {}) const

inline

A Callable wrapper for ListCertificates that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1019 of file TransferClient.h.

◆ ListConnectors()

virtual Model::ListConnectorsOutcome Aws::Transfer::TransferClient::ListConnectors ( const Model::ListConnectorsRequest & request = {}) const

virtual

Lists the connectors for the specified Region.

◆ ListConnectorsAsync()

template<typename ListConnectorsRequestT = Model::ListConnectorsRequest>

void Aws::Transfer::TransferClient::ListConnectorsAsync ( const ListConnectorsResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr,

const ListConnectorsRequestT & request = {}

) const

inline

An Async wrapper for ListConnectors that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1053 of file TransferClient.h.

◆ ListConnectorsCallable()

template<typename ListConnectorsRequestT = Model::ListConnectorsRequest>

Model::ListConnectorsOutcomeCallable Aws::Transfer::TransferClient::ListConnectorsCallable ( const ListConnectorsRequestT & request = {}) const

inline

A Callable wrapper for ListConnectors that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1044 of file TransferClient.h.

◆ ListExecutions()

virtual Model::ListExecutionsOutcome Aws::Transfer::TransferClient::ListExecutions ( const Model::ListExecutionsRequest & request) const

virtual

Lists all in-progress executions for the specified workflow.

If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

◆ ListExecutionsAsync()

template<typename ListExecutionsRequestT = Model::ListExecutionsRequest>

void Aws::Transfer::TransferClient::ListExecutionsAsync ( const ListExecutionsRequestT & request,

const ListExecutionsResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for ListExecutions that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1080 of file TransferClient.h.

◆ ListExecutionsCallable()

template<typename ListExecutionsRequestT = Model::ListExecutionsRequest>

Model::ListExecutionsOutcomeCallable Aws::Transfer::TransferClient::ListExecutionsCallable ( const ListExecutionsRequestT & request) const

inline

A Callable wrapper for ListExecutions that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1071 of file TransferClient.h.

◆ ListFileTransferResults()

virtual Model::ListFileTransferResultsOutcome Aws::Transfer::TransferClient::ListFileTransferResults ( const Model::ListFileTransferResultsRequest & request) const

virtual

Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId.

File transfer results are available up to 7 days after an operation has been requested.

◆ ListFileTransferResultsAsync()

template<typename ListFileTransferResultsRequestT = Model::ListFileTransferResultsRequest>

void Aws::Transfer::TransferClient::ListFileTransferResultsAsync ( const ListFileTransferResultsRequestT & request,

const ListFileTransferResultsResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for ListFileTransferResults that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1110 of file TransferClient.h.

◆ ListFileTransferResultsCallable()

template<typename ListFileTransferResultsRequestT = Model::ListFileTransferResultsRequest>

Model::ListFileTransferResultsOutcomeCallable Aws::Transfer::TransferClient::ListFileTransferResultsCallable ( const ListFileTransferResultsRequestT & request) const

inline

A Callable wrapper for ListFileTransferResults that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1101 of file TransferClient.h.

◆ ListHostKeys()

virtual Model::ListHostKeysOutcome Aws::Transfer::TransferClient::ListHostKeys ( const Model::ListHostKeysRequest & request) const

virtual

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

◆ ListHostKeysAsync()

template<typename ListHostKeysRequestT = Model::ListHostKeysRequest>

void Aws::Transfer::TransferClient::ListHostKeysAsync ( const ListHostKeysRequestT & request,

const ListHostKeysResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for ListHostKeys that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1136 of file TransferClient.h.

◆ ListHostKeysCallable()

template<typename ListHostKeysRequestT = Model::ListHostKeysRequest>

Model::ListHostKeysOutcomeCallable Aws::Transfer::TransferClient::ListHostKeysCallable ( const ListHostKeysRequestT & request) const

inline

A Callable wrapper for ListHostKeys that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1127 of file TransferClient.h.

◆ ListProfiles()

virtual Model::ListProfilesOutcome Aws::Transfer::TransferClient::ListProfiles ( const Model::ListProfilesRequest & request = {}) const

virtual

Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.

◆ ListProfilesAsync()

template<typename ListProfilesRequestT = Model::ListProfilesRequest>

void Aws::Transfer::TransferClient::ListProfilesAsync ( const ListProfilesResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr,

const ListProfilesRequestT & request = {}

) const

inline

An Async wrapper for ListProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1165 of file TransferClient.h.

◆ ListProfilesCallable()

template<typename ListProfilesRequestT = Model::ListProfilesRequest>

Model::ListProfilesOutcomeCallable Aws::Transfer::TransferClient::ListProfilesCallable ( const ListProfilesRequestT & request = {}) const

inline

A Callable wrapper for ListProfiles that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1156 of file TransferClient.h.

◆ ListSecurityPolicies()

virtual Model::ListSecurityPoliciesOutcome Aws::Transfer::TransferClient::ListSecurityPolicies ( const Model::ListSecurityPoliciesRequest & request = {}) const

virtual

Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

◆ ListSecurityPoliciesAsync()

template<typename ListSecurityPoliciesRequestT = Model::ListSecurityPoliciesRequest>

void Aws::Transfer::TransferClient::ListSecurityPoliciesAsync ( const ListSecurityPoliciesResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr,

const ListSecurityPoliciesRequestT & request = {}

) const

inline

An Async wrapper for ListSecurityPolicies that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1195 of file TransferClient.h.

◆ ListSecurityPoliciesCallable()

template<typename ListSecurityPoliciesRequestT = Model::ListSecurityPoliciesRequest>

Model::ListSecurityPoliciesOutcomeCallable Aws::Transfer::TransferClient::ListSecurityPoliciesCallable ( const ListSecurityPoliciesRequestT & request = {}) const

inline

A Callable wrapper for ListSecurityPolicies that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1186 of file TransferClient.h.

◆ 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 Amazon Web Services account.

◆ ListServersAsync()

template<typename ListServersRequestT = Model::ListServersRequest>

void Aws::Transfer::TransferClient::ListServersAsync ( const ListServersResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr,

const ListServersRequestT & request = {}

) const

inline

An Async wrapper for ListServers that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1221 of file TransferClient.h.

◆ ListServersCallable()

template<typename ListServersRequestT = Model::ListServersRequest>

Model::ListServersOutcomeCallable Aws::Transfer::TransferClient::ListServersCallable ( const ListServersRequestT & request = {}) const

inline

A Callable wrapper for ListServers that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1212 of file TransferClient.h.

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

◆ ListTagsForResourceAsync()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void Aws::Transfer::TransferClient::ListTagsForResourceAsync ( const ListTagsForResourceRequestT & request,

const ListTagsForResourceResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1248 of file TransferClient.h.

◆ ListTagsForResourceCallable()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable Aws::Transfer::TransferClient::ListTagsForResourceCallable ( const ListTagsForResourceRequestT & request) const

inline

A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1239 of file TransferClient.h.

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

◆ ListUsersAsync()

template<typename ListUsersRequestT = Model::ListUsersRequest>

void Aws::Transfer::TransferClient::ListUsersAsync ( const ListUsersRequestT & request,

const ListUsersResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for ListUsers that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1274 of file TransferClient.h.

◆ ListUsersCallable()

template<typename ListUsersRequestT = Model::ListUsersRequest>

Model::ListUsersOutcomeCallable Aws::Transfer::TransferClient::ListUsersCallable ( const ListUsersRequestT & request) const

inline

A Callable wrapper for ListUsers that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1265 of file TransferClient.h.

◆ ListWorkflows()

virtual Model::ListWorkflowsOutcome Aws::Transfer::TransferClient::ListWorkflows ( const Model::ListWorkflowsRequest & request = {}) const

virtual

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

◆ ListWorkflowsAsync()

template<typename ListWorkflowsRequestT = Model::ListWorkflowsRequest>

void Aws::Transfer::TransferClient::ListWorkflowsAsync ( const ListWorkflowsResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr,

const ListWorkflowsRequestT & request = {}

) const

inline

An Async wrapper for ListWorkflows that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1300 of file TransferClient.h.

◆ ListWorkflowsCallable()

template<typename ListWorkflowsRequestT = Model::ListWorkflowsRequest>

Model::ListWorkflowsOutcomeCallable Aws::Transfer::TransferClient::ListWorkflowsCallable ( const ListWorkflowsRequestT & request = {}) const

inline

A Callable wrapper for ListWorkflows that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1291 of file TransferClient.h.

◆ OverrideEndpoint()

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

◆ SendWorkflowStepState()

virtual Model::SendWorkflowStepStateOutcome Aws::Transfer::TransferClient::SendWorkflowStepState ( const Model::SendWorkflowStepStateRequest & request) const

virtual

Sends a callback for asynchronous custom steps.

The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.

◆ SendWorkflowStepStateAsync()

template<typename SendWorkflowStepStateRequestT = Model::SendWorkflowStepStateRequest>

void Aws::Transfer::TransferClient::SendWorkflowStepStateAsync ( const SendWorkflowStepStateRequestT & request,

const SendWorkflowStepStateResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for SendWorkflowStepState that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1329 of file TransferClient.h.

◆ SendWorkflowStepStateCallable()

template<typename SendWorkflowStepStateRequestT = Model::SendWorkflowStepStateRequest>

Model::SendWorkflowStepStateOutcomeCallable Aws::Transfer::TransferClient::SendWorkflowStepStateCallable ( const SendWorkflowStepStateRequestT & request) const

inline

A Callable wrapper for SendWorkflowStepState that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1320 of file TransferClient.h.

◆ StartDirectoryListing()

virtual Model::StartDirectoryListingOutcome Aws::Transfer::TransferClient::StartDirectoryListing ( const Model::StartDirectoryListingRequest & request) const

virtual

Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep.

After you receive the listing file, you can provide the files that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call.

The naming convention for the output file is connector-ID-listing-ID.json. The output file contains the following information:

filePath: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.
modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.
size: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.
path: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.
truncated: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your Truncated output value is true, you can increase the value provided in the optional max-items input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).

◆ StartDirectoryListingAsync()

template<typename StartDirectoryListingRequestT = Model::StartDirectoryListingRequest>

void Aws::Transfer::TransferClient::StartDirectoryListingAsync ( const StartDirectoryListingRequestT & request,

const StartDirectoryListingResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for StartDirectoryListing that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1381 of file TransferClient.h.

◆ StartDirectoryListingCallable()

template<typename StartDirectoryListingRequestT = Model::StartDirectoryListingRequest>

Model::StartDirectoryListingOutcomeCallable Aws::Transfer::TransferClient::StartDirectoryListingCallable ( const StartDirectoryListingRequestT & request) const

inline

A Callable wrapper for StartDirectoryListing that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1372 of file TransferClient.h.

◆ StartFileTransfer()

virtual Model::StartFileTransferOutcome Aws::Transfer::TransferClient::StartFileTransfer ( const Model::StartFileTransferRequest & request) const

virtual

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

For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:
- If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.
- If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.

◆ StartFileTransferAsync()

template<typename StartFileTransferRequestT = Model::StartFileTransferRequest>

void Aws::Transfer::TransferClient::StartFileTransferAsync ( const StartFileTransferRequestT & request,

const StartFileTransferResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for StartFileTransfer that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1420 of file TransferClient.h.

◆ StartFileTransferCallable()

template<typename StartFileTransferRequestT = Model::StartFileTransferRequest>

Model::StartFileTransferOutcomeCallable Aws::Transfer::TransferClient::StartFileTransferCallable ( const StartFileTransferRequestT & request) const

inline

A Callable wrapper for StartFileTransfer that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1411 of file TransferClient.h.

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

◆ StartServerAsync()

template<typename StartServerRequestT = Model::StartServerRequest>

void Aws::Transfer::TransferClient::StartServerAsync ( const StartServerRequestT & request,

const StartServerResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for StartServer that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1452 of file TransferClient.h.

◆ StartServerCallable()

template<typename StartServerRequestT = Model::StartServerRequest>

Model::StartServerOutcomeCallable Aws::Transfer::TransferClient::StartServerCallable ( const StartServerRequestT & request) const

inline

A Callable wrapper for StartServer that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1443 of file TransferClient.h.

◆ 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 does 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.

◆ StopServerAsync()

template<typename StopServerRequestT = Model::StopServerRequest>

void Aws::Transfer::TransferClient::StopServerAsync ( const StopServerRequestT & request,

const StopServerResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for StopServer that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1487 of file TransferClient.h.

◆ StopServerCallable()

template<typename StopServerRequestT = Model::StopServerRequest>

Model::StopServerOutcomeCallable Aws::Transfer::TransferClient::StopServerCallable ( const StopServerRequestT & request) const

inline

A Callable wrapper for StopServer that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1478 of file TransferClient.h.

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

◆ TagResourceAsync()

template<typename TagResourceRequestT = Model::TagResourceRequest>

void Aws::Transfer::TransferClient::TagResourceAsync ( const TagResourceRequestT & request,

const TagResourceResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1514 of file TransferClient.h.

◆ TagResourceCallable()

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable Aws::Transfer::TransferClient::TagResourceCallable ( const TagResourceRequestT & request) const

inline

A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1505 of file TransferClient.h.

◆ TestConnection()

virtual Model::TestConnectionOutcome Aws::Transfer::TransferClient::TestConnection ( const Model::TestConnectionRequest & request) const

virtual

Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.

◆ TestConnectionAsync()

template<typename TestConnectionRequestT = Model::TestConnectionRequest>

void Aws::Transfer::TransferClient::TestConnectionAsync ( const TestConnectionRequestT & request,

const TestConnectionResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for TestConnection that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1542 of file TransferClient.h.

◆ TestConnectionCallable()

template<typename TestConnectionRequestT = Model::TestConnectionRequest>

Model::TestConnectionOutcomeCallable Aws::Transfer::TransferClient::TestConnectionCallable ( const TestConnectionRequestT & request) const

inline

A Callable wrapper for TestConnection that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1533 of file TransferClient.h.

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

The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

Note the following:

You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.
TestIdentityProvider does not work with keys: it only accepts passwords.
TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.
If you provide any incorrect values for any parameters, the Response field is empty.
If you provide a server ID for a server that uses service-managed users, you get an error:

An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
If you enter a Server ID for the –server-id parameter that does not identify an actual Transfer server, you receive the following error:

An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server.

It is possible your sever is in a different region. You can specify a region by adding the following: –region region-code, such as –region us-east-2 to specify a server in US East (Ohio).

◆ TestIdentityProviderAsync()

template<typename TestIdentityProviderRequestT = Model::TestIdentityProviderRequest>

void Aws::Transfer::TransferClient::TestIdentityProviderAsync ( const TestIdentityProviderRequestT & request,

const TestIdentityProviderResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for TestIdentityProvider that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1594 of file TransferClient.h.

◆ TestIdentityProviderCallable()

template<typename TestIdentityProviderRequestT = Model::TestIdentityProviderRequest>

Model::TestIdentityProviderOutcomeCallable Aws::Transfer::TransferClient::TestIdentityProviderCallable ( const TestIdentityProviderRequestT & request) const

inline

A Callable wrapper for TestIdentityProvider that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1585 of file TransferClient.h.

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

◆ UntagResourceAsync()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void Aws::Transfer::TransferClient::UntagResourceAsync ( const UntagResourceRequestT & request,

const UntagResourceResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1622 of file TransferClient.h.

◆ UntagResourceCallable()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable Aws::Transfer::TransferClient::UntagResourceCallable ( const UntagResourceRequestT & request) const

inline

A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1613 of file TransferClient.h.

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

◆ UpdateAccessAsync()

template<typename UpdateAccessRequestT = Model::UpdateAccessRequest>

void Aws::Transfer::TransferClient::UpdateAccessAsync ( const UpdateAccessRequestT & request,

const UpdateAccessResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for UpdateAccess that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1649 of file TransferClient.h.

◆ UpdateAccessCallable()

template<typename UpdateAccessRequestT = Model::UpdateAccessRequest>

Model::UpdateAccessOutcomeCallable Aws::Transfer::TransferClient::UpdateAccessCallable ( const UpdateAccessRequestT & request) const

inline

A Callable wrapper for UpdateAccess that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1640 of file TransferClient.h.

◆ UpdateAgreement()

virtual Model::UpdateAgreementOutcome Aws::Transfer::TransferClient::UpdateAgreement ( const Model::UpdateAgreementRequest & request) const

virtual

Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.

◆ UpdateAgreementAsync()

template<typename UpdateAgreementRequestT = Model::UpdateAgreementRequest>

void Aws::Transfer::TransferClient::UpdateAgreementAsync ( const UpdateAgreementRequestT & request,

const UpdateAgreementResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for UpdateAgreement that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1677 of file TransferClient.h.

◆ UpdateAgreementCallable()

template<typename UpdateAgreementRequestT = Model::UpdateAgreementRequest>

Model::UpdateAgreementOutcomeCallable Aws::Transfer::TransferClient::UpdateAgreementCallable ( const UpdateAgreementRequestT & request) const

inline

A Callable wrapper for UpdateAgreement that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1668 of file TransferClient.h.

◆ UpdateCertificate()

virtual Model::UpdateCertificateOutcome Aws::Transfer::TransferClient::UpdateCertificate ( const Model::UpdateCertificateRequest & request) const

virtual

Updates the active and inactive dates for a certificate.

◆ UpdateCertificateAsync()

template<typename UpdateCertificateRequestT = Model::UpdateCertificateRequest>

void Aws::Transfer::TransferClient::UpdateCertificateAsync ( const UpdateCertificateRequestT & request,

const UpdateCertificateResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for UpdateCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1703 of file TransferClient.h.

◆ UpdateCertificateCallable()

template<typename UpdateCertificateRequestT = Model::UpdateCertificateRequest>

Model::UpdateCertificateOutcomeCallable Aws::Transfer::TransferClient::UpdateCertificateCallable ( const UpdateCertificateRequestT & request) const

inline

A Callable wrapper for UpdateCertificate that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1694 of file TransferClient.h.

◆ UpdateConnector()

virtual Model::UpdateConnectorOutcome Aws::Transfer::TransferClient::UpdateConnector ( const Model::UpdateConnectorRequest & request) const

virtual

Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.

◆ UpdateConnectorAsync()

template<typename UpdateConnectorRequestT = Model::UpdateConnectorRequest>

void Aws::Transfer::TransferClient::UpdateConnectorAsync ( const UpdateConnectorRequestT & request,

const UpdateConnectorResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for UpdateConnector that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1730 of file TransferClient.h.

◆ UpdateConnectorCallable()

template<typename UpdateConnectorRequestT = Model::UpdateConnectorRequest>

Model::UpdateConnectorOutcomeCallable Aws::Transfer::TransferClient::UpdateConnectorCallable ( const UpdateConnectorRequestT & request) const

inline

A Callable wrapper for UpdateConnector that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1721 of file TransferClient.h.

◆ UpdateHostKey()

virtual Model::UpdateHostKeyOutcome Aws::Transfer::TransferClient::UpdateHostKey ( const Model::UpdateHostKeyRequest & request) const

virtual

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

◆ UpdateHostKeyAsync()

template<typename UpdateHostKeyRequestT = Model::UpdateHostKeyRequest>

void Aws::Transfer::TransferClient::UpdateHostKeyAsync ( const UpdateHostKeyRequestT & request,

const UpdateHostKeyResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for UpdateHostKey that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1757 of file TransferClient.h.

◆ UpdateHostKeyCallable()

template<typename UpdateHostKeyRequestT = Model::UpdateHostKeyRequest>

Model::UpdateHostKeyOutcomeCallable Aws::Transfer::TransferClient::UpdateHostKeyCallable ( const UpdateHostKeyRequestT & request) const

inline

A Callable wrapper for UpdateHostKey that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1748 of file TransferClient.h.

◆ UpdateProfile()

virtual Model::UpdateProfileOutcome Aws::Transfer::TransferClient::UpdateProfile ( const Model::UpdateProfileRequest & request) const

virtual

Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.

◆ UpdateProfileAsync()

template<typename UpdateProfileRequestT = Model::UpdateProfileRequest>

void Aws::Transfer::TransferClient::UpdateProfileAsync ( const UpdateProfileRequestT & request,

const UpdateProfileResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for UpdateProfile that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1784 of file TransferClient.h.

◆ UpdateProfileCallable()

template<typename UpdateProfileRequestT = Model::UpdateProfileRequest>

Model::UpdateProfileOutcomeCallable Aws::Transfer::TransferClient::UpdateProfileCallable ( const UpdateProfileRequestT & request) const

inline

A Callable wrapper for UpdateProfile that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1775 of file TransferClient.h.

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

◆ UpdateServerAsync()

template<typename UpdateServerRequestT = Model::UpdateServerRequest>

void Aws::Transfer::TransferClient::UpdateServerAsync ( const UpdateServerRequestT & request,

const UpdateServerResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for UpdateServer that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1811 of file TransferClient.h.

◆ UpdateServerCallable()

template<typename UpdateServerRequestT = Model::UpdateServerRequest>

Model::UpdateServerOutcomeCallable Aws::Transfer::TransferClient::UpdateServerCallable ( const UpdateServerRequestT & request) const

inline

A Callable wrapper for UpdateServer that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1802 of file TransferClient.h.

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

In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their HomeDirectoryType to LOGICAL, and specify HomeDirectoryMappings with Entry as root (/) and Target as their home directory.

For example, if the user's home directory is /test/admin-user, the following command updates the user so that their configuration in the console shows the Restricted flag as selected.

aws transfer update-user –server-id <server-id> –user-name admin-user –home-directory-type LOGICAL –home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]"

◆ UpdateUserAsync()

template<typename UpdateUserRequestT = Model::UpdateUserRequest>

void Aws::Transfer::TransferClient::UpdateUserAsync ( const UpdateUserRequestT & request,

const UpdateUserResponseReceivedHandler & handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > & context = nullptr

) const

inline

An Async wrapper for UpdateUser that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1851 of file TransferClient.h.

◆ UpdateUserCallable()

template<typename UpdateUserRequestT = Model::UpdateUserRequest>

Model::UpdateUserOutcomeCallable Aws::Transfer::TransferClient::UpdateUserCallable ( const UpdateUserRequestT & request) const

inline

A Callable wrapper for UpdateUser that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1842 of file TransferClient.h.

Friends And Related Symbol Documentation

◆ Aws::Client::ClientWithAsyncTemplateMethods< TransferClient >

friend class Aws::Client::ClientWithAsyncTemplateMethods< TransferClient >

friend

Definition at line 1858 of file TransferClient.h.

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

generated/src/aws-cpp-sdk-awstransfer/include/aws/awstransfer/TransferClient.h

AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Public Types

Public Types inherited from Aws::Client::AWSJsonClient

Public Member Functions

Public Member Functions inherited from Aws::Client::AWSJsonClient

Public Member Functions inherited from Aws::Client::AWSClient

Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< TransferClient >

Static Public Member Functions

Static Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< TransferClient >

Friends

Additional Inherited Members

Protected Member Functions inherited from Aws::Client::AWSJsonClient

Protected Member Functions inherited from Aws::Client::AWSClient

Static Protected Member Functions inherited from Aws::Client::AWSClient

Protected Attributes inherited from Aws::Client::AWSClient

Protected Attributes inherited from Aws::Client::ClientWithAsyncTemplateMethods< TransferClient >

Detailed Description

Member Typedef Documentation

◆ BASECLASS

◆ ClientConfigurationType

◆ EndpointProviderType

Constructor & Destructor Documentation

◆ TransferClient() [1/6]

◆ TransferClient() [2/6]

◆ TransferClient() [3/6]

◆ TransferClient() [4/6]

◆ TransferClient() [5/6]

◆ TransferClient() [6/6]

◆ ~TransferClient()

Member Function Documentation

◆ accessEndpointProvider()

◆ CreateAccess()

See Also:

◆ CreateAccessAsync()

◆ CreateAccessCallable()

◆ CreateAgreement()

See Also:

◆ CreateAgreementAsync()

◆ CreateAgreementCallable()

◆ CreateConnector()

See Also:

◆ CreateConnectorAsync()

◆ CreateConnectorCallable()

◆ CreateProfile()

See Also:

◆ CreateProfileAsync()

◆ CreateProfileCallable()

◆ CreateServer()

See Also:

◆ CreateServerAsync()

◆ CreateServerCallable()

◆ CreateUser()

See Also:

◆ CreateUserAsync()

◆ CreateUserCallable()

◆ CreateWorkflow()

See Also:

◆ CreateWorkflowAsync()

◆ CreateWorkflowCallable()

◆ DeleteAccess()

See Also:

◆ DeleteAccessAsync()

◆ DeleteAccessCallable()

◆ DeleteAgreement()

See Also:

◆ DeleteAgreementAsync()

◆ DeleteAgreementCallable()

◆ DeleteCertificate()

See Also:

◆ DeleteCertificateAsync()

◆ DeleteCertificateCallable()

◆ DeleteConnector()

See Also:

◆ DeleteConnectorAsync()

◆ DeleteConnectorCallable()

◆ DeleteHostKey()

See Also:

◆ DeleteHostKeyAsync()

◆ DeleteHostKeyCallable()