« blib/lib/Paws/Transfer/TagResource.pm
↑ Summary
blib/lib/Paws/Transfer/TestIdentityProviderResponse.pm »
| 1 | |||
| 2 | package Paws::Transfer::TestIdentityProvider; | ||
| 3 | use Moose; | ||
| 4 | has ServerId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ServerProtocol => (is => 'ro', isa => 'Str'); | ||
| 6 | has SourceIp => (is => 'ro', isa => 'Str'); | ||
| 7 | has UserName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has UserPassword => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'TestIdentityProvider'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Transfer::TestIdentityProviderResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Transfer::TestIdentityProvider - Arguments for method TestIdentityProvider on L<Paws::Transfer> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method TestIdentityProvider on the | ||
| 26 | L<AWS Transfer Family|Paws::Transfer> service. Use the attributes of this class | ||
| 27 | as arguments to method TestIdentityProvider. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TestIdentityProvider. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $transfer = Paws->service('Transfer'); | ||
| 34 | my $TestIdentityProviderResponse = $transfer->TestIdentityProvider( | ||
| 35 | ServerId => 'MyServerId', | ||
| 36 | UserName => 'MyUserName', | ||
| 37 | ServerProtocol => 'SFTP', # OPTIONAL | ||
| 38 | SourceIp => 'MySourceIp', # OPTIONAL | ||
| 39 | UserPassword => 'MyUserPassword', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $Message = $TestIdentityProviderResponse->Message; | ||
| 44 | my $Response = $TestIdentityProviderResponse->Response; | ||
| 45 | my $StatusCode = $TestIdentityProviderResponse->StatusCode; | ||
| 46 | my $Url = $TestIdentityProviderResponse->Url; | ||
| 47 | |||
| 48 | # Returns a L<Paws::Transfer::TestIdentityProviderResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/transfer/TestIdentityProvider> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> ServerId => Str | ||
| 57 | |||
| 58 | A system-assigned identifier for a specific server. That server's user | ||
| 59 | authentication method is tested with a user name and password. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 ServerProtocol => Str | ||
| 64 | |||
| 65 | The type of file transfer protocol to be tested. | ||
| 66 | |||
| 67 | The available protocols are: | ||
| 68 | |||
| 69 | =over | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | Secure Shell (SSH) File Transfer Protocol (SFTP) | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | File Transfer Protocol Secure (FTPS) | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | File Transfer Protocol (FTP) | ||
| 82 | |||
| 83 | =back | ||
| 84 | |||
| 85 | |||
| 86 | Valid values are: C<"SFTP">, C<"FTP">, C<"FTPS"> | ||
| 87 | |||
| 88 | =head2 SourceIp => Str | ||
| 89 | |||
| 90 | The source IP address of the user account to be tested. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> UserName => Str | ||
| 95 | |||
| 96 | The name of the user account to be tested. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 UserPassword => Str | ||
| 101 | |||
| 102 | The password of the user account to be tested. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head1 SEE ALSO | ||
| 108 | |||
| 109 | This class forms part of L<Paws>, documenting arguments for method TestIdentityProvider in L<Paws::Transfer> | ||
| 110 | |||
| 111 | =head1 BUGS and CONTRIBUTIONS | ||
| 112 | |||
| 113 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 114 | |||
| 115 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 116 | |||
| 117 | =cut | ||
| 118 |