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