// =================================================================
//
// * WARNING *
//
// This file is generated!
//
// Changes made to this file will be overwritten. If changes are
// required to the generated code, the service_crategen project
// must be updated to generate the changes.
//
// =================================================================
use std::error::Error;
use std::fmt;
use async_trait::async_trait;
use rusoto_core::credential::ProvideAwsCredentials;
use rusoto_core::region;
use rusoto_core::request::{BufferedHttpResponse, DispatchSignedRequest};
use rusoto_core::{Client, RusotoError};
use rusoto_core::proto;
use rusoto_core::request::HttpResponse;
use rusoto_core::signature::SignedRequest;
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
impl TransferClient {
fn new_signed_request(&self, http_method: &str, request_uri: &str) -> SignedRequest {
let mut request = SignedRequest::new(http_method, "transfer", &self.region, request_uri);
request.set_content_type("application/x-amz-json-1.1".to_owned());
request
}
async fn sign_and_dispatch<E>(
&self,
request: SignedRequest,
from_response: fn(BufferedHttpResponse) -> RusotoError<E>,
) -> Result<HttpResponse, RusotoError<E>> {
let mut response = self.client.sign_and_dispatch(request).await?;
if !response.status.is_success() {
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
return Err(from_response(response));
}
Ok(response)
}
}
use serde_json;
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct CreateServerRequest {
/// <p><p>The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p> <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a> in the <i> AWS Certificate Manager User Guide</i>.</p> <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a> in the <i> AWS Certificate Manager User Guide</i>.</p> <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a private certificate</a> in the <i> AWS Certificate Manager User Guide</i>.</p> <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p> <ul> <li> <p>2048-bit RSA (RSA<em>2048)</p> </li> <li> <p>4096-bit RSA (RSA</em>4096)</p> </li> <li> <p>Elliptic Prime Curve 256 bit (EC<em>prime256v1)</p> </li> <li> <p>Elliptic Prime Curve 384 bit (EC</em>secp384r1)</p> </li> <li> <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p> </li> </ul> <note> <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.</p> </note></p>
#[serde(rename = "Certificate")]
#[serde(skip_serializing_if = "Option::is_none")]
pub certificate: Option<String>,
/// <p>The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.</p>
#[serde(rename = "EndpointDetails")]
#[serde(skip_serializing_if = "Option::is_none")]
pub endpoint_details: Option<EndpointDetails>,
/// <p><p>The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.</p> <note> <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p> </note></p>
#[serde(rename = "EndpointType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub endpoint_type: Option<String>,
/// <p>The RSA private key as generated by the <code>ssh-keygen -N "" -m PEM -f my-new-server-key</code> command.</p> <important> <p>If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.</p> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>AWS Transfer Family User Guide</i>.</p>
#[serde(rename = "HostKey")]
#[serde(skip_serializing_if = "Option::is_none")]
pub host_key: Option<String>,
/// <p>Required when <code>IdentityProviderType</code> is set to <code>API_GATEWAY</code>. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when <code>IdentityProviderType</code> is set to <code>SERVICE_MANAGED</code>.</p>
#[serde(rename = "IdentityProviderDetails")]
#[serde(skip_serializing_if = "Option::is_none")]
pub identity_provider_details: Option<IdentityProviderDetails>,
/// <p>Specifies the mode of authentication for a file transfer protocol-enabled server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the AWS Transfer Family service. Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call for authentication using the <code>IdentityProviderDetails</code> parameter.</p>
#[serde(rename = "IdentityProviderType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub identity_provider_type: Option<String>,
/// <p>Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.</p>
#[serde(rename = "LoggingRole")]
#[serde(skip_serializing_if = "Option::is_none")]
pub logging_role: Option<String>,
/// <p><p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:</p> <ul> <li> <p> <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p> </li> <li> <p> <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p> </li> <li> <p> <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p> </li> </ul> <note> <p>If you select <code>FTPS</code>, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.</p> <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the <code>EndpointType</code> must be <code>VPC</code> and the <code>IdentityProviderType</code> must be <code>API<em>GATEWAY</code>.</p> <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p> <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to <code>SERVICE</em>MANAGED</code>.</p> </note></p>
#[serde(rename = "Protocols")]
#[serde(skip_serializing_if = "Option::is_none")]
pub protocols: Option<Vec<String>>,
/// <p>Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.</p>
#[serde(rename = "Tags")]
#[serde(skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
}
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct CreateServerResponse {
/// <p>The service-assigned ID of the file transfer protocol-enabled server that is created.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct CreateUserRequest {
/// <p>The landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using the client.</p> <p>An example is <i> <code>your-Amazon-S3-bucket-name>/home/username</code> </i>.</p>
#[serde(rename = "HomeDirectory")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory: Option<String>,
/// <p><p>Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "<code>Entry</code>" and "<code>Target</code>" pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in <code>Target</code>. The following is an example.</p> <p> <code>'[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'</code> </p> <p>In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory parameter value.</p> <note> <p>If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the <code>s3api</code> call instead of <code>s3</code> so you can use the put-object operation. For example, you use the following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make sure that the end of the key name ends in a '/' for it to be considered a folder.</p> </note></p>
#[serde(rename = "HomeDirectoryMappings")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory_mappings: Option<Vec<HomeDirectoryMapEntry>>,
/// <p>The type of landing directory (folder) you want your users' home directory to be when they log into the file transfer protocol-enabled server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it <code>LOGICAL</code>, you will need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 paths visible to your users.</p>
#[serde(rename = "HomeDirectoryType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory_type: Option<String>,
/// <p><p>A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p> <note> <p>For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the <code>Policy</code> argument.</p> <p>For an example of a scope-down policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating a scope-down policy</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>AWS Security Token Service API Reference</i>.</p> </note></p>
#[serde(rename = "Policy")]
#[serde(skip_serializing_if = "Option::is_none")]
pub policy: Option<String>,
/// <p>The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.</p>
#[serde(rename = "Role")]
pub role: String,
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance. This is the specific server that you added your user to.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer protocol-enabled server.</p>
#[serde(rename = "SshPublicKeyBody")]
#[serde(skip_serializing_if = "Option::is_none")]
pub ssh_public_key_body: Option<String>,
/// <p>Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.</p>
#[serde(rename = "Tags")]
#[serde(skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
/// <p>A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.</p>
#[serde(rename = "UserName")]
pub user_name: String,
}
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct CreateUserResponse {
/// <p>The ID of the file transfer protocol-enabled server that the user is attached to.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>A unique string that identifies a user account associated with a file transfer protocol-enabled server.</p>
#[serde(rename = "UserName")]
pub user_name: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct DeleteServerRequest {
/// <p>A unique system-assigned identifier for a file transfer protocol-enabled server instance.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct DeleteSshPublicKeyRequest {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>A unique identifier used to reference your user's specific SSH key.</p>
#[serde(rename = "SshPublicKeyId")]
pub ssh_public_key_id: String,
/// <p>A unique string that identifies a user whose public key is being deleted.</p>
#[serde(rename = "UserName")]
pub user_name: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct DeleteUserRequest {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>A unique string that identifies a user that is being deleted from a file transfer protocol-enabled server.</p>
#[serde(rename = "UserName")]
pub user_name: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct DescribeServerRequest {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
}
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct DescribeServerResponse {
/// <p>An array containing the properties of a file transfer protocol-enabled server with the <code>ServerID</code> you specified.</p>
#[serde(rename = "Server")]
pub server: DescribedServer,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct DescribeUserRequest {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>The name of the user assigned to one or more file transfer protocol-enabled servers. User names are part of the sign-in credentials to use the AWS Transfer Family service and perform file transfer tasks.</p>
#[serde(rename = "UserName")]
pub user_name: String,
}
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct DescribeUserResponse {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>An array containing the properties of the user account for the <code>ServerID</code> value that you specified.</p>
#[serde(rename = "User")]
pub user: DescribedUser,
}
/// <p>Describes the properties of a file transfer protocol-enabled server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the certificate ARN (if the FTPS protocol was selected), the endpoint type and details, the authentication configuration and type, the logging role, the file transfer protocol or protocols, the server ID and state, and assigned tags or metadata.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct DescribedServer {
/// <p>Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be described.</p>
#[serde(rename = "Arn")]
pub arn: String,
/// <p>Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p>
#[serde(rename = "Certificate")]
#[serde(skip_serializing_if = "Option::is_none")]
pub certificate: Option<String>,
/// <p>Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.</p>
#[serde(rename = "EndpointDetails")]
#[serde(skip_serializing_if = "Option::is_none")]
pub endpoint_details: Option<EndpointDetails>,
/// <p>Defines the type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.</p>
#[serde(rename = "EndpointType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub endpoint_type: Option<String>,
/// <p>Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the <code>ssh-keygen -l -f my-new-server-key</code> command.</p>
#[serde(rename = "HostKeyFingerprint")]
#[serde(skip_serializing_if = "Option::is_none")]
pub host_key_fingerprint: Option<String>,
/// <p>Specifies information to call a customer-supplied authentication API. This field is not populated when the <code>IdentityProviderType</code> of a file transfer protocol-enabled server is <code>SERVICE_MANAGED</code>.</p>
#[serde(rename = "IdentityProviderDetails")]
#[serde(skip_serializing_if = "Option::is_none")]
pub identity_provider_details: Option<IdentityProviderDetails>,
/// <p>Specifies the mode of authentication method enabled for this service. A value of <code>SERVICE_MANAGED</code> means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of <code>API_GATEWAY</code> indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.</p>
#[serde(rename = "IdentityProviderType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub identity_provider_type: Option<String>,
/// <p>Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.</p>
#[serde(rename = "LoggingRole")]
#[serde(skip_serializing_if = "Option::is_none")]
pub logging_role: Option<String>,
/// <p><p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:</p> <ul> <li> <p> <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p> </li> <li> <p> <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p> </li> <li> <p> <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p> </li> </ul></p>
#[serde(rename = "Protocols")]
#[serde(skip_serializing_if = "Option::is_none")]
pub protocols: Option<Vec<String>>,
/// <p>Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.</p>
#[serde(rename = "ServerId")]
#[serde(skip_serializing_if = "Option::is_none")]
pub server_id: Option<String>,
/// <p>Specifies the condition of a file transfer protocol-enabled server for the server that was described. A value of <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file transfer operations.</p> <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error condition.</p>
#[serde(rename = "State")]
#[serde(skip_serializing_if = "Option::is_none")]
pub state: Option<String>,
/// <p>Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.</p>
#[serde(rename = "Tags")]
#[serde(skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
/// <p>Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the <code>ServerId</code>.</p>
#[serde(rename = "UserCount")]
#[serde(skip_serializing_if = "Option::is_none")]
pub user_count: Option<i64>,
}
/// <p>Returns properties of the user that you want to describe.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct DescribedUser {
/// <p>Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.</p>
#[serde(rename = "Arn")]
pub arn: String,
/// <p>Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user. An example is <i> <code>your-Amazon-S3-bucket-name>/home/username</code> </i>.</p>
#[serde(rename = "HomeDirectory")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory: Option<String>,
/// <p>Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "<code>Entry</code>" and "<code>Target</code>" pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in <code>Target</code>.</p> <p>In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory parameter value.</p>
#[serde(rename = "HomeDirectoryMappings")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory_mappings: Option<Vec<HomeDirectoryMapEntry>>,
/// <p>Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it <code>LOGICAL</code>, you will need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 paths visible to your users.</p>
#[serde(rename = "HomeDirectoryType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory_type: Option<String>,
/// <p>Specifies the name of the policy in use for the described user.</p>
#[serde(rename = "Policy")]
#[serde(skip_serializing_if = "Option::is_none")]
pub policy: Option<String>,
/// <p>Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.</p>
#[serde(rename = "Role")]
#[serde(skip_serializing_if = "Option::is_none")]
pub role: Option<String>,
/// <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.</p>
#[serde(rename = "SshPublicKeys")]
#[serde(skip_serializing_if = "Option::is_none")]
pub ssh_public_keys: Option<Vec<SshPublicKey>>,
/// <p>Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.</p>
#[serde(rename = "Tags")]
#[serde(skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
/// <p>Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.</p>
#[serde(rename = "UserName")]
#[serde(skip_serializing_if = "Option::is_none")]
pub user_name: Option<String>,
}
/// <p>The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the <code>UpdateServer</code> API and attach an Elastic IP to your server's endpoint.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct EndpointDetails {
/// <p><p>A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server's endpoint. This is only valid in the <code>UpdateServer</code> API.</p> <note> <p>This property can only be use when <code>EndpointType</code> is set to <code>VPC</code>.</p> </note></p>
#[serde(rename = "AddressAllocationIds")]
#[serde(skip_serializing_if = "Option::is_none")]
pub address_allocation_ids: Option<Vec<String>>,
/// <p><p>A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.</p> <note> <p>This property can only be used when <code>EndpointType</code> is set to <code>VPC</code>.</p> </note></p>
#[serde(rename = "SubnetIds")]
#[serde(skip_serializing_if = "Option::is_none")]
pub subnet_ids: Option<Vec<String>>,
/// <p><p>The ID of the VPC endpoint.</p> <note> <p>This property can only be used when <code>EndpointType</code> is set to <code>VPC_ENDPOINT</code>.</p> </note></p>
#[serde(rename = "VpcEndpointId")]
#[serde(skip_serializing_if = "Option::is_none")]
pub vpc_endpoint_id: Option<String>,
/// <p><p>The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint will be hosted.</p> <note> <p>This property can only be used when <code>EndpointType</code> is set to <code>VPC</code>.</p> </note></p>
#[serde(rename = "VpcId")]
#[serde(skip_serializing_if = "Option::is_none")]
pub vpc_id: Option<String>,
}
/// <p>Represents an object that contains entries and a targets for <code>HomeDirectoryMappings</code>.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct HomeDirectoryMapEntry {
/// <p>Represents an entry and a target for <code>HomeDirectoryMappings</code>.</p>
#[serde(rename = "Entry")]
pub entry: String,
/// <p>Represents the map target that is used in a <code>HomeDirectorymapEntry</code>.</p>
#[serde(rename = "Target")]
pub target: String,
}
/// <p>Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct IdentityProviderDetails {
/// <p>Provides the type of <code>InvocationRole</code> used to authenticate the user account.</p>
#[serde(rename = "InvocationRole")]
#[serde(skip_serializing_if = "Option::is_none")]
pub invocation_role: Option<String>,
/// <p>Provides the location of the service endpoint used to authenticate users.</p>
#[serde(rename = "Url")]
#[serde(skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct ImportSshPublicKeyRequest {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>The public key portion of an SSH key pair.</p>
#[serde(rename = "SshPublicKeyBody")]
pub ssh_public_key_body: String,
/// <p>The name of the user account that is assigned to one or more file transfer protocol-enabled servers.</p>
#[serde(rename = "UserName")]
pub user_name: String,
}
/// <p>Identifies the user, the file transfer protocol-enabled server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct ImportSshPublicKeyResponse {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>The name given to a public key by the system that was imported.</p>
#[serde(rename = "SshPublicKeyId")]
pub ssh_public_key_id: String,
/// <p>A user name assigned to the <code>ServerID</code> value that you specified.</p>
#[serde(rename = "UserName")]
pub user_name: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct ListServersRequest {
/// <p>Specifies the number of file transfer protocol-enabled servers to return as a response to the <code>ListServers</code> query.</p>
#[serde(rename = "MaxResults")]
#[serde(skip_serializing_if = "Option::is_none")]
pub max_results: Option<i64>,
/// <p>When additional results are obtained from the<code>ListServers</code> command, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional file transfer protocol-enabled servers.</p>
#[serde(rename = "NextToken")]
#[serde(skip_serializing_if = "Option::is_none")]
pub next_token: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct ListServersResponse {
/// <p>When you can get additional results from the <code>ListServers</code> operation, a <code>NextToken</code> parameter is returned in the output. In a following command, you can pass in the <code>NextToken</code> parameter to continue listing additional file transfer protocol-enabled servers.</p>
#[serde(rename = "NextToken")]
#[serde(skip_serializing_if = "Option::is_none")]
pub next_token: Option<String>,
/// <p>An array of file transfer protocol-enabled servers that were listed.</p>
#[serde(rename = "Servers")]
pub servers: Vec<ListedServer>,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct ListTagsForResourceRequest {
/// <p>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role.</p>
#[serde(rename = "Arn")]
pub arn: String,
/// <p>Specifies the number of tags to return as a response to the <code>ListTagsForResource</code> request.</p>
#[serde(rename = "MaxResults")]
#[serde(skip_serializing_if = "Option::is_none")]
pub max_results: Option<i64>,
/// <p>When you request additional results from the <code>ListTagsForResource</code> operation, a <code>NextToken</code> parameter is returned in the input. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional tags.</p>
#[serde(rename = "NextToken")]
#[serde(skip_serializing_if = "Option::is_none")]
pub next_token: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct ListTagsForResourceResponse {
/// <p>The ARN you specified to list the tags of.</p>
#[serde(rename = "Arn")]
#[serde(skip_serializing_if = "Option::is_none")]
pub arn: Option<String>,
/// <p>When you can get additional results from the <code>ListTagsForResource</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional tags.</p>
#[serde(rename = "NextToken")]
#[serde(skip_serializing_if = "Option::is_none")]
pub next_token: Option<String>,
/// <p>Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.</p>
#[serde(rename = "Tags")]
#[serde(skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct ListUsersRequest {
/// <p>Specifies the number of users to return as a response to the <code>ListUsers</code> request.</p>
#[serde(rename = "MaxResults")]
#[serde(skip_serializing_if = "Option::is_none")]
pub max_results: Option<i64>,
/// <p>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional users.</p>
#[serde(rename = "NextToken")]
#[serde(skip_serializing_if = "Option::is_none")]
pub next_token: Option<String>,
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server that has users assigned to it.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
}
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct ListUsersResponse {
/// <p>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional users.</p>
#[serde(rename = "NextToken")]
#[serde(skip_serializing_if = "Option::is_none")]
pub next_token: Option<String>,
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server that the users are assigned to.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>Returns the user accounts and their properties for the <code>ServerId</code> value that you specify.</p>
#[serde(rename = "Users")]
pub users: Vec<ListedUser>,
}
/// <p>Returns properties of a file transfer protocol-enabled server that was specified.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct ListedServer {
/// <p>Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be listed.</p>
#[serde(rename = "Arn")]
pub arn: String,
/// <p>Specifies the type of VPC endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.</p>
#[serde(rename = "EndpointType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub endpoint_type: Option<String>,
/// <p>Specifies the authentication method used to validate a user for a file transfer protocol-enabled server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include <code>SERVICE_MANAGED</code> or <code>API_GATEWAY</code>.</p>
#[serde(rename = "IdentityProviderType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub identity_provider_type: Option<String>,
/// <p>Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging.</p>
#[serde(rename = "LoggingRole")]
#[serde(skip_serializing_if = "Option::is_none")]
pub logging_role: Option<String>,
/// <p>Specifies the unique system assigned identifier for a file transfer protocol-enabled servers that were listed.</p>
#[serde(rename = "ServerId")]
#[serde(skip_serializing_if = "Option::is_none")]
pub server_id: Option<String>,
/// <p>Specifies the condition of a file transfer protocol-enabled server for the server that was described. A value of <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file transfer operations.</p> <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error condition.</p>
#[serde(rename = "State")]
#[serde(skip_serializing_if = "Option::is_none")]
pub state: Option<String>,
/// <p>Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the <code>ServerId</code>.</p>
#[serde(rename = "UserCount")]
#[serde(skip_serializing_if = "Option::is_none")]
pub user_count: Option<i64>,
}
/// <p>Returns properties of the user that you specify.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct ListedUser {
/// <p>Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.</p>
#[serde(rename = "Arn")]
pub arn: String,
/// <p>Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.</p>
#[serde(rename = "HomeDirectory")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory: Option<String>,
/// <p>Specifies the type of landing directory (folder) you mapped for your users' home directory. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it <code>LOGICAL</code>, you will need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 paths visible to your users.</p>
#[serde(rename = "HomeDirectoryType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory_type: Option<String>,
/// <p>Specifies the role that is in use by this user. A <i>role</i> is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.</p>
#[serde(rename = "Role")]
#[serde(skip_serializing_if = "Option::is_none")]
pub role: Option<String>,
/// <p>Specifies the number of SSH public keys stored for the user you specified.</p>
#[serde(rename = "SshPublicKeyCount")]
#[serde(skip_serializing_if = "Option::is_none")]
pub ssh_public_key_count: Option<i64>,
/// <p>Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.</p>
#[serde(rename = "UserName")]
#[serde(skip_serializing_if = "Option::is_none")]
pub user_name: Option<String>,
}
/// <p>Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific file transfer protocol-enabled server (as identified by <code>ServerId</code>). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct SshPublicKey {
/// <p>Specifies the date that the public key was added to the user account.</p>
#[serde(rename = "DateImported")]
pub date_imported: f64,
/// <p>Specifies the content of the SSH public key as specified by the <code>PublicKeyId</code>.</p>
#[serde(rename = "SshPublicKeyBody")]
pub ssh_public_key_body: String,
/// <p>Specifies the <code>SshPublicKeyId</code> parameter contains the identifier of the public key.</p>
#[serde(rename = "SshPublicKeyId")]
pub ssh_public_key_id: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct StartServerRequest {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server that you start.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct StopServerRequest {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server that you stopped.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
}
/// <p>Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called <code>Group</code> and assign the values <code>Research</code> and <code>Accounting</code> to that group.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct Tag {
/// <p>The name assigned to the tag that you create.</p>
#[serde(rename = "Key")]
pub key: String,
/// <p>Contains one or more values that you assigned to the key name you create.</p>
#[serde(rename = "Value")]
pub value: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct TagResourceRequest {
/// <p>An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role.</p>
#[serde(rename = "Arn")]
pub arn: String,
/// <p>Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.</p>
#[serde(rename = "Tags")]
pub tags: Vec<Tag>,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct TestIdentityProviderRequest {
/// <p>A system-assigned identifier for a specific file transfer protocol-enabled server. That server's user authentication method is tested with a user name and password.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p><p>The type of file transfer protocol to be tested.</p> <p>The available protocols are:</p> <ul> <li> <p>Secure Shell (SSH) File Transfer Protocol (SFTP)</p> </li> <li> <p>File Transfer Protocol Secure (FTPS)</p> </li> <li> <p>File Transfer Protocol (FTP)</p> </li> </ul></p>
#[serde(rename = "ServerProtocol")]
#[serde(skip_serializing_if = "Option::is_none")]
pub server_protocol: Option<String>,
/// <p>The source IP address of the user account to be tested.</p>
#[serde(rename = "SourceIp")]
#[serde(skip_serializing_if = "Option::is_none")]
pub source_ip: Option<String>,
/// <p>The name of the user account to be tested.</p>
#[serde(rename = "UserName")]
pub user_name: String,
/// <p>The password of the user account to be tested.</p>
#[serde(rename = "UserPassword")]
#[serde(skip_serializing_if = "Option::is_none")]
pub user_password: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct TestIdentityProviderResponse {
/// <p>A message that indicates whether the test was successful or not.</p>
#[serde(rename = "Message")]
#[serde(skip_serializing_if = "Option::is_none")]
pub message: Option<String>,
/// <p>The response that is returned from your API Gateway.</p>
#[serde(rename = "Response")]
#[serde(skip_serializing_if = "Option::is_none")]
pub response: Option<String>,
/// <p>The HTTP status code that is the response from your API Gateway.</p>
#[serde(rename = "StatusCode")]
pub status_code: i64,
/// <p>The endpoint of the service used to authenticate a user.</p>
#[serde(rename = "Url")]
pub url: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct UntagResourceRequest {
/// <p>The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.</p>
#[serde(rename = "Arn")]
pub arn: String,
/// <p>TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.</p>
#[serde(rename = "TagKeys")]
pub tag_keys: Vec<String>,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct UpdateServerRequest {
/// <p><p>The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p> <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a> in the <i> AWS Certificate Manager User Guide</i>.</p> <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a> in the <i> AWS Certificate Manager User Guide</i>.</p> <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a private certificate</a> in the <i> AWS Certificate Manager User Guide</i>.</p> <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p> <ul> <li> <p>2048-bit RSA (RSA<em>2048)</p> </li> <li> <p>4096-bit RSA (RSA</em>4096)</p> </li> <li> <p>Elliptic Prime Curve 256 bit (EC<em>prime256v1)</p> </li> <li> <p>Elliptic Prime Curve 384 bit (EC</em>secp384r1)</p> </li> <li> <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p> </li> </ul> <note> <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.</p> </note></p>
#[serde(rename = "Certificate")]
#[serde(skip_serializing_if = "Option::is_none")]
pub certificate: Option<String>,
/// <p>The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.</p>
#[serde(rename = "EndpointDetails")]
#[serde(skip_serializing_if = "Option::is_none")]
pub endpoint_details: Option<EndpointDetails>,
/// <p><p>The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.</p> <note> <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p> </note></p>
#[serde(rename = "EndpointType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub endpoint_type: Option<String>,
/// <p>The RSA private key as generated by <code>ssh-keygen -N "" -m PEM -f my-new-server-key</code>.</p> <important> <p>If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.</p> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>AWS Transfer Family User Guide</i>.</p>
#[serde(rename = "HostKey")]
#[serde(skip_serializing_if = "Option::is_none")]
pub host_key: Option<String>,
/// <p>An array containing all of the information required to call a customer's authentication API method.</p>
#[serde(rename = "IdentityProviderDetails")]
#[serde(skip_serializing_if = "Option::is_none")]
pub identity_provider_details: Option<IdentityProviderDetails>,
/// <p>Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.</p>
#[serde(rename = "LoggingRole")]
#[serde(skip_serializing_if = "Option::is_none")]
pub logging_role: Option<String>,
/// <p><p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:</p> <ul> <li> <p>Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH</p> </li> <li> <p>File Transfer Protocol Secure (FTPS): File transfer with TLS encryption</p> </li> <li> <p>File Transfer Protocol (FTP): Unencrypted file transfer</p> </li> </ul> <note> <p>If you select <code>FTPS</code>, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.</p> <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the <code>EndpointType</code> must be <code>VPC</code> and the <code>IdentityProviderType</code> must be <code>API<em>GATEWAY</code>.</p> <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p> <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to <code>SERVICE</em>MANAGED</code>.</p> </note></p>
#[serde(rename = "Protocols")]
#[serde(skip_serializing_if = "Option::is_none")]
pub protocols: Option<Vec<String>>,
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
}
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct UpdateServerResponse {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server that the user account is assigned to.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
}
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
#[cfg_attr(feature = "deserialize_structs", derive(Deserialize))]
pub struct UpdateUserRequest {
/// <p>Specifies the landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using their file transfer protocol client.</p> <p>An example is <code>your-Amazon-S3-bucket-name>/home/username</code>.</p>
#[serde(rename = "HomeDirectory")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory: Option<String>,
/// <p><p>Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "<code>Entry</code>" and "<code>Target</code>" pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in <code>Target</code>. The following is an example.</p> <p> <code>'[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'</code> </p> <p>In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory parameter value.</p> <note> <p>If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the <code>s3api</code> call instead of <code>s3</code> so you can use the put-object operation. For example, you use the following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make sure that the end of the key name ends in a / for it to be considered a folder.</p> </note></p>
#[serde(rename = "HomeDirectoryMappings")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory_mappings: Option<Vec<HomeDirectoryMapEntry>>,
/// <p>The type of landing directory (folder) you want your users' home directory to be when they log into the file transfer protocol-enabled server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it <code>LOGICAL</code>, you will need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 paths visible to your users.</p>
#[serde(rename = "HomeDirectoryType")]
#[serde(skip_serializing_if = "Option::is_none")]
pub home_directory_type: Option<String>,
/// <p><p>Allows you to supply a scope-down policy for your user so you can use the same IAM role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p> <note> <p>For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the <code>Policy</code> argument.</p> <p>For an example of a scope-down policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating a scope-down policy</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>AWS Security Token Service API Reference</i>.</p> </note></p>
#[serde(rename = "Policy")]
#[serde(skip_serializing_if = "Option::is_none")]
pub policy: Option<String>,
/// <p>The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.</p>
#[serde(rename = "Role")]
#[serde(skip_serializing_if = "Option::is_none")]
pub role: Option<String>,
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the <code>ServerId</code>. This is the string that will be used by your user when they log in to your server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.</p>
#[serde(rename = "UserName")]
pub user_name: String,
}
/// <p> <code>UpdateUserResponse</code> returns the user name and file transfer protocol-enabled server identifier for the request to update a user's properties.</p>
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))]
pub struct UpdateUserResponse {
/// <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.</p>
#[serde(rename = "ServerId")]
pub server_id: String,
/// <p>The unique identifier for a user that is assigned to a file transfer protocol-enabled server instance that was specified in the request.</p>
#[serde(rename = "UserName")]
pub user_name: String,
}
/// Errors returned by CreateServer
#[derive(Debug, PartialEq)]
pub enum CreateServerError {
/// <p>You do not have sufficient access to perform this action.</p>
AccessDenied(String),
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>The requested resource does not exist.</p>
ResourceExists(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
/// <p>The request was denied due to request throttling.</p> <p> HTTP Status Code: 400</p>
Throttling(String),
}
impl CreateServerError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<CreateServerError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"AccessDeniedException" => {
return RusotoError::Service(CreateServerError::AccessDenied(err.msg))
}
"InternalServiceError" => {
return RusotoError::Service(CreateServerError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(CreateServerError::InvalidRequest(err.msg))
}
"ResourceExistsException" => {
return RusotoError::Service(CreateServerError::ResourceExists(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(CreateServerError::ServiceUnavailable(err.msg))
}
"ThrottlingException" => {
return RusotoError::Service(CreateServerError::Throttling(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for CreateServerError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
CreateServerError::AccessDenied(ref cause) => write!(f, "{}", cause),
CreateServerError::InternalServiceError(ref cause) => write!(f, "{}", cause),
CreateServerError::InvalidRequest(ref cause) => write!(f, "{}", cause),
CreateServerError::ResourceExists(ref cause) => write!(f, "{}", cause),
CreateServerError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
CreateServerError::Throttling(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for CreateServerError {}
/// Errors returned by CreateUser
#[derive(Debug, PartialEq)]
pub enum CreateUserError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>The requested resource does not exist.</p>
ResourceExists(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl CreateUserError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<CreateUserError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(CreateUserError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(CreateUserError::InvalidRequest(err.msg))
}
"ResourceExistsException" => {
return RusotoError::Service(CreateUserError::ResourceExists(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(CreateUserError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(CreateUserError::ServiceUnavailable(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for CreateUserError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
CreateUserError::InternalServiceError(ref cause) => write!(f, "{}", cause),
CreateUserError::InvalidRequest(ref cause) => write!(f, "{}", cause),
CreateUserError::ResourceExists(ref cause) => write!(f, "{}", cause),
CreateUserError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
CreateUserError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for CreateUserError {}
/// Errors returned by DeleteServer
#[derive(Debug, PartialEq)]
pub enum DeleteServerError {
/// <p>You do not have sufficient access to perform this action.</p>
AccessDenied(String),
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl DeleteServerError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DeleteServerError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"AccessDeniedException" => {
return RusotoError::Service(DeleteServerError::AccessDenied(err.msg))
}
"InternalServiceError" => {
return RusotoError::Service(DeleteServerError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(DeleteServerError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(DeleteServerError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(DeleteServerError::ServiceUnavailable(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for DeleteServerError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
DeleteServerError::AccessDenied(ref cause) => write!(f, "{}", cause),
DeleteServerError::InternalServiceError(ref cause) => write!(f, "{}", cause),
DeleteServerError::InvalidRequest(ref cause) => write!(f, "{}", cause),
DeleteServerError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
DeleteServerError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for DeleteServerError {}
/// Errors returned by DeleteSshPublicKey
#[derive(Debug, PartialEq)]
pub enum DeleteSshPublicKeyError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
/// <p>The request was denied due to request throttling.</p> <p> HTTP Status Code: 400</p>
Throttling(String),
}
impl DeleteSshPublicKeyError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DeleteSshPublicKeyError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(DeleteSshPublicKeyError::InternalServiceError(
err.msg,
))
}
"InvalidRequestException" => {
return RusotoError::Service(DeleteSshPublicKeyError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(DeleteSshPublicKeyError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(DeleteSshPublicKeyError::ServiceUnavailable(
err.msg,
))
}
"ThrottlingException" => {
return RusotoError::Service(DeleteSshPublicKeyError::Throttling(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for DeleteSshPublicKeyError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
DeleteSshPublicKeyError::InternalServiceError(ref cause) => write!(f, "{}", cause),
DeleteSshPublicKeyError::InvalidRequest(ref cause) => write!(f, "{}", cause),
DeleteSshPublicKeyError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
DeleteSshPublicKeyError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
DeleteSshPublicKeyError::Throttling(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for DeleteSshPublicKeyError {}
/// Errors returned by DeleteUser
#[derive(Debug, PartialEq)]
pub enum DeleteUserError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl DeleteUserError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DeleteUserError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(DeleteUserError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(DeleteUserError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(DeleteUserError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(DeleteUserError::ServiceUnavailable(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for DeleteUserError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
DeleteUserError::InternalServiceError(ref cause) => write!(f, "{}", cause),
DeleteUserError::InvalidRequest(ref cause) => write!(f, "{}", cause),
DeleteUserError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
DeleteUserError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for DeleteUserError {}
/// Errors returned by DescribeServer
#[derive(Debug, PartialEq)]
pub enum DescribeServerError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl DescribeServerError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DescribeServerError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(DescribeServerError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(DescribeServerError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(DescribeServerError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(DescribeServerError::ServiceUnavailable(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for DescribeServerError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
DescribeServerError::InternalServiceError(ref cause) => write!(f, "{}", cause),
DescribeServerError::InvalidRequest(ref cause) => write!(f, "{}", cause),
DescribeServerError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
DescribeServerError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for DescribeServerError {}
/// Errors returned by DescribeUser
#[derive(Debug, PartialEq)]
pub enum DescribeUserError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl DescribeUserError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DescribeUserError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(DescribeUserError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(DescribeUserError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(DescribeUserError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(DescribeUserError::ServiceUnavailable(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for DescribeUserError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
DescribeUserError::InternalServiceError(ref cause) => write!(f, "{}", cause),
DescribeUserError::InvalidRequest(ref cause) => write!(f, "{}", cause),
DescribeUserError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
DescribeUserError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for DescribeUserError {}
/// Errors returned by ImportSshPublicKey
#[derive(Debug, PartialEq)]
pub enum ImportSshPublicKeyError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>The requested resource does not exist.</p>
ResourceExists(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
/// <p>The request was denied due to request throttling.</p> <p> HTTP Status Code: 400</p>
Throttling(String),
}
impl ImportSshPublicKeyError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ImportSshPublicKeyError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(ImportSshPublicKeyError::InternalServiceError(
err.msg,
))
}
"InvalidRequestException" => {
return RusotoError::Service(ImportSshPublicKeyError::InvalidRequest(err.msg))
}
"ResourceExistsException" => {
return RusotoError::Service(ImportSshPublicKeyError::ResourceExists(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(ImportSshPublicKeyError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(ImportSshPublicKeyError::ServiceUnavailable(
err.msg,
))
}
"ThrottlingException" => {
return RusotoError::Service(ImportSshPublicKeyError::Throttling(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for ImportSshPublicKeyError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
ImportSshPublicKeyError::InternalServiceError(ref cause) => write!(f, "{}", cause),
ImportSshPublicKeyError::InvalidRequest(ref cause) => write!(f, "{}", cause),
ImportSshPublicKeyError::ResourceExists(ref cause) => write!(f, "{}", cause),
ImportSshPublicKeyError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
ImportSshPublicKeyError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
ImportSshPublicKeyError::Throttling(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for ImportSshPublicKeyError {}
/// Errors returned by ListServers
#[derive(Debug, PartialEq)]
pub enum ListServersError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
InvalidNextToken(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl ListServersError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ListServersError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(ListServersError::InternalServiceError(err.msg))
}
"InvalidNextTokenException" => {
return RusotoError::Service(ListServersError::InvalidNextToken(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(ListServersError::InvalidRequest(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(ListServersError::ServiceUnavailable(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for ListServersError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
ListServersError::InternalServiceError(ref cause) => write!(f, "{}", cause),
ListServersError::InvalidNextToken(ref cause) => write!(f, "{}", cause),
ListServersError::InvalidRequest(ref cause) => write!(f, "{}", cause),
ListServersError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for ListServersError {}
/// Errors returned by ListTagsForResource
#[derive(Debug, PartialEq)]
pub enum ListTagsForResourceError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
InvalidNextToken(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl ListTagsForResourceError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ListTagsForResourceError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(ListTagsForResourceError::InternalServiceError(
err.msg,
))
}
"InvalidNextTokenException" => {
return RusotoError::Service(ListTagsForResourceError::InvalidNextToken(
err.msg,
))
}
"InvalidRequestException" => {
return RusotoError::Service(ListTagsForResourceError::InvalidRequest(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(ListTagsForResourceError::ServiceUnavailable(
err.msg,
))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for ListTagsForResourceError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
ListTagsForResourceError::InternalServiceError(ref cause) => write!(f, "{}", cause),
ListTagsForResourceError::InvalidNextToken(ref cause) => write!(f, "{}", cause),
ListTagsForResourceError::InvalidRequest(ref cause) => write!(f, "{}", cause),
ListTagsForResourceError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for ListTagsForResourceError {}
/// Errors returned by ListUsers
#[derive(Debug, PartialEq)]
pub enum ListUsersError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
InvalidNextToken(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl ListUsersError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ListUsersError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(ListUsersError::InternalServiceError(err.msg))
}
"InvalidNextTokenException" => {
return RusotoError::Service(ListUsersError::InvalidNextToken(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(ListUsersError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(ListUsersError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(ListUsersError::ServiceUnavailable(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for ListUsersError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
ListUsersError::InternalServiceError(ref cause) => write!(f, "{}", cause),
ListUsersError::InvalidNextToken(ref cause) => write!(f, "{}", cause),
ListUsersError::InvalidRequest(ref cause) => write!(f, "{}", cause),
ListUsersError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
ListUsersError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for ListUsersError {}
/// Errors returned by StartServer
#[derive(Debug, PartialEq)]
pub enum StartServerError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
/// <p>The request was denied due to request throttling.</p> <p> HTTP Status Code: 400</p>
Throttling(String),
}
impl StartServerError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<StartServerError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(StartServerError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(StartServerError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(StartServerError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(StartServerError::ServiceUnavailable(err.msg))
}
"ThrottlingException" => {
return RusotoError::Service(StartServerError::Throttling(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for StartServerError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
StartServerError::InternalServiceError(ref cause) => write!(f, "{}", cause),
StartServerError::InvalidRequest(ref cause) => write!(f, "{}", cause),
StartServerError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
StartServerError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
StartServerError::Throttling(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for StartServerError {}
/// Errors returned by StopServer
#[derive(Debug, PartialEq)]
pub enum StopServerError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
/// <p>The request was denied due to request throttling.</p> <p> HTTP Status Code: 400</p>
Throttling(String),
}
impl StopServerError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<StopServerError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(StopServerError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(StopServerError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(StopServerError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(StopServerError::ServiceUnavailable(err.msg))
}
"ThrottlingException" => {
return RusotoError::Service(StopServerError::Throttling(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for StopServerError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
StopServerError::InternalServiceError(ref cause) => write!(f, "{}", cause),
StopServerError::InvalidRequest(ref cause) => write!(f, "{}", cause),
StopServerError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
StopServerError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
StopServerError::Throttling(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for StopServerError {}
/// Errors returned by TagResource
#[derive(Debug, PartialEq)]
pub enum TagResourceError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl TagResourceError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<TagResourceError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(TagResourceError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(TagResourceError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(TagResourceError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(TagResourceError::ServiceUnavailable(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for TagResourceError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
TagResourceError::InternalServiceError(ref cause) => write!(f, "{}", cause),
TagResourceError::InvalidRequest(ref cause) => write!(f, "{}", cause),
TagResourceError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
TagResourceError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for TagResourceError {}
/// Errors returned by TestIdentityProvider
#[derive(Debug, PartialEq)]
pub enum TestIdentityProviderError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl TestIdentityProviderError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<TestIdentityProviderError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(TestIdentityProviderError::InternalServiceError(
err.msg,
))
}
"InvalidRequestException" => {
return RusotoError::Service(TestIdentityProviderError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(TestIdentityProviderError::ResourceNotFound(
err.msg,
))
}
"ServiceUnavailableException" => {
return RusotoError::Service(TestIdentityProviderError::ServiceUnavailable(
err.msg,
))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for TestIdentityProviderError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
TestIdentityProviderError::InternalServiceError(ref cause) => write!(f, "{}", cause),
TestIdentityProviderError::InvalidRequest(ref cause) => write!(f, "{}", cause),
TestIdentityProviderError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
TestIdentityProviderError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for TestIdentityProviderError {}
/// Errors returned by UntagResource
#[derive(Debug, PartialEq)]
pub enum UntagResourceError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
}
impl UntagResourceError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<UntagResourceError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(UntagResourceError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(UntagResourceError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(UntagResourceError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(UntagResourceError::ServiceUnavailable(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for UntagResourceError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
UntagResourceError::InternalServiceError(ref cause) => write!(f, "{}", cause),
UntagResourceError::InvalidRequest(ref cause) => write!(f, "{}", cause),
UntagResourceError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
UntagResourceError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for UntagResourceError {}
/// Errors returned by UpdateServer
#[derive(Debug, PartialEq)]
pub enum UpdateServerError {
/// <p>You do not have sufficient access to perform this action.</p>
AccessDenied(String),
/// <p>This exception is thrown when the <code>UpdatServer</code> is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's <code>VpcEndpointID</code> is not in the available state.</p>
Conflict(String),
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>The requested resource does not exist.</p>
ResourceExists(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
/// <p>The request was denied due to request throttling.</p> <p> HTTP Status Code: 400</p>
Throttling(String),
}
impl UpdateServerError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<UpdateServerError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"AccessDeniedException" => {
return RusotoError::Service(UpdateServerError::AccessDenied(err.msg))
}
"ConflictException" => {
return RusotoError::Service(UpdateServerError::Conflict(err.msg))
}
"InternalServiceError" => {
return RusotoError::Service(UpdateServerError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(UpdateServerError::InvalidRequest(err.msg))
}
"ResourceExistsException" => {
return RusotoError::Service(UpdateServerError::ResourceExists(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(UpdateServerError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(UpdateServerError::ServiceUnavailable(err.msg))
}
"ThrottlingException" => {
return RusotoError::Service(UpdateServerError::Throttling(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for UpdateServerError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
UpdateServerError::AccessDenied(ref cause) => write!(f, "{}", cause),
UpdateServerError::Conflict(ref cause) => write!(f, "{}", cause),
UpdateServerError::InternalServiceError(ref cause) => write!(f, "{}", cause),
UpdateServerError::InvalidRequest(ref cause) => write!(f, "{}", cause),
UpdateServerError::ResourceExists(ref cause) => write!(f, "{}", cause),
UpdateServerError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
UpdateServerError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
UpdateServerError::Throttling(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for UpdateServerError {}
/// Errors returned by UpdateUser
#[derive(Debug, PartialEq)]
pub enum UpdateUserError {
/// <p>This exception is thrown when an error occurs in the AWS Transfer Family service.</p>
InternalServiceError(String),
/// <p>This exception is thrown when the client submits a malformed request.</p>
InvalidRequest(String),
/// <p>This exception is thrown when a resource is not found by the AWS Transfer Family service.</p>
ResourceNotFound(String),
/// <p>The request has failed because the AWS Transfer Family service is not available.</p>
ServiceUnavailable(String),
/// <p>The request was denied due to request throttling.</p> <p> HTTP Status Code: 400</p>
Throttling(String),
}
impl UpdateUserError {
pub fn from_response(res: BufferedHttpResponse) -> RusotoError<UpdateUserError> {
if let Some(err) = proto::json::Error::parse(&res) {
match err.typ.as_str() {
"InternalServiceError" => {
return RusotoError::Service(UpdateUserError::InternalServiceError(err.msg))
}
"InvalidRequestException" => {
return RusotoError::Service(UpdateUserError::InvalidRequest(err.msg))
}
"ResourceNotFoundException" => {
return RusotoError::Service(UpdateUserError::ResourceNotFound(err.msg))
}
"ServiceUnavailableException" => {
return RusotoError::Service(UpdateUserError::ServiceUnavailable(err.msg))
}
"ThrottlingException" => {
return RusotoError::Service(UpdateUserError::Throttling(err.msg))
}
"ValidationException" => return RusotoError::Validation(err.msg),
_ => {}
}
}
RusotoError::Unknown(res)
}
}
impl fmt::Display for UpdateUserError {
#[allow(unused_variables)]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
UpdateUserError::InternalServiceError(ref cause) => write!(f, "{}", cause),
UpdateUserError::InvalidRequest(ref cause) => write!(f, "{}", cause),
UpdateUserError::ResourceNotFound(ref cause) => write!(f, "{}", cause),
UpdateUserError::ServiceUnavailable(ref cause) => write!(f, "{}", cause),
UpdateUserError::Throttling(ref cause) => write!(f, "{}", cause),
}
}
}
impl Error for UpdateUserError {}
/// Trait representing the capabilities of the AWS Transfer API. AWS Transfer clients implement this trait.
#[async_trait]
pub trait Transfer {
/// <p>Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated <code>ServerId</code> property that is assigned to the newly created server.</p>
async fn create_server(
&self,
input: CreateServerRequest,
) -> Result<CreateServerResponse, RusotoError<CreateServerError>>;
/// <p>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 <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for <code>CreateUser</code>, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.</p>
async fn create_user(
&self,
input: CreateUserRequest,
) -> Result<CreateUserResponse, RusotoError<CreateUserError>>;
/// <p>Deletes the file transfer protocol-enabled server that you specify.</p> <p>No response returns from this operation.</p>
async fn delete_server(
&self,
input: DeleteServerRequest,
) -> Result<(), RusotoError<DeleteServerError>>;
/// <p>Deletes a user's Secure Shell (SSH) public key.</p> <p>No response is returned from this operation.</p>
async fn delete_ssh_public_key(
&self,
input: DeleteSshPublicKeyRequest,
) -> Result<(), RusotoError<DeleteSshPublicKeyError>>;
/// <p><p>Deletes the user belonging to a file transfer protocol-enabled server you specify.</p> <p>No response returns from this operation.</p> <note> <p>When you delete a user from a server, the user's information is lost.</p> </note></p>
async fn delete_user(
&self,
input: DeleteUserRequest,
) -> Result<(), RusotoError<DeleteUserError>>;
/// <p>Describes a file transfer protocol-enabled server that you specify by passing the <code>ServerId</code> parameter.</p> <p>The response contains a description of a server's properties. When you set <code>EndpointType</code> to VPC, the response will contain the <code>EndpointDetails</code>.</p>
async fn describe_server(
&self,
input: DescribeServerRequest,
) -> Result<DescribeServerResponse, RusotoError<DescribeServerError>>;
/// <p>Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its <code>ServerId</code> property.</p> <p>The response from this call returns the properties of the user associated with the <code>ServerId</code> value that was specified.</p>
async fn describe_user(
&self,
input: DescribeUserRequest,
) -> Result<DescribeUserResponse, RusotoError<DescribeUserError>>;
/// <p>Adds a Secure Shell (SSH) public key to a user account identified by a <code>UserName</code> value assigned to the specific file transfer protocol-enabled server, identified by <code>ServerId</code>.</p> <p>The response returns the <code>UserName</code> value, the <code>ServerId</code> value, and the name of the <code>SshPublicKeyId</code>.</p>
async fn import_ssh_public_key(
&self,
input: ImportSshPublicKeyRequest,
) -> Result<ImportSshPublicKeyResponse, RusotoError<ImportSshPublicKeyError>>;
/// <p>Lists the file transfer protocol-enabled servers that are associated with your AWS account.</p>
async fn list_servers(
&self,
input: ListServersRequest,
) -> Result<ListServersResponse, RusotoError<ListServersError>>;
/// <p>Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.</p>
async fn list_tags_for_resource(
&self,
input: ListTagsForResourceRequest,
) -> Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>;
/// <p>Lists the users for a file transfer protocol-enabled server that you specify by passing the <code>ServerId</code> parameter.</p>
async fn list_users(
&self,
input: ListUsersRequest,
) -> Result<ListUsersResponse, RusotoError<ListUsersError>>;
/// <p>Changes the state of a file transfer protocol-enabled server from <code>OFFLINE</code> to <code>ONLINE</code>. It has no impact on a server that is already <code>ONLINE</code>. An <code>ONLINE</code> server can accept and process file transfer jobs.</p> <p>The state of <code>STARTING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of <code>START_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>
async fn start_server(
&self,
input: StartServerRequest,
) -> Result<(), RusotoError<StartServerError>>;
/// <p>Changes the state of a file transfer protocol-enabled server from <code>ONLINE</code> to <code>OFFLINE</code>. An <code>OFFLINE</code> server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. Stopping the server will not reduce or impact your file transfer protocol endpoint billing.</p> <p>The state of <code>STOPPING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>STOP_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>
async fn stop_server(
&self,
input: StopServerRequest,
) -> Result<(), RusotoError<StopServerError>>;
/// <p>Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>There is no response returned from this call.</p>
async fn tag_resource(
&self,
input: TagResourceRequest,
) -> Result<(), RusotoError<TagResourceError>>;
/// <p>If the <code>IdentityProviderType</code> of a file transfer protocol-enabled server is <code>API_Gateway</code>, tests whether your API Gateway 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 API Gateway integration to ensure that your users can successfully use the service.</p>
async fn test_identity_provider(
&self,
input: TestIdentityProviderRequest,
) -> Result<TestIdentityProviderResponse, RusotoError<TestIdentityProviderError>>;
/// <p>Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>No response is returned from this call.</p>
async fn untag_resource(
&self,
input: UntagResourceRequest,
) -> Result<(), RusotoError<UntagResourceError>>;
/// <p>Updates the file transfer protocol-enabled server's properties after that server has been created.</p> <p>The <code>UpdateServer</code> call returns the <code>ServerId</code> of the server you updated.</p>
async fn update_server(
&self,
input: UpdateServerRequest,
) -> Result<UpdateServerResponse, RusotoError<UpdateServerError>>;
/// <p>Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the <code>UserName</code> and <code>ServerId</code> you specify.</p> <p>The response returns the <code>ServerId</code> and the <code>UserName</code> for the updated user.</p>
async fn update_user(
&self,
input: UpdateUserRequest,
) -> Result<UpdateUserResponse, RusotoError<UpdateUserError>>;
}
/// A client for the AWS Transfer API.
#[derive(Clone)]
pub struct TransferClient {
client: Client,
region: region::Region,
}
impl TransferClient {
/// Creates a client backed by the default tokio event loop.
///
/// The client will use the default credentials provider and tls client.
pub fn new(region: region::Region) -> TransferClient {
TransferClient {
client: Client::shared(),
region,
}
}
pub fn new_with<P, D>(
request_dispatcher: D,
credentials_provider: P,
region: region::Region,
) -> TransferClient
where
P: ProvideAwsCredentials + Send + Sync + 'static,
D: DispatchSignedRequest + Send + Sync + 'static,
{
TransferClient {
client: Client::new_with(credentials_provider, request_dispatcher),
region,
}
}
pub fn new_with_client(client: Client, region: region::Region) -> TransferClient {
TransferClient { client, region }
}
}
#[async_trait]
impl Transfer for TransferClient {
/// <p>Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated <code>ServerId</code> property that is assigned to the newly created server.</p>
async fn create_server(
&self,
input: CreateServerRequest,
) -> Result<CreateServerResponse, RusotoError<CreateServerError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.CreateServer");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, CreateServerError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response).deserialize::<CreateServerResponse, _>()
}
/// <p>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 <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for <code>CreateUser</code>, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.</p>
async fn create_user(
&self,
input: CreateUserRequest,
) -> Result<CreateUserResponse, RusotoError<CreateUserError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.CreateUser");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, CreateUserError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response).deserialize::<CreateUserResponse, _>()
}
/// <p>Deletes the file transfer protocol-enabled server that you specify.</p> <p>No response returns from this operation.</p>
async fn delete_server(
&self,
input: DeleteServerRequest,
) -> Result<(), RusotoError<DeleteServerError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.DeleteServer");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, DeleteServerError::from_response)
.await?;
std::mem::drop(response);
Ok(())
}
/// <p>Deletes a user's Secure Shell (SSH) public key.</p> <p>No response is returned from this operation.</p>
async fn delete_ssh_public_key(
&self,
input: DeleteSshPublicKeyRequest,
) -> Result<(), RusotoError<DeleteSshPublicKeyError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.DeleteSshPublicKey");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, DeleteSshPublicKeyError::from_response)
.await?;
std::mem::drop(response);
Ok(())
}
/// <p><p>Deletes the user belonging to a file transfer protocol-enabled server you specify.</p> <p>No response returns from this operation.</p> <note> <p>When you delete a user from a server, the user's information is lost.</p> </note></p>
async fn delete_user(
&self,
input: DeleteUserRequest,
) -> Result<(), RusotoError<DeleteUserError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.DeleteUser");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, DeleteUserError::from_response)
.await?;
std::mem::drop(response);
Ok(())
}
/// <p>Describes a file transfer protocol-enabled server that you specify by passing the <code>ServerId</code> parameter.</p> <p>The response contains a description of a server's properties. When you set <code>EndpointType</code> to VPC, the response will contain the <code>EndpointDetails</code>.</p>
async fn describe_server(
&self,
input: DescribeServerRequest,
) -> Result<DescribeServerResponse, RusotoError<DescribeServerError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.DescribeServer");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, DescribeServerError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response).deserialize::<DescribeServerResponse, _>()
}
/// <p>Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its <code>ServerId</code> property.</p> <p>The response from this call returns the properties of the user associated with the <code>ServerId</code> value that was specified.</p>
async fn describe_user(
&self,
input: DescribeUserRequest,
) -> Result<DescribeUserResponse, RusotoError<DescribeUserError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.DescribeUser");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, DescribeUserError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response).deserialize::<DescribeUserResponse, _>()
}
/// <p>Adds a Secure Shell (SSH) public key to a user account identified by a <code>UserName</code> value assigned to the specific file transfer protocol-enabled server, identified by <code>ServerId</code>.</p> <p>The response returns the <code>UserName</code> value, the <code>ServerId</code> value, and the name of the <code>SshPublicKeyId</code>.</p>
async fn import_ssh_public_key(
&self,
input: ImportSshPublicKeyRequest,
) -> Result<ImportSshPublicKeyResponse, RusotoError<ImportSshPublicKeyError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.ImportSshPublicKey");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, ImportSshPublicKeyError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response).deserialize::<ImportSshPublicKeyResponse, _>()
}
/// <p>Lists the file transfer protocol-enabled servers that are associated with your AWS account.</p>
async fn list_servers(
&self,
input: ListServersRequest,
) -> Result<ListServersResponse, RusotoError<ListServersError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.ListServers");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, ListServersError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response).deserialize::<ListServersResponse, _>()
}
/// <p>Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.</p>
async fn list_tags_for_resource(
&self,
input: ListTagsForResourceRequest,
) -> Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.ListTagsForResource");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, ListTagsForResourceError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response).deserialize::<ListTagsForResourceResponse, _>()
}
/// <p>Lists the users for a file transfer protocol-enabled server that you specify by passing the <code>ServerId</code> parameter.</p>
async fn list_users(
&self,
input: ListUsersRequest,
) -> Result<ListUsersResponse, RusotoError<ListUsersError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.ListUsers");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, ListUsersError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response).deserialize::<ListUsersResponse, _>()
}
/// <p>Changes the state of a file transfer protocol-enabled server from <code>OFFLINE</code> to <code>ONLINE</code>. It has no impact on a server that is already <code>ONLINE</code>. An <code>ONLINE</code> server can accept and process file transfer jobs.</p> <p>The state of <code>STARTING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of <code>START_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>
async fn start_server(
&self,
input: StartServerRequest,
) -> Result<(), RusotoError<StartServerError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.StartServer");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, StartServerError::from_response)
.await?;
std::mem::drop(response);
Ok(())
}
/// <p>Changes the state of a file transfer protocol-enabled server from <code>ONLINE</code> to <code>OFFLINE</code>. An <code>OFFLINE</code> server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. Stopping the server will not reduce or impact your file transfer protocol endpoint billing.</p> <p>The state of <code>STOPPING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>STOP_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>
async fn stop_server(
&self,
input: StopServerRequest,
) -> Result<(), RusotoError<StopServerError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.StopServer");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, StopServerError::from_response)
.await?;
std::mem::drop(response);
Ok(())
}
/// <p>Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>There is no response returned from this call.</p>
async fn tag_resource(
&self,
input: TagResourceRequest,
) -> Result<(), RusotoError<TagResourceError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.TagResource");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, TagResourceError::from_response)
.await?;
std::mem::drop(response);
Ok(())
}
/// <p>If the <code>IdentityProviderType</code> of a file transfer protocol-enabled server is <code>API_Gateway</code>, tests whether your API Gateway 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 API Gateway integration to ensure that your users can successfully use the service.</p>
async fn test_identity_provider(
&self,
input: TestIdentityProviderRequest,
) -> Result<TestIdentityProviderResponse, RusotoError<TestIdentityProviderError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.TestIdentityProvider");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, TestIdentityProviderError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response)
.deserialize::<TestIdentityProviderResponse, _>()
}
/// <p>Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>No response is returned from this call.</p>
async fn untag_resource(
&self,
input: UntagResourceRequest,
) -> Result<(), RusotoError<UntagResourceError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.UntagResource");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, UntagResourceError::from_response)
.await?;
std::mem::drop(response);
Ok(())
}
/// <p>Updates the file transfer protocol-enabled server's properties after that server has been created.</p> <p>The <code>UpdateServer</code> call returns the <code>ServerId</code> of the server you updated.</p>
async fn update_server(
&self,
input: UpdateServerRequest,
) -> Result<UpdateServerResponse, RusotoError<UpdateServerError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.UpdateServer");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, UpdateServerError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response).deserialize::<UpdateServerResponse, _>()
}
/// <p>Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the <code>UserName</code> and <code>ServerId</code> you specify.</p> <p>The response returns the <code>ServerId</code> and the <code>UserName</code> for the updated user.</p>
async fn update_user(
&self,
input: UpdateUserRequest,
) -> Result<UpdateUserResponse, RusotoError<UpdateUserError>> {
let mut request = self.new_signed_request("POST", "/");
request.add_header("x-amz-target", "TransferService.UpdateUser");
let encoded = serde_json::to_string(&input).unwrap();
request.set_payload(Some(encoded));
let response = self
.sign_and_dispatch(request, UpdateUserError::from_response)
.await?;
let mut response = response;
let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?;
proto::json::ResponsePayload::new(&response).deserialize::<UpdateUserResponse, _>()
}
}