AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE
or API_Gateway, tests whether your identity provider is set up successfully.
We highly recommend that you call this operation to test your authentication method
as soon as you create your server. By doing so, you can troubleshoot issues with the
identity provider integration to ensure that your users can successfully use the service.
The ServerId and UserName parameters are required. The ServerProtocol,
SourceIp, and UserPassword are all optional.
Note the following:
You cannot use TestIdentityProvider if the IdentityProviderType of
your server is SERVICE_MANAGED.
TestIdentityProvider does not work with keys: it only accepts passwords.
TestIdentityProvider can test the password operation for a custom Identity
Provider that handles keys and passwords.
If you provide any incorrect values for any parameters, the Response field
is empty.
If you provide a server ID for a server that uses service-managed users, you get an error:
An error occurred (InvalidRequestException) when calling the TestIdentityProvider
operation: s-server-ID not configured for external auth
If you enter a Server ID for the --server-id parameter that does not identify
an actual Transfer server, you receive the following error:
An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider
operation: Unknown server.
It is possible your sever is in a different region. You can specify a region by adding
the following: --region region-code, such as --region us-east-2 to specify
a server in US East (Ohio).
For .NET Core this operation is only available in asynchronous form. Please refer to TestIdentityProviderAsync.
Namespace: Amazon.Transfer
Assembly: AWSSDK.Transfer.dll
Version: 3.x.y.z
public abstract TestIdentityProviderResponse TestIdentityProvider( TestIdentityProviderRequest request )
Container for the necessary parameters to execute the TestIdentityProvider service method.
| Exception | Condition |
|---|---|
| InternalServiceErrorException | This exception is thrown when an error occurs in the Transfer Family service. |
| InvalidRequestException | This exception is thrown when the client submits a malformed request. |
| ResourceNotFoundException | This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service. |
| ServiceUnavailableException | The request has failed because the Amazon Web ServicesTransfer Family service is not available. |
.NET Framework:
Supported in: 4.5 and newer, 3.5