/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the transfer-2018-11-05.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Transfer.Model; namespace Amazon.Transfer { /// /// Interface for accessing Transfer /// /// 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 for processing, analytics, /// machine learning, and archiving. Getting started with Transfer Family is easy since /// there is no infrastructure to buy and set up. /// public partial interface IAmazonTransfer : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// ITransferPaginatorFactory Paginators { get; } #endif #region CreateAccess /// /// 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. /// /// Container for the necessary parameters to execute the CreateAccess service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateAccess service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for CreateAccess Operation Task CreateAccessAsync(CreateAccessRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateAgreement /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateAgreement service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateAgreement service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for CreateAgreement Operation Task CreateAgreementAsync(CreateAgreementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateConnector /// /// Creates the connector, which captures the parameters for an outbound connection for /// the AS2 or SFTP protocol. The connector is required for sending files to an externally /// hosted AS2 or SFTP server. For more details about AS2 connectors, see Create /// AS2 connectors. /// /// /// /// You must specify exactly one configuration object: either for AS2 (As2Config) /// or SFTP (SftpConfig). /// /// /// /// Container for the necessary parameters to execute the CreateConnector service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateConnector service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for CreateConnector Operation Task CreateConnectorAsync(CreateConnectorRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateProfile /// /// Creates the local or partner profile to use for AS2 transfers. /// /// Container for the necessary parameters to execute the CreateProfile service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateProfile service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for CreateProfile Operation Task CreateProfileAsync(CreateProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateServer /// /// 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. /// /// Container for the necessary parameters to execute the CreateServer service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateServer service method, as returned by Transfer. /// /// You do not have sufficient access to perform this action. /// /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for CreateServer Operation Task CreateServerAsync(CreateServerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateUser /// /// 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. /// /// Container for the necessary parameters to execute the CreateUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateUser service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for CreateUser Operation Task CreateUserAsync(CreateUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateWorkflow /// /// 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. /// /// Container for the necessary parameters to execute the CreateWorkflow service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateWorkflow service method, as returned by Transfer. /// /// You do not have sufficient access to perform this action. /// /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for CreateWorkflow Operation Task CreateWorkflowAsync(CreateWorkflowRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteAccess /// /// Allows you to delete the access specified in the ServerID and ExternalID /// parameters. /// /// Container for the necessary parameters to execute the DeleteAccess service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteAccess service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DeleteAccess Operation Task DeleteAccessAsync(DeleteAccessRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteAgreement /// /// Delete the agreement that's specified in the provided AgreementId. /// /// Container for the necessary parameters to execute the DeleteAgreement service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteAgreement service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DeleteAgreement Operation Task DeleteAgreementAsync(DeleteAgreementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteCertificate /// /// Deletes the certificate that's specified in the CertificateId parameter. /// /// Container for the necessary parameters to execute the DeleteCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCertificate service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DeleteCertificate Operation Task DeleteCertificateAsync(DeleteCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteConnector /// /// Deletes the connector that's specified in the provided ConnectorId. /// /// Container for the necessary parameters to execute the DeleteConnector service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteConnector service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DeleteConnector Operation Task DeleteConnectorAsync(DeleteConnectorRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteHostKey /// /// Deletes the host key that's specified in the HostKeyId parameter. /// /// Container for the necessary parameters to execute the DeleteHostKey service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteHostKey service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for DeleteHostKey Operation Task DeleteHostKeyAsync(DeleteHostKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteProfile /// /// Deletes the profile that's specified in the ProfileId parameter. /// /// Container for the necessary parameters to execute the DeleteProfile service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteProfile service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DeleteProfile Operation Task DeleteProfileAsync(DeleteProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteServer /// /// Deletes the file transfer protocol-enabled server that you specify. /// /// /// /// No response returns from this operation. /// /// /// Container for the necessary parameters to execute the DeleteServer service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteServer service method, as returned by Transfer. /// /// You do not have sufficient access to perform this action. /// /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DeleteServer Operation Task DeleteServerAsync(DeleteServerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteSshPublicKey /// /// Deletes a user's Secure Shell (SSH) public key. /// /// Container for the necessary parameters to execute the DeleteSshPublicKey service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteSshPublicKey service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for DeleteSshPublicKey Operation Task DeleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteUser /// /// 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. /// /// /// /// Container for the necessary parameters to execute the DeleteUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteUser service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DeleteUser Operation Task DeleteUserAsync(DeleteUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteWorkflow /// /// Deletes the specified workflow. /// /// Container for the necessary parameters to execute the DeleteWorkflow service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteWorkflow service method, as returned by Transfer. /// /// You do not have sufficient access to perform this action. /// /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DeleteWorkflow Operation Task DeleteWorkflowAsync(DeleteWorkflowRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeAccess /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeAccess service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeAccess service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeAccess Operation Task DescribeAccessAsync(DescribeAccessRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeAgreement /// /// Describes the agreement that's identified by the AgreementId. /// /// Container for the necessary parameters to execute the DescribeAgreement service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeAgreement service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeAgreement Operation Task DescribeAgreementAsync(DescribeAgreementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeCertificate /// /// Describes the certificate that's identified by the CertificateId. /// /// Container for the necessary parameters to execute the DescribeCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCertificate service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeCertificate Operation Task DescribeCertificateAsync(DescribeCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeConnector /// /// Describes the connector that's identified by the ConnectorId. /// /// Container for the necessary parameters to execute the DescribeConnector service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeConnector service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeConnector Operation Task DescribeConnectorAsync(DescribeConnectorRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeExecution /// /// 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. /// /// /// /// Container for the necessary parameters to execute the DescribeExecution service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeExecution service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeExecution Operation Task DescribeExecutionAsync(DescribeExecutionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeHostKey /// /// Returns the details of the host key that's specified by the HostKeyId /// and ServerId. /// /// Container for the necessary parameters to execute the DescribeHostKey service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeHostKey service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeHostKey Operation Task DescribeHostKeyAsync(DescribeHostKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeProfile /// /// Returns the details of the profile that's specified by the ProfileId. /// /// Container for the necessary parameters to execute the DescribeProfile service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeProfile service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeProfile Operation Task DescribeProfileAsync(DescribeProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeSecurityPolicy /// /// Describes the security policy that is attached to your file transfer protocol-enabled /// server. The response contains a description of the security policy's properties. For /// more information about security policies, see Working /// with security policies. /// /// Container for the necessary parameters to execute the DescribeSecurityPolicy service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeSecurityPolicy service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeSecurityPolicy Operation Task DescribeSecurityPolicyAsync(DescribeSecurityPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeServer /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeServer service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeServer service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeServer Operation Task DescribeServerAsync(DescribeServerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeUser /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeUser service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeUser Operation Task DescribeUserAsync(DescribeUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeWorkflow /// /// Describes the specified workflow. /// /// Container for the necessary parameters to execute the DescribeWorkflow service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeWorkflow service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for DescribeWorkflow Operation Task DescribeWorkflowAsync(DescribeWorkflowRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ImportCertificate /// /// Imports the signing and encryption certificates that you need to create local (AS2) /// profiles and partner profiles. /// /// Container for the necessary parameters to execute the ImportCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ImportCertificate service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ImportCertificate Operation Task ImportCertificateAsync(ImportCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ImportHostKey /// /// Adds a host key to the server that's specified by the ServerId parameter. /// /// Container for the necessary parameters to execute the ImportHostKey service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ImportHostKey service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for ImportHostKey Operation Task ImportHostKeyAsync(ImportHostKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ImportSshPublicKey /// /// 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. /// /// /// Container for the necessary parameters to execute the ImportSshPublicKey service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ImportSshPublicKey service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for ImportSshPublicKey Operation Task ImportSshPublicKeyAsync(ImportSshPublicKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListAccesses /// /// Lists the details for all the accesses you have on your server. /// /// Container for the necessary parameters to execute the ListAccesses service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListAccesses service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListAccesses Operation Task ListAccessesAsync(ListAccessesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListAgreements /// /// 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. /// /// Container for the necessary parameters to execute the ListAgreements service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListAgreements service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListAgreements Operation Task ListAgreementsAsync(ListAgreementsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListCertificates /// /// 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. /// /// Container for the necessary parameters to execute the ListCertificates service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListCertificates service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListCertificates Operation Task ListCertificatesAsync(ListCertificatesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListConnectors /// /// Lists the connectors for the specified Region. /// /// Container for the necessary parameters to execute the ListConnectors service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListConnectors service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListConnectors Operation Task ListConnectorsAsync(ListConnectorsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListExecutions /// /// Lists all in-progress executions for the specified workflow. /// /// /// /// If the specified workflow ID cannot be found, ListExecutions returns /// a ResourceNotFound exception. /// /// /// /// Container for the necessary parameters to execute the ListExecutions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListExecutions service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListExecutions Operation Task ListExecutionsAsync(ListExecutionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListHostKeys /// /// Returns a list of host keys for the server that's specified by the ServerId /// parameter. /// /// Container for the necessary parameters to execute the ListHostKeys service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListHostKeys service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListHostKeys Operation Task ListHostKeysAsync(ListHostKeysRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListProfiles /// /// 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. /// /// Container for the necessary parameters to execute the ListProfiles service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListProfiles service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListProfiles Operation Task ListProfilesAsync(ListProfilesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListSecurityPolicies /// /// Lists the security policies that are attached to your file transfer protocol-enabled /// servers. /// /// Container for the necessary parameters to execute the ListSecurityPolicies service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListSecurityPolicies service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListSecurityPolicies Operation Task ListSecurityPoliciesAsync(ListSecurityPoliciesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListServers /// /// Lists the file transfer protocol-enabled servers that are associated with your Amazon /// Web Services account. /// /// Container for the necessary parameters to execute the ListServers service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListServers service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListServers Operation Task ListServersAsync(ListServersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// /// Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. /// The resource can be a user, server, or role. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListUsers /// /// Lists the users for a file transfer protocol-enabled server that you specify by passing /// the ServerId parameter. /// /// Container for the necessary parameters to execute the ListUsers service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListUsers service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListUsers Operation Task ListUsersAsync(ListUsersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListWorkflows /// /// Lists all workflows associated with your Amazon Web Services account for your current /// region. /// /// Container for the necessary parameters to execute the ListWorkflows service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListWorkflows service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// The NextToken parameter that was passed is invalid. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for ListWorkflows Operation Task ListWorkflowsAsync(ListWorkflowsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region SendWorkflowStepState /// /// 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. /// /// /// Container for the necessary parameters to execute the SendWorkflowStepState service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the SendWorkflowStepState service method, as returned by Transfer. /// /// You do not have sufficient access to perform this action. /// /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for SendWorkflowStepState Operation Task SendWorkflowStepStateAsync(SendWorkflowStepStateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StartFileTransfer /// /// 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 a Transfer Family server, /// you specify one or more RetreiveFilePaths 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. /// ///
/// /// Container for the necessary parameters to execute the StartFileTransfer service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartFileTransfer service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for StartFileTransfer Operation Task StartFileTransferAsync(StartFileTransferRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StartServer /// /// 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. /// /// /// Container for the necessary parameters to execute the StartServer service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartServer service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for StartServer Operation Task StartServerAsync(StartServerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StopServer /// /// 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. /// /// /// Container for the necessary parameters to execute the StopServer service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StopServer service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for StopServer Operation Task StopServerAsync(StopServerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TagResource /// /// 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. /// /// /// Container for the necessary parameters to execute the TagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TagResource service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for TagResource Operation Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TestConnection /// /// 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 a Transfer /// Family server and a trading partner's SFTP server. /// /// Container for the necessary parameters to execute the TestConnection service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TestConnection service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for TestConnection Operation Task TestConnectionAsync(TestConnectionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TestIdentityProvider /// /// 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). /// ///
/// /// Container for the necessary parameters to execute the TestIdentityProvider service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TestIdentityProvider service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for TestIdentityProvider Operation Task TestIdentityProviderAsync(TestIdentityProviderRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UntagResource /// /// 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. /// /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UntagResource service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// REST API Reference for UntagResource Operation Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateAccess /// /// Allows you to update parameters for the access specified in the ServerID /// and ExternalID parameters. /// /// Container for the necessary parameters to execute the UpdateAccess service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateAccess service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for UpdateAccess Operation Task UpdateAccessAsync(UpdateAccessRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateAgreement /// /// 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. /// /// Container for the necessary parameters to execute the UpdateAgreement service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateAgreement service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for UpdateAgreement Operation Task UpdateAgreementAsync(UpdateAgreementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateCertificate /// /// Updates the active and inactive dates for a certificate. /// /// Container for the necessary parameters to execute the UpdateCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateCertificate service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for UpdateCertificate Operation Task UpdateCertificateAsync(UpdateCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateConnector /// /// 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. /// /// Container for the necessary parameters to execute the UpdateConnector service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateConnector service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for UpdateConnector Operation Task UpdateConnectorAsync(UpdateConnectorRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateHostKey /// /// Updates the description for the host key that's specified by the ServerId /// and HostKeyId parameters. /// /// Container for the necessary parameters to execute the UpdateHostKey service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateHostKey service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for UpdateHostKey Operation Task UpdateHostKeyAsync(UpdateHostKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateProfile /// /// 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. /// /// Container for the necessary parameters to execute the UpdateProfile service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateProfile service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for UpdateProfile Operation Task UpdateProfileAsync(UpdateProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateServer /// /// 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. /// /// /// Container for the necessary parameters to execute the UpdateServer service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateServer service method, as returned by Transfer. /// /// You do not have sufficient access to perform this action. /// /// /// This exception is thrown when the UpdateServer is called for a file transfer /// protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID /// is not in the available state. /// /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// The requested resource does not exist. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for UpdateServer Operation Task UpdateServerAsync(UpdateServerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateUser /// /// 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. /// /// /// Container for the necessary parameters to execute the UpdateUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateUser service method, as returned by Transfer. /// /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family /// service. /// /// /// This exception is thrown when the client submits a malformed request. /// /// /// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer /// Family service. /// /// /// The request has failed because the Amazon Web ServicesTransfer Family service is not /// available. /// /// /// The request was denied due to request throttling. /// /// REST API Reference for UpdateUser Operation Task UpdateUserAsync(UpdateUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }