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