/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Transfer::TestIdentityProvider

NAME

Paws::Transfer::TestIdentityProvider - Arguments for method TestIdentityProvider on Paws::Transfer

DESCRIPTION

This class represents the parameters used for calling the method TestIdentityProvider on the AWS Transfer Family service. Use the attributes of this class as arguments to method TestIdentityProvider.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TestIdentityProvider.

SYNOPSIS

my $transfer = Paws->service('Transfer');
my $TestIdentityProviderResponse = $transfer->TestIdentityProvider(
  ServerId       => 'MyServerId',
  UserName       => 'MyUserName',
  ServerProtocol => 'SFTP',              # OPTIONAL
  SourceIp       => 'MySourceIp',        # OPTIONAL
  UserPassword   => 'MyUserPassword',    # OPTIONAL
);

# Results:
my $Message    = $TestIdentityProviderResponse->Message;
my $Response   = $TestIdentityProviderResponse->Response;
my $StatusCode = $TestIdentityProviderResponse->StatusCode;
my $Url        = $TestIdentityProviderResponse->Url;

# Returns a L<Paws::Transfer::TestIdentityProviderResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/transfer/TestIdentityProvider

ATTRIBUTES

REQUIRED ServerId => Str

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

ServerProtocol => Str

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)

Valid values are: "SFTP", "FTP", "FTPS"

SourceIp => Str

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

REQUIRED UserName => Str

The name of the user account to be tested.

UserPassword => Str

The password of the user account to be tested.

SEE ALSO

This class forms part of Paws, documenting arguments for method TestIdentityProvider in Paws::Transfer

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues