File Coverage

blib/lib/Paws/GameLift/ListAliases.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::GameLift::ListAliases;
3 1     1   583 use Moose;
  1         3  
  1         9  
4             has Limit => (is => 'ro', isa => 'Int');
5             has Name => (is => 'ro', isa => 'Str');
6             has NextToken => (is => 'ro', isa => 'Str');
7             has RoutingStrategyType => (is => 'ro', isa => 'Str');
8              
9 1     1   6706 use MooseX::ClassAttribute;
  1         2  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListAliases');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::ListAliasesOutput');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::GameLift::ListAliases - Arguments for method ListAliases on Paws::GameLift
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method ListAliases on the
25             Amazon GameLift service. Use the attributes of this class
26             as arguments to method ListAliases.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListAliases.
29              
30             As an example:
31              
32             $service_obj->ListAliases(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 Limit => Int
40              
41             Maximum number of results to return. Use this parameter with
42             C<NextToken> to get results as a set of sequential pages.
43              
44              
45              
46             =head2 Name => Str
47              
48             Descriptive label that is associated with an alias. Alias names do not
49             need to be unique.
50              
51              
52              
53             =head2 NextToken => Str
54              
55             Token that indicates the start of the next sequential page of results.
56             Use the token that is returned with a previous call to this action. To
57             specify the start of the result set, do not specify a value.
58              
59              
60              
61             =head2 RoutingStrategyType => Str
62              
63             Type of routing to filter results on. Use this parameter to retrieve
64             only aliases of a certain type. To retrieve all aliases, leave this
65             parameter empty.
66              
67             Possible routing types include the following:
68              
69             =over
70              
71             =item *
72              
73             B<SIMPLE> E<ndash> The alias resolves to one specific fleet. Use this
74             type when routing to active fleets.
75              
76             =item *
77              
78             B<TERMINAL> E<ndash> The alias does not resolve to a fleet but instead
79             can be used to display a message to the user. A terminal alias throws a
80             TerminalRoutingStrategyException with the RoutingStrategy message
81             embedded.
82              
83             =back
84              
85              
86             Valid values are: C<"SIMPLE">, C<"TERMINAL">
87              
88              
89             =head1 SEE ALSO
90              
91             This class forms part of L<Paws>, documenting arguments for method ListAliases in L<Paws::GameLift>
92              
93             =head1 BUGS and CONTRIBUTIONS
94              
95             The source code is located here: https://github.com/pplu/aws-sdk-perl
96              
97             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
98              
99             =cut
100