AWS Transfer Family

{'SourceIp': 'string'}

If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, 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.

See also: AWS API Documentation

Request Syntax

client.test_identity_provider(
    ServerId='string',
    ServerProtocol='SFTP'|'FTP'|'FTPS',
    SourceIp='string',
    UserName='string',
    UserPassword='string'
)

type ServerId:

string

param ServerId:

[REQUIRED]

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.

type ServerProtocol:

string

param ServerProtocol:

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)

type SourceIp:

string

param SourceIp:

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

type UserName:

string

param UserName:

[REQUIRED]

The name of the user account to be tested.

type UserPassword:

string

param UserPassword:

The password of the user account to be tested.

rtype:

dict

returns:

Response Syntax

{
    'Response': 'string',
    'StatusCode': 123,
    'Message': 'string',
    'Url': 'string'
}

Response Structure

• (dict) --

  • Response (string) --

    The response that is returned from your API Gateway.

  • StatusCode (integer) --

    The HTTP status code that is the response from your API Gateway.

  • Message (string) --

    A message that indicates whether the test was successful or not.

  • Url (string) --

    The endpoint of the service used to authenticate a user.