File Coverage

blib/lib/Paws/ACM.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::ACM;
2 1     1   463 use Moose;
  1         2  
  1         8  
3             sub service { 'acm' }
4             sub version { '2015-12-08' }
5             sub target_prefix { 'CertificateManager' }
6             sub json_version { "1.1" }
7             has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8             has retry => (is => 'ro', isa => 'HashRef', default => sub {
9             { base => 'rand', type => 'exponential', growth_factor => 2 }
10             });
11             has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12             ] });
13              
14             with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller', 'Paws::Net::JsonResponse';
15              
16            
17             sub AddTagsToCertificate {
18             my $self = shift;
19             my $call_object = $self->new_with_coercions('Paws::ACM::AddTagsToCertificate', @_);
20             return $self->caller->do_call($self, $call_object);
21             }
22             sub DeleteCertificate {
23             my $self = shift;
24             my $call_object = $self->new_with_coercions('Paws::ACM::DeleteCertificate', @_);
25             return $self->caller->do_call($self, $call_object);
26             }
27             sub DescribeCertificate {
28             my $self = shift;
29             my $call_object = $self->new_with_coercions('Paws::ACM::DescribeCertificate', @_);
30             return $self->caller->do_call($self, $call_object);
31             }
32             sub GetCertificate {
33             my $self = shift;
34             my $call_object = $self->new_with_coercions('Paws::ACM::GetCertificate', @_);
35             return $self->caller->do_call($self, $call_object);
36             }
37             sub ImportCertificate {
38             my $self = shift;
39             my $call_object = $self->new_with_coercions('Paws::ACM::ImportCertificate', @_);
40             return $self->caller->do_call($self, $call_object);
41             }
42             sub ListCertificates {
43             my $self = shift;
44             my $call_object = $self->new_with_coercions('Paws::ACM::ListCertificates', @_);
45             return $self->caller->do_call($self, $call_object);
46             }
47             sub ListTagsForCertificate {
48             my $self = shift;
49             my $call_object = $self->new_with_coercions('Paws::ACM::ListTagsForCertificate', @_);
50             return $self->caller->do_call($self, $call_object);
51             }
52             sub RemoveTagsFromCertificate {
53             my $self = shift;
54             my $call_object = $self->new_with_coercions('Paws::ACM::RemoveTagsFromCertificate', @_);
55             return $self->caller->do_call($self, $call_object);
56             }
57             sub RequestCertificate {
58             my $self = shift;
59             my $call_object = $self->new_with_coercions('Paws::ACM::RequestCertificate', @_);
60             return $self->caller->do_call($self, $call_object);
61             }
62             sub ResendValidationEmail {
63             my $self = shift;
64             my $call_object = $self->new_with_coercions('Paws::ACM::ResendValidationEmail', @_);
65             return $self->caller->do_call($self, $call_object);
66             }
67            
68             sub ListAllCertificates {
69             my $self = shift;
70              
71             my $callback = shift @_ if (ref($_[0]) eq 'CODE');
72             my $result = $self->ListCertificates(@_);
73             my $next_result = $result;
74              
75             if (not defined $callback) {
76             while ($next_result->NextToken) {
77             $next_result = $self->ListCertificates(@_, NextToken => $next_result->NextToken);
78             push @{ $result->CertificateSummaryList }, @{ $next_result->CertificateSummaryList };
79             }
80             return $result;
81             } else {
82             while ($result->NextToken) {
83             $callback->($_ => 'CertificateSummaryList') foreach (@{ $result->CertificateSummaryList });
84             $result = $self->ListCertificates(@_, NextToken => $result->NextToken);
85             }
86             $callback->($_ => 'CertificateSummaryList') foreach (@{ $result->CertificateSummaryList });
87             }
88              
89             return undef
90             }
91              
92              
93             sub operations { qw/AddTagsToCertificate DeleteCertificate DescribeCertificate GetCertificate ImportCertificate ListCertificates ListTagsForCertificate RemoveTagsFromCertificate RequestCertificate ResendValidationEmail / }
94              
95             1;
96              
97             ### main pod documentation begin ###
98              
99             =head1 NAME
100              
101             Paws::ACM - Perl Interface to AWS AWS Certificate Manager
102              
103             =head1 SYNOPSIS
104              
105             use Paws;
106              
107             my $obj = Paws->service('ACM');
108             my $res = $obj->Method(
109             Arg1 => $val1,
110             Arg2 => [ 'V1', 'V2' ],
111             # if Arg3 is an object, the HashRef will be used as arguments to the constructor
112             # of the arguments type
113             Arg3 => { Att1 => 'Val1' },
114             # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
115             # the constructor of the arguments type
116             Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
117             );
118              
119             =head1 DESCRIPTION
120              
121             AWS Certificate Manager
122              
123             Welcome to the AWS Certificate Manager (ACM) API documentation.
124              
125             You can use ACM to manage SSL/TLS certificates for your AWS-based
126             websites and applications. For general information about using ACM, see
127             the I<AWS Certificate Manager User Guide> .
128              
129             =head1 METHODS
130              
131             =head2 AddTagsToCertificate(CertificateArn => Str, Tags => ArrayRef[L<Paws::ACM::Tag>])
132              
133             Each argument is described in detail in: L<Paws::ACM::AddTagsToCertificate>
134              
135             Returns: nothing
136              
137             Adds one or more tags to an ACM Certificate. Tags are labels that you
138             can use to identify and organize your AWS resources. Each tag consists
139             of a C<key> and an optional C<value>. You specify the certificate on
140             input by its Amazon Resource Name (ARN). You specify the tag by using a
141             key-value pair.
142              
143             You can apply a tag to just one certificate if you want to identify a
144             specific characteristic of that certificate, or you can apply the same
145             tag to multiple certificates if you want to filter for a common
146             relationship among those certificates. Similarly, you can apply the
147             same tag to multiple resources if you want to specify a relationship
148             among those resources. For example, you can add the same tag to an ACM
149             Certificate and an Elastic Load Balancing load balancer to indicate
150             that they are both used by the same website. For more information, see
151             Tagging ACM Certificates.
152              
153             To remove one or more tags, use the RemoveTagsFromCertificate action.
154             To view all of the tags that have been applied to the certificate, use
155             the ListTagsForCertificate action.
156              
157              
158             =head2 DeleteCertificate(CertificateArn => Str)
159              
160             Each argument is described in detail in: L<Paws::ACM::DeleteCertificate>
161              
162             Returns: nothing
163              
164             Deletes an ACM Certificate and its associated private key. If this
165             action succeeds, the certificate no longer appears in the list of ACM
166             Certificates that can be displayed by calling the ListCertificates
167             action or be retrieved by calling the GetCertificate action. The
168             certificate will not be available for use by other AWS services.
169              
170             You cannot delete an ACM Certificate that is being used by another AWS
171             service. To delete a certificate that is in use, the certificate
172             association must first be removed.
173              
174              
175             =head2 DescribeCertificate(CertificateArn => Str)
176              
177             Each argument is described in detail in: L<Paws::ACM::DescribeCertificate>
178              
179             Returns: a L<Paws::ACM::DescribeCertificateResponse> instance
180              
181             Returns detailed metadata about the specified ACM Certificate.
182              
183              
184             =head2 GetCertificate(CertificateArn => Str)
185              
186             Each argument is described in detail in: L<Paws::ACM::GetCertificate>
187              
188             Returns: a L<Paws::ACM::GetCertificateResponse> instance
189              
190             Retrieves an ACM Certificate and certificate chain for the certificate
191             specified by an ARN. The chain is an ordered list of certificates that
192             contains the root certificate, intermediate certificates of subordinate
193             CAs, and the ACM Certificate. The certificate and certificate chain are
194             base64 encoded. If you want to decode the certificate chain to see the
195             individual certificate fields, you can use OpenSSL.
196              
197             Currently, ACM Certificates can be used only with Elastic Load
198             Balancing and Amazon CloudFront.
199              
200              
201             =head2 ImportCertificate(Certificate => Str, PrivateKey => Str, [CertificateArn => Str, CertificateChain => Str])
202              
203             Each argument is described in detail in: L<Paws::ACM::ImportCertificate>
204              
205             Returns: a L<Paws::ACM::ImportCertificateResponse> instance
206              
207             Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to
208             use with ACM's integrated AWS services.
209              
210             ACM does not provide managed renewal for certificates that you import.
211              
212             For more information about importing certificates into ACM, including
213             the differences between certificates that you import and those that ACM
214             provides, see Importing Certificates in the I<AWS Certificate Manager
215             User Guide>.
216              
217             To import a certificate, you must provide the certificate and the
218             matching private key. When the certificate is not self-signed, you must
219             also provide a certificate chain. You can omit the certificate chain
220             when importing a self-signed certificate.
221              
222             The certificate, private key, and certificate chain must be
223             PEM-encoded. For more information about converting these items to PEM
224             format, see Importing Certificates Troubleshooting in the I<AWS
225             Certificate Manager User Guide>.
226              
227             To import a new certificate, omit the C<CertificateArn> field. Include
228             this field only when you want to replace a previously imported
229             certificate.
230              
231             This operation returns the Amazon Resource Name (ARN) of the imported
232             certificate.
233              
234              
235             =head2 ListCertificates([CertificateStatuses => ArrayRef[Str|Undef], MaxItems => Int, NextToken => Str])
236              
237             Each argument is described in detail in: L<Paws::ACM::ListCertificates>
238              
239             Returns: a L<Paws::ACM::ListCertificatesResponse> instance
240              
241             Retrieves a list of ACM Certificates and the domain name for each. You
242             can optionally filter the list to return only the certificates that
243             match the specified status.
244              
245              
246             =head2 ListTagsForCertificate(CertificateArn => Str)
247              
248             Each argument is described in detail in: L<Paws::ACM::ListTagsForCertificate>
249              
250             Returns: a L<Paws::ACM::ListTagsForCertificateResponse> instance
251              
252             Lists the tags that have been applied to the ACM Certificate. Use the
253             certificate's Amazon Resource Name (ARN) to specify the certificate. To
254             add a tag to an ACM Certificate, use the AddTagsToCertificate action.
255             To delete a tag, use the RemoveTagsFromCertificate action.
256              
257              
258             =head2 RemoveTagsFromCertificate(CertificateArn => Str, Tags => ArrayRef[L<Paws::ACM::Tag>])
259              
260             Each argument is described in detail in: L<Paws::ACM::RemoveTagsFromCertificate>
261              
262             Returns: nothing
263              
264             Remove one or more tags from an ACM Certificate. A tag consists of a
265             key-value pair. If you do not specify the value portion of the tag when
266             calling this function, the tag will be removed regardless of value. If
267             you specify a value, the tag is removed only if it is associated with
268             the specified value.
269              
270             To add tags to a certificate, use the AddTagsToCertificate action. To
271             view all of the tags that have been applied to a specific ACM
272             Certificate, use the ListTagsForCertificate action.
273              
274              
275             =head2 RequestCertificate(DomainName => Str, [DomainValidationOptions => ArrayRef[L<Paws::ACM::DomainValidationOption>], IdempotencyToken => Str, SubjectAlternativeNames => ArrayRef[Str|Undef]])
276              
277             Each argument is described in detail in: L<Paws::ACM::RequestCertificate>
278              
279             Returns: a L<Paws::ACM::RequestCertificateResponse> instance
280              
281             Requests an ACM Certificate for use with other AWS services. To request
282             an ACM Certificate, you must specify the fully qualified domain name
283             (FQDN) for your site. You can also specify additional FQDNs if users
284             can reach your site by using other names. For each domain name you
285             specify, email is sent to the domain owner to request approval to issue
286             the certificate. After receiving approval from the domain owner, the
287             ACM Certificate is issued. For more information, see the AWS
288             Certificate Manager User Guide.
289              
290              
291             =head2 ResendValidationEmail(CertificateArn => Str, Domain => Str, ValidationDomain => Str)
292              
293             Each argument is described in detail in: L<Paws::ACM::ResendValidationEmail>
294              
295             Returns: nothing
296              
297             Resends the email that requests domain ownership validation. The domain
298             owner or an authorized representative must approve the ACM Certificate
299             before it can be issued. The certificate can be approved by clicking a
300             link in the mail to navigate to the Amazon certificate approval website
301             and then clicking B<I Approve>. However, the validation email can be
302             blocked by spam filters. Therefore, if you do not receive the original
303             mail, you can request that the mail be resent within 72 hours of
304             requesting the ACM Certificate. If more than 72 hours have elapsed
305             since your original request or since your last attempt to resend
306             validation mail, you must request a new certificate. For more
307             information about setting up your contact email addresses, see
308             Configure Email for your Domain.
309              
310              
311              
312              
313             =head1 PAGINATORS
314              
315             Paginator methods are helpers that repetively call methods that return partial results
316              
317             =head2 ListAllCertificates(sub { },[CertificateStatuses => ArrayRef[Str|Undef], MaxItems => Int, NextToken => Str])
318              
319             =head2 ListAllCertificates([CertificateStatuses => ArrayRef[Str|Undef], MaxItems => Int, NextToken => Str])
320              
321              
322             If passed a sub as first parameter, it will call the sub for each element found in :
323              
324             - CertificateSummaryList, passing the object as the first parameter, and the string 'CertificateSummaryList' as the second parameter
325              
326             If not, it will return a a L<Paws::ACM::ListCertificatesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
327              
328              
329              
330              
331              
332             =head1 SEE ALSO
333              
334             This service class forms part of L<Paws>
335              
336             =head1 BUGS and CONTRIBUTIONS
337              
338             The source code is located here: https://github.com/pplu/aws-sdk-perl
339              
340             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
341              
342             =cut
343