« blib/lib/Paws/Synthetics/EnvironmentVariablesMap.pm
↑ Summary
blib/lib/Paws/Synthetics/GetCanaryResponse.pm »
| 1 | |||
| 2 | package Paws::Synthetics::GetCanary; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 5 | |||
| 6 | use MooseX::ClassAttribute; | ||
| 7 | |||
| 8 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetCanary'); | ||
| 9 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/canary/{name}'); | ||
| 10 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Synthetics::GetCanaryResponse'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Synthetics::GetCanary - Arguments for method GetCanary on L<Paws::Synthetics> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method GetCanary on the | ||
| 23 | L<Synthetics|Paws::Synthetics> service. Use the attributes of this class | ||
| 24 | as arguments to method GetCanary. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetCanary. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $synthetics = Paws->service('Synthetics'); | ||
| 31 | my $GetCanaryResponse = $synthetics->GetCanary( | ||
| 32 | Name => 'MyCanaryName', | ||
| 33 | |||
| 34 | ); | ||
| 35 | |||
| 36 | # Results: | ||
| 37 | my $Canary = $GetCanaryResponse->Canary; | ||
| 38 | |||
| 39 | # Returns a L<Paws::Synthetics::GetCanaryResponse> object. | ||
| 40 | |||
| 41 | 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. | ||
| 42 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/synthetics/GetCanary> | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> Name => Str | ||
| 48 | |||
| 49 | The name of the canary that you want details for. | ||
| 50 | |||
| 51 | |||
| 52 | |||
| 53 | |||
| 54 | =head1 SEE ALSO | ||
| 55 | |||
| 56 | This class forms part of L<Paws>, documenting arguments for method GetCanary in L<Paws::Synthetics> | ||
| 57 | |||
| 58 | =head1 BUGS and CONTRIBUTIONS | ||
| 59 | |||
| 60 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 61 | |||
| 62 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 63 | |||
| 64 | =cut | ||
| 65 |