test-identity-provider¶
Description¶
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
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
test-identity-provider
--server-id <value>
[--server-protocol <value>]
[--source-ip <value>]
--user-name <value>
[--user-password <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--server-id (string)
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.
--server-protocol (string)
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)
Possible values:
SFTP
FTP
FTPS
--source-ip (string)
The source IP address of the user account to be tested.
--user-name (string)
The name of the user account to be tested.
--user-password (string)
The password of the user account to be tested.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
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.