Struct aws_sdk_transfer::client::fluent_builders::TestIdentityProvider

pub struct TestIdentityProvider { /* private fields */ }

Fluent builder constructing a request to TestIdentityProvider.

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

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

You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.

• If you provide any incorrect values for any parameters, the Response field is empty.

• If you provide a server ID for a server that uses service-managed users, you get an error:

  An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth

• If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:

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

Implementations

impl TestIdentityProvider

pub async fn send(
    self
) -> Result<TestIdentityProviderOutput, SdkError<TestIdentityProviderError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn server_id(self, input: impl Into<String>) -> Self

A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

pub fn set_server_id(self, input: Option<String>) -> Self

A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

pub fn server_protocol(self, input: Protocol) -> Self

The type of file transfer protocol to be tested.

The available protocols are:

• Secure Shell (SSH) File Transfer Protocol (SFTP)

• File Transfer Protocol Secure (FTPS)

• File Transfer Protocol (FTP)

pub fn set_server_protocol(self, input: Option<Protocol>) -> Self

The type of file transfer protocol to be tested.

The available protocols are:

• Secure Shell (SSH) File Transfer Protocol (SFTP)

• File Transfer Protocol Secure (FTPS)

• File Transfer Protocol (FTP)

pub fn source_ip(self, input: impl Into<String>) -> Self

The source IP address of the user account to be tested.

pub fn set_source_ip(self, input: Option<String>) -> Self

The source IP address of the user account to be tested.

pub fn user_name(self, input: impl Into<String>) -> Self

The name of the user account to be tested.

pub fn set_user_name(self, input: Option<String>) -> Self

The name of the user account to be tested.

pub fn user_password(self, input: impl Into<String>) -> Self

The password of the user account to be tested.

pub fn set_user_password(self, input: Option<String>) -> Self

The password of the user account to be tested.

Trait Implementations

impl Clone for TestIdentityProvider

fn clone(&self) -> TestIdentityProvider

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TestIdentityProvider

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.