« blib/lib/Paws/AppMesh/ListTagsForResourceOutput.pm
↑ Summary
blib/lib/Paws/AppMesh/ListVirtualGatewaysOutput.pm »
| 1 | |||
| 2 | package Paws::AppMesh::ListVirtualGateways; | ||
| 3 | use Moose; | ||
| 4 | has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit'); | ||
| 5 | has MeshName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'meshName', required => 1); | ||
| 6 | has MeshOwner => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'meshOwner'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListVirtualGateways'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20190125/meshes/{meshName}/virtualGateways'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppMesh::ListVirtualGatewaysOutput'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::AppMesh::ListVirtualGateways - Arguments for method ListVirtualGateways on L<Paws::AppMesh> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListVirtualGateways on the | ||
| 26 | L<AWS App Mesh|Paws::AppMesh> service. Use the attributes of this class | ||
| 27 | as arguments to method ListVirtualGateways. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListVirtualGateways. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $appmesh = Paws->service('AppMesh'); | ||
| 34 | my $ListVirtualGatewaysOutput = $appmesh->ListVirtualGateways( | ||
| 35 | MeshName => 'MyResourceName', | ||
| 36 | Limit => 1, # OPTIONAL | ||
| 37 | MeshOwner => 'MyAccountId', # OPTIONAL | ||
| 38 | NextToken => 'MyString', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $NextToken = $ListVirtualGatewaysOutput->NextToken; | ||
| 43 | my $VirtualGateways = $ListVirtualGatewaysOutput->VirtualGateways; | ||
| 44 | |||
| 45 | # Returns a L<Paws::AppMesh::ListVirtualGatewaysOutput> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appmesh/ListVirtualGateways> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Limit => Int | ||
| 54 | |||
| 55 | The maximum number of results returned by C<ListVirtualGateways> in | ||
| 56 | paginated output. When you use this parameter, C<ListVirtualGateways> | ||
| 57 | returns only C<limit> results in a single page along with a | ||
| 58 | C<nextToken> response element. You can see the remaining results of the | ||
| 59 | initial request by sending another C<ListVirtualGateways> request with | ||
| 60 | the returned C<nextToken> value. This value can be between 1 and 100. | ||
| 61 | If you don't use this parameter, C<ListVirtualGateways> returns up to | ||
| 62 | 100 results and a C<nextToken> value if applicable. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> MeshName => Str | ||
| 67 | |||
| 68 | The name of the service mesh to list virtual gateways in. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 MeshOwner => Str | ||
| 73 | |||
| 74 | The AWS IAM account ID of the service mesh owner. If the account ID is | ||
| 75 | not your own, then it's the ID of the account that shared the mesh with | ||
| 76 | your account. For more information about mesh sharing, see Working with | ||
| 77 | shared meshes | ||
| 78 | (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 NextToken => Str | ||
| 83 | |||
| 84 | The C<nextToken> value returned from a previous paginated | ||
| 85 | C<ListVirtualGateways> request where C<limit> was used and the results | ||
| 86 | exceeded the value of that parameter. Pagination continues from the end | ||
| 87 | of the previous results that returned the C<nextToken> value. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, documenting arguments for method ListVirtualGateways in L<Paws::AppMesh> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |