« blib/lib/Paws/Synthetics/DeleteCanaryResponse.pm
↑ Summary
blib/lib/Paws/Synthetics/DescribeCanariesLastRun.pm »
| 1 | |||
| 2 | package Paws::Synthetics::DescribeCanaries; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeCanaries'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/canaries'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Synthetics::DescribeCanariesResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Synthetics::DescribeCanaries - Arguments for method DescribeCanaries on L<Paws::Synthetics> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeCanaries on the | ||
| 24 | L<Synthetics|Paws::Synthetics> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeCanaries. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCanaries. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $synthetics = Paws->service('Synthetics'); | ||
| 32 | my $DescribeCanariesResponse = $synthetics->DescribeCanaries( | ||
| 33 | MaxResults => 1, # OPTIONAL | ||
| 34 | NextToken => 'MyToken', # OPTIONAL | ||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $Canaries = $DescribeCanariesResponse->Canaries; | ||
| 39 | my $NextToken = $DescribeCanariesResponse->NextToken; | ||
| 40 | |||
| 41 | # Returns a L<Paws::Synthetics::DescribeCanariesResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/synthetics/DescribeCanaries> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 MaxResults => Int | ||
| 50 | |||
| 51 | Specify this parameter to limit how many canaries are returned each | ||
| 52 | time you use the C<DescribeCanaries> operation. If you omit this | ||
| 53 | parameter, the default of 100 is used. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 NextToken => Str | ||
| 58 | |||
| 59 | A token that indicates that there is more data available. You can use | ||
| 60 | this token in a subsequent operation to retrieve the next set of | ||
| 61 | results. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head1 SEE ALSO | ||
| 67 | |||
| 68 | This class forms part of L<Paws>, documenting arguments for method DescribeCanaries in L<Paws::Synthetics> | ||
| 69 | |||
| 70 | =head1 BUGS and CONTRIBUTIONS | ||
| 71 | |||
| 72 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 73 | |||
| 74 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 75 | |||
| 76 | =cut | ||
| 77 |