File Coverage

blib/lib/Paws/ECS/ListAttributes.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::ECS::ListAttributes;
3 1     1   481 use Moose;
  1         4  
  1         10  
4             has AttributeName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'attributeName' );
5             has AttributeValue => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'attributeValue' );
6             has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' );
7             has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' );
8             has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
9             has TargetType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'targetType' , required => 1);
10              
11 1     1   6553 use MooseX::ClassAttribute;
  1         3  
  1         12  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListAttributes');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::ListAttributesResponse');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::ECS::ListAttributes - Arguments for method ListAttributes on Paws::ECS
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method ListAttributes on the
27             Amazon EC2 Container Service service. Use the attributes of this class
28             as arguments to method ListAttributes.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListAttributes.
31              
32             As an example:
33              
34             $service_obj->ListAttributes(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 AttributeName => Str
42              
43             The name of the attribute with which to filter the results.
44              
45              
46              
47             =head2 AttributeValue => Str
48              
49             The value of the attribute with which to filter results. You must also
50             specify an attribute name to use this parameter.
51              
52              
53              
54             =head2 Cluster => Str
55              
56             The short name or full Amazon Resource Name (ARN) of the cluster to
57             list attributes. If you do not specify a cluster, the default cluster
58             is assumed.
59              
60              
61              
62             =head2 MaxResults => Int
63              
64             The maximum number of cluster results returned by C<ListAttributes> in
65             paginated output. When this parameter is used, C<ListAttributes> only
66             returns C<maxResults> results in a single page along with a
67             C<nextToken> response element. The remaining results of the initial
68             request can be seen by sending another C<ListAttributes> request with
69             the returned C<nextToken> value. This value can be between 1 and 100.
70             If this parameter is not used, then C<ListAttributes> returns up to 100
71             results and a C<nextToken> value if applicable.
72              
73              
74              
75             =head2 NextToken => Str
76              
77             The C<nextToken> value returned from a previous paginated
78             C<ListAttributes> request where C<maxResults> was used and the results
79             exceeded the value of that parameter. Pagination continues from the end
80             of the previous results that returned the C<nextToken> value. This
81             value is C<null> when there are no more results to return.
82              
83             This token should be treated as an opaque identifier that is only used
84             to retrieve the next items in a list and not for other programmatic
85             purposes.
86              
87              
88              
89             =head2 B<REQUIRED> TargetType => Str
90              
91             The type of the target with which to list attributes.
92              
93             Valid values are: C<"container-instance">
94              
95              
96             =head1 SEE ALSO
97              
98             This class forms part of L<Paws>, documenting arguments for method ListAttributes in L<Paws::ECS>
99              
100             =head1 BUGS and CONTRIBUTIONS
101              
102             The source code is located here: https://github.com/pplu/aws-sdk-perl
103              
104             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
105              
106             =cut
107