« blib/lib/Paws/Lightsail/GetBundlesResult.pm
↑ Summary
blib/lib/Paws/Lightsail/GetCertificatesResult.pm »
| 1 | |||
| 2 | package Paws::Lightsail::GetCertificates; | ||
| 3 | use Moose; | ||
| 4 | has CertificateName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateName' ); | ||
| 5 | has CertificateStatuses => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'certificateStatuses' ); | ||
| 6 | has IncludeCertificateDetails => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeCertificateDetails' ); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetCertificates'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::GetCertificatesResult'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Lightsail::GetCertificates - Arguments for method GetCertificates on L<Paws::Lightsail> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetCertificates on the | ||
| 24 | L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class | ||
| 25 | as arguments to method GetCertificates. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetCertificates. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $lightsail = Paws->service('Lightsail'); | ||
| 32 | my $GetCertificatesResult = $lightsail->GetCertificates( | ||
| 33 | CertificateName => 'MyCertificateName', # OPTIONAL | ||
| 34 | CertificateStatuses => [ | ||
| 35 | 'PENDING_VALIDATION', | ||
| 36 | ... # values: PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, VALIDATION_TIMED_OUT, REVOKED, FAILED | ||
| 37 | ], # OPTIONAL | ||
| 38 | IncludeCertificateDetails => 1, # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $Certificates = $GetCertificatesResult->Certificates; | ||
| 43 | |||
| 44 | # Returns a L<Paws::Lightsail::GetCertificatesResult> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/GetCertificates> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 CertificateName => Str | ||
| 53 | |||
| 54 | The name for the certificate for which to return information. | ||
| 55 | |||
| 56 | When omitted, the response includes all of your certificates in the AWS | ||
| 57 | Region where the request is made. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 CertificateStatuses => ArrayRef[Str|Undef] | ||
| 62 | |||
| 63 | The status of the certificates for which to return information. | ||
| 64 | |||
| 65 | For example, specify C<ISSUED> to return only certificates with an | ||
| 66 | C<ISSUED> status. | ||
| 67 | |||
| 68 | When omitted, the response includes all of your certificates in the AWS | ||
| 69 | Region where the request is made, regardless of their current status. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 IncludeCertificateDetails => Bool | ||
| 74 | |||
| 75 | Indicates whether to include detailed information about the | ||
| 76 | certificates in the response. | ||
| 77 | |||
| 78 | When omitted, the response includes only the certificate names, Amazon | ||
| 79 | Resource Names (ARNs), domain names, and tags. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method GetCertificates in L<Paws::Lightsail> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |