« blib/lib/Paws/EC2/DescribeClientVpnAuthorizationRulesResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeClientVpnConnectionsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeClientVpnConnections; | ||
| 3 | use Moose; | ||
| 4 | has ClientVpnEndpointId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 6 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClientVpnConnections'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeClientVpnConnectionsResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EC2::DescribeClientVpnConnections - Arguments for method DescribeClientVpnConnections on L<Paws::EC2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeClientVpnConnections on the | ||
| 26 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeClientVpnConnections. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeClientVpnConnections. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ec2 = Paws->service('EC2'); | ||
| 34 | my $DescribeClientVpnConnectionsResult = $ec2->DescribeClientVpnConnections( | ||
| 35 | ClientVpnEndpointId => 'MyClientVpnEndpointId', | ||
| 36 | DryRun => 1, # OPTIONAL | ||
| 37 | Filters => [ | ||
| 38 | { | ||
| 39 | Name => 'MyString', # OPTIONAL | ||
| 40 | Values => [ | ||
| 41 | 'MyString', ... # OPTIONAL | ||
| 42 | ], # OPTIONAL | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $Connections = $DescribeClientVpnConnectionsResult->Connections; | ||
| 52 | my $NextToken = $DescribeClientVpnConnectionsResult->NextToken; | ||
| 53 | |||
| 54 | # Returns a L<Paws::EC2::DescribeClientVpnConnectionsResult> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeClientVpnConnections> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> ClientVpnEndpointId => Str | ||
| 63 | |||
| 64 | The ID of the Client VPN endpoint. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 DryRun => Bool | ||
| 69 | |||
| 70 | Checks whether you have the required permissions for the action, | ||
| 71 | without actually making the request, and provides an error response. If | ||
| 72 | you have the required permissions, the error response is | ||
| 73 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 78 | |||
| 79 | One or more filters. Filter names and values are case-sensitive. | ||
| 80 | |||
| 81 | =over | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<connection-id> - The ID of the connection. | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<username> - For Active Directory client authentication, the user name | ||
| 90 | of the client who established the client connection. | ||
| 91 | |||
| 92 | =back | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 MaxResults => Int | ||
| 98 | |||
| 99 | The maximum number of results to return for the request in a single | ||
| 100 | page. The remaining results can be seen by sending another request with | ||
| 101 | the nextToken value. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 NextToken => Str | ||
| 106 | |||
| 107 | The token to retrieve the next page of results. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, documenting arguments for method DescribeClientVpnConnections in L<Paws::EC2> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |