| 1 | package Paws::ACMPCA; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'acm-pca' } | ||
| 4 | sub signing_name { 'acm-pca' } | ||
| 5 | sub version { '2017-08-22' } | ||
| 6 | sub target_prefix { 'ACMPrivateCA' } | ||
| 7 | sub json_version { "1.1" } | ||
| 8 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 9 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 10 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 11 | }); | ||
| 12 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 13 | ] }); | ||
| 14 | |||
| 15 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller'; | ||
| 16 | |||
| 17 | |||
| 18 | sub CreateCertificateAuthority { | ||
| 19 | my $self = shift; | ||
| 20 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::CreateCertificateAuthority', @_); | ||
| 21 | return $self->caller->do_call($self, $call_object); | ||
| 22 | } | ||
| 23 | sub CreateCertificateAuthorityAuditReport { | ||
| 24 | my $self = shift; | ||
| 25 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::CreateCertificateAuthorityAuditReport', @_); | ||
| 26 | return $self->caller->do_call($self, $call_object); | ||
| 27 | } | ||
| 28 | sub CreatePermission { | ||
| 29 | my $self = shift; | ||
| 30 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::CreatePermission', @_); | ||
| 31 | return $self->caller->do_call($self, $call_object); | ||
| 32 | } | ||
| 33 | sub DeleteCertificateAuthority { | ||
| 34 | my $self = shift; | ||
| 35 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::DeleteCertificateAuthority', @_); | ||
| 36 | return $self->caller->do_call($self, $call_object); | ||
| 37 | } | ||
| 38 | sub DeletePermission { | ||
| 39 | my $self = shift; | ||
| 40 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::DeletePermission', @_); | ||
| 41 | return $self->caller->do_call($self, $call_object); | ||
| 42 | } | ||
| 43 | sub DeletePolicy { | ||
| 44 | my $self = shift; | ||
| 45 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::DeletePolicy', @_); | ||
| 46 | return $self->caller->do_call($self, $call_object); | ||
| 47 | } | ||
| 48 | sub DescribeCertificateAuthority { | ||
| 49 | my $self = shift; | ||
| 50 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::DescribeCertificateAuthority', @_); | ||
| 51 | return $self->caller->do_call($self, $call_object); | ||
| 52 | } | ||
| 53 | sub DescribeCertificateAuthorityAuditReport { | ||
| 54 | my $self = shift; | ||
| 55 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::DescribeCertificateAuthorityAuditReport', @_); | ||
| 56 | return $self->caller->do_call($self, $call_object); | ||
| 57 | } | ||
| 58 | sub GetCertificate { | ||
| 59 | my $self = shift; | ||
| 60 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::GetCertificate', @_); | ||
| 61 | return $self->caller->do_call($self, $call_object); | ||
| 62 | } | ||
| 63 | sub GetCertificateAuthorityCertificate { | ||
| 64 | my $self = shift; | ||
| 65 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::GetCertificateAuthorityCertificate', @_); | ||
| 66 | return $self->caller->do_call($self, $call_object); | ||
| 67 | } | ||
| 68 | sub GetCertificateAuthorityCsr { | ||
| 69 | my $self = shift; | ||
| 70 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::GetCertificateAuthorityCsr', @_); | ||
| 71 | return $self->caller->do_call($self, $call_object); | ||
| 72 | } | ||
| 73 | sub GetPolicy { | ||
| 74 | my $self = shift; | ||
| 75 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::GetPolicy', @_); | ||
| 76 | return $self->caller->do_call($self, $call_object); | ||
| 77 | } | ||
| 78 | sub ImportCertificateAuthorityCertificate { | ||
| 79 | my $self = shift; | ||
| 80 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::ImportCertificateAuthorityCertificate', @_); | ||
| 81 | return $self->caller->do_call($self, $call_object); | ||
| 82 | } | ||
| 83 | sub IssueCertificate { | ||
| 84 | my $self = shift; | ||
| 85 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::IssueCertificate', @_); | ||
| 86 | return $self->caller->do_call($self, $call_object); | ||
| 87 | } | ||
| 88 | sub ListCertificateAuthorities { | ||
| 89 | my $self = shift; | ||
| 90 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::ListCertificateAuthorities', @_); | ||
| 91 | return $self->caller->do_call($self, $call_object); | ||
| 92 | } | ||
| 93 | sub ListPermissions { | ||
| 94 | my $self = shift; | ||
| 95 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::ListPermissions', @_); | ||
| 96 | return $self->caller->do_call($self, $call_object); | ||
| 97 | } | ||
| 98 | sub ListTags { | ||
| 99 | my $self = shift; | ||
| 100 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::ListTags', @_); | ||
| 101 | return $self->caller->do_call($self, $call_object); | ||
| 102 | } | ||
| 103 | sub PutPolicy { | ||
| 104 | my $self = shift; | ||
| 105 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::PutPolicy', @_); | ||
| 106 | return $self->caller->do_call($self, $call_object); | ||
| 107 | } | ||
| 108 | sub RestoreCertificateAuthority { | ||
| 109 | my $self = shift; | ||
| 110 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::RestoreCertificateAuthority', @_); | ||
| 111 | return $self->caller->do_call($self, $call_object); | ||
| 112 | } | ||
| 113 | sub RevokeCertificate { | ||
| 114 | my $self = shift; | ||
| 115 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::RevokeCertificate', @_); | ||
| 116 | return $self->caller->do_call($self, $call_object); | ||
| 117 | } | ||
| 118 | sub TagCertificateAuthority { | ||
| 119 | my $self = shift; | ||
| 120 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::TagCertificateAuthority', @_); | ||
| 121 | return $self->caller->do_call($self, $call_object); | ||
| 122 | } | ||
| 123 | sub UntagCertificateAuthority { | ||
| 124 | my $self = shift; | ||
| 125 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::UntagCertificateAuthority', @_); | ||
| 126 | return $self->caller->do_call($self, $call_object); | ||
| 127 | } | ||
| 128 | sub UpdateCertificateAuthority { | ||
| 129 | my $self = shift; | ||
| 130 | my $call_object = $self->new_with_coercions('Paws::ACMPCA::UpdateCertificateAuthority', @_); | ||
| 131 | return $self->caller->do_call($self, $call_object); | ||
| 132 | } | ||
| 133 | |||
| 134 | sub ListAllCertificateAuthorities { | ||
| 135 | my $self = shift; | ||
| 136 | |||
| 137 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 138 | my $result = $self->ListCertificateAuthorities(@_); | ||
| 139 | my $next_result = $result; | ||
| 140 | |||
| 141 | if (not defined $callback) { | ||
| 142 | while ($next_result->NextToken) { | ||
| 143 | $next_result = $self->ListCertificateAuthorities(@_, NextToken => $next_result->NextToken); | ||
| 144 | push @{ $result->CertificateAuthorities }, @{ $next_result->CertificateAuthorities }; | ||
| 145 | } | ||
| 146 | return $result; | ||
| 147 | } else { | ||
| 148 | while ($result->NextToken) { | ||
| 149 | $callback->($_ => 'CertificateAuthorities') foreach (@{ $result->CertificateAuthorities }); | ||
| 150 | $result = $self->ListCertificateAuthorities(@_, NextToken => $result->NextToken); | ||
| 151 | } | ||
| 152 | $callback->($_ => 'CertificateAuthorities') foreach (@{ $result->CertificateAuthorities }); | ||
| 153 | } | ||
| 154 | |||
| 155 | return undef | ||
| 156 | } | ||
| 157 | sub ListAllPermissions { | ||
| 158 | my $self = shift; | ||
| 159 | |||
| 160 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 161 | my $result = $self->ListPermissions(@_); | ||
| 162 | my $next_result = $result; | ||
| 163 | |||
| 164 | if (not defined $callback) { | ||
| 165 | while ($next_result->NextToken) { | ||
| 166 | $next_result = $self->ListPermissions(@_, NextToken => $next_result->NextToken); | ||
| 167 | push @{ $result->Permissions }, @{ $next_result->Permissions }; | ||
| 168 | } | ||
| 169 | return $result; | ||
| 170 | } else { | ||
| 171 | while ($result->NextToken) { | ||
| 172 | $callback->($_ => 'Permissions') foreach (@{ $result->Permissions }); | ||
| 173 | $result = $self->ListPermissions(@_, NextToken => $result->NextToken); | ||
| 174 | } | ||
| 175 | $callback->($_ => 'Permissions') foreach (@{ $result->Permissions }); | ||
| 176 | } | ||
| 177 | |||
| 178 | return undef | ||
| 179 | } | ||
| 180 | sub ListAllTags { | ||
| 181 | my $self = shift; | ||
| 182 | |||
| 183 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 184 | my $result = $self->ListTags(@_); | ||
| 185 | my $next_result = $result; | ||
| 186 | |||
| 187 | if (not defined $callback) { | ||
| 188 | while ($next_result->NextToken) { | ||
| 189 | $next_result = $self->ListTags(@_, NextToken => $next_result->NextToken); | ||
| 190 | push @{ $result->Tags }, @{ $next_result->Tags }; | ||
| 191 | } | ||
| 192 | return $result; | ||
| 193 | } else { | ||
| 194 | while ($result->NextToken) { | ||
| 195 | $callback->($_ => 'Tags') foreach (@{ $result->Tags }); | ||
| 196 | $result = $self->ListTags(@_, NextToken => $result->NextToken); | ||
| 197 | } | ||
| 198 | $callback->($_ => 'Tags') foreach (@{ $result->Tags }); | ||
| 199 | } | ||
| 200 | |||
| 201 | return undef | ||
| 202 | } | ||
| 203 | |||
| 204 | |||
| 205 | sub operations { qw/CreateCertificateAuthority CreateCertificateAuthorityAuditReport CreatePermission DeleteCertificateAuthority DeletePermission DeletePolicy DescribeCertificateAuthority DescribeCertificateAuthorityAuditReport GetCertificate GetCertificateAuthorityCertificate GetCertificateAuthorityCsr GetPolicy ImportCertificateAuthorityCertificate IssueCertificate ListCertificateAuthorities ListPermissions ListTags PutPolicy RestoreCertificateAuthority RevokeCertificate TagCertificateAuthority UntagCertificateAuthority UpdateCertificateAuthority / } | ||
| 206 | |||
| 207 | 1; | ||
| 208 | |||
| 209 | ### main pod documentation begin ### | ||
| 210 | |||
| 211 | =head1 NAME | ||
| 212 | |||
| 213 | Paws::ACMPCA - Perl Interface to AWS AWS Certificate Manager Private Certificate Authority | ||
| 214 | |||
| 215 | =head1 SYNOPSIS | ||
| 216 | |||
| 217 | use Paws; | ||
| 218 | |||
| 219 | my $obj = Paws->service('ACMPCA'); | ||
| 220 | my $res = $obj->Method( | ||
| 221 | Arg1 => $val1, | ||
| 222 | Arg2 => [ 'V1', 'V2' ], | ||
| 223 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 224 | # of the arguments type | ||
| 225 | Arg3 => { Att1 => 'Val1' }, | ||
| 226 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 227 | # the constructor of the arguments type | ||
| 228 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 229 | ); | ||
| 230 | |||
| 231 | =head1 DESCRIPTION | ||
| 232 | |||
| 233 | This is the I<ACM Private CA API Reference>. It provides descriptions, | ||
| 234 | syntax, and usage examples for each of the actions and data types | ||
| 235 | involved in creating and managing private certificate authorities (CA) | ||
| 236 | for your organization. | ||
| 237 | |||
| 238 | The documentation for each action shows the Query API request | ||
| 239 | parameters and the XML response. Alternatively, you can use one of the | ||
| 240 | AWS SDKs to access an API that's tailored to the programming language | ||
| 241 | or platform that you're using. For more information, see AWS SDKs | ||
| 242 | (https://aws.amazon.com/tools/#SDKs). | ||
| 243 | |||
| 244 | Each ACM Private CA API action has a quota that determines the number | ||
| 245 | of times the action can be called per second. For more information, see | ||
| 246 | API Rate Quotas in ACM Private CA | ||
| 247 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaLimits.html#PcaLimits-api) | ||
| 248 | in the ACM Private CA user guide. | ||
| 249 | |||
| 250 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22> | ||
| 251 | |||
| 252 | |||
| 253 | =head1 METHODS | ||
| 254 | |||
| 255 | =head2 CreateCertificateAuthority | ||
| 256 | |||
| 257 | =over | ||
| 258 | |||
| 259 | =item CertificateAuthorityConfiguration => L<Paws::ACMPCA::CertificateAuthorityConfiguration> | ||
| 260 | |||
| 261 | =item CertificateAuthorityType => Str | ||
| 262 | |||
| 263 | =item [IdempotencyToken => Str] | ||
| 264 | |||
| 265 | =item [KeyStorageSecurityStandard => Str] | ||
| 266 | |||
| 267 | =item [RevocationConfiguration => L<Paws::ACMPCA::RevocationConfiguration>] | ||
| 268 | |||
| 269 | =item [Tags => ArrayRef[L<Paws::ACMPCA::Tag>]] | ||
| 270 | |||
| 271 | |||
| 272 | =back | ||
| 273 | |||
| 274 | Each argument is described in detail in: L<Paws::ACMPCA::CreateCertificateAuthority> | ||
| 275 | |||
| 276 | Returns: a L<Paws::ACMPCA::CreateCertificateAuthorityResponse> instance | ||
| 277 | |||
| 278 | Creates a root or subordinate private certificate authority (CA). You | ||
| 279 | must specify the CA configuration, the certificate revocation list | ||
| 280 | (CRL) configuration, the CA type, and an optional idempotency token to | ||
| 281 | avoid accidental creation of multiple CAs. The CA configuration | ||
| 282 | specifies the name of the algorithm and key size to be used to create | ||
| 283 | the CA private key, the type of signing algorithm that the CA uses, and | ||
| 284 | X.500 subject information. The CRL configuration specifies the CRL | ||
| 285 | expiration period in days (the validity period of the CRL), the Amazon | ||
| 286 | S3 bucket that will contain the CRL, and a CNAME alias for the S3 | ||
| 287 | bucket that is included in certificates issued by the CA. If | ||
| 288 | successful, this action returns the Amazon Resource Name (ARN) of the | ||
| 289 | CA. | ||
| 290 | |||
| 291 | ACM Private CA assets that are stored in Amazon S3 can be protected | ||
| 292 | with encryption. For more information, see Encrypting Your CRLs | ||
| 293 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption). | ||
| 294 | |||
| 295 | Both PCA and the IAM principal must have permission to write to the S3 | ||
| 296 | bucket that you specify. If the IAM principal making the call does not | ||
| 297 | have permission to write to the bucket, then an exception is thrown. | ||
| 298 | For more information, see Configure Access to ACM Private CA | ||
| 299 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html). | ||
| 300 | |||
| 301 | |||
| 302 | =head2 CreateCertificateAuthorityAuditReport | ||
| 303 | |||
| 304 | =over | ||
| 305 | |||
| 306 | =item AuditReportResponseFormat => Str | ||
| 307 | |||
| 308 | =item CertificateAuthorityArn => Str | ||
| 309 | |||
| 310 | =item S3BucketName => Str | ||
| 311 | |||
| 312 | |||
| 313 | =back | ||
| 314 | |||
| 315 | Each argument is described in detail in: L<Paws::ACMPCA::CreateCertificateAuthorityAuditReport> | ||
| 316 | |||
| 317 | Returns: a L<Paws::ACMPCA::CreateCertificateAuthorityAuditReportResponse> instance | ||
| 318 | |||
| 319 | Creates an audit report that lists every time that your CA private key | ||
| 320 | is used. The report is saved in the Amazon S3 bucket that you specify | ||
| 321 | on input. The IssueCertificate | ||
| 322 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html) | ||
| 323 | and RevokeCertificate | ||
| 324 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html) | ||
| 325 | actions use the private key. | ||
| 326 | |||
| 327 | Both PCA and the IAM principal must have permission to write to the S3 | ||
| 328 | bucket that you specify. If the IAM principal making the call does not | ||
| 329 | have permission to write to the bucket, then an exception is thrown. | ||
| 330 | For more information, see Configure Access to ACM Private CA | ||
| 331 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html). | ||
| 332 | |||
| 333 | ACM Private CA assets that are stored in Amazon S3 can be protected | ||
| 334 | with encryption. For more information, see Encrypting Your Audit | ||
| 335 | Reports | ||
| 336 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuditReport.html#audit-report-encryption). | ||
| 337 | |||
| 338 | |||
| 339 | =head2 CreatePermission | ||
| 340 | |||
| 341 | =over | ||
| 342 | |||
| 343 | =item Actions => ArrayRef[Str|Undef] | ||
| 344 | |||
| 345 | =item CertificateAuthorityArn => Str | ||
| 346 | |||
| 347 | =item Principal => Str | ||
| 348 | |||
| 349 | =item [SourceAccount => Str] | ||
| 350 | |||
| 351 | |||
| 352 | =back | ||
| 353 | |||
| 354 | Each argument is described in detail in: L<Paws::ACMPCA::CreatePermission> | ||
| 355 | |||
| 356 | Returns: nothing | ||
| 357 | |||
| 358 | Grants one or more permissions on a private CA to the AWS Certificate | ||
| 359 | Manager (ACM) service principal (C<acm.amazonaws.com>). These | ||
| 360 | permissions allow ACM to issue and renew ACM certificates that reside | ||
| 361 | in the same AWS account as the CA. | ||
| 362 | |||
| 363 | You can list current permissions with the ListPermissions | ||
| 364 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html) | ||
| 365 | action and revoke them with the DeletePermission | ||
| 366 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html) | ||
| 367 | action. | ||
| 368 | |||
| 369 | B<About Permissions> | ||
| 370 | |||
| 371 | =over | ||
| 372 | |||
| 373 | =item * | ||
| 374 | |||
| 375 | If the private CA and the certificates it issues reside in the same | ||
| 376 | account, you can use C<CreatePermission> to grant permissions for ACM | ||
| 377 | to carry out automatic certificate renewals. | ||
| 378 | |||
| 379 | =item * | ||
| 380 | |||
| 381 | For automatic certificate renewal to succeed, the ACM service principal | ||
| 382 | needs permissions to create, retrieve, and list certificates. | ||
| 383 | |||
| 384 | =item * | ||
| 385 | |||
| 386 | If the private CA and the ACM certificates reside in different | ||
| 387 | accounts, then permissions cannot be used to enable automatic renewals. | ||
| 388 | Instead, the ACM certificate owner must set up a resource-based policy | ||
| 389 | to enable cross-account issuance and renewals. For more information, | ||
| 390 | see Using a Resource Based Policy with ACM Private CA | ||
| 391 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html). | ||
| 392 | |||
| 393 | =back | ||
| 394 | |||
| 395 | |||
| 396 | |||
| 397 | =head2 DeleteCertificateAuthority | ||
| 398 | |||
| 399 | =over | ||
| 400 | |||
| 401 | =item CertificateAuthorityArn => Str | ||
| 402 | |||
| 403 | =item [PermanentDeletionTimeInDays => Int] | ||
| 404 | |||
| 405 | |||
| 406 | =back | ||
| 407 | |||
| 408 | Each argument is described in detail in: L<Paws::ACMPCA::DeleteCertificateAuthority> | ||
| 409 | |||
| 410 | Returns: nothing | ||
| 411 | |||
| 412 | Deletes a private certificate authority (CA). You must provide the | ||
| 413 | Amazon Resource Name (ARN) of the private CA that you want to delete. | ||
| 414 | You can find the ARN by calling the ListCertificateAuthorities | ||
| 415 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) | ||
| 416 | action. | ||
| 417 | |||
| 418 | Deleting a CA will invalidate other CAs and certificates below it in | ||
| 419 | your CA hierarchy. | ||
| 420 | |||
| 421 | Before you can delete a CA that you have created and activated, you | ||
| 422 | must disable it. To do this, call the UpdateCertificateAuthority | ||
| 423 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) | ||
| 424 | action and set the B<CertificateAuthorityStatus> parameter to | ||
| 425 | C<DISABLED>. | ||
| 426 | |||
| 427 | Additionally, you can delete a CA if you are waiting for it to be | ||
| 428 | created (that is, the status of the CA is C<CREATING>). You can also | ||
| 429 | delete it if the CA has been created but you haven't yet imported the | ||
| 430 | signed certificate into ACM Private CA (that is, the status of the CA | ||
| 431 | is C<PENDING_CERTIFICATE>). | ||
| 432 | |||
| 433 | When you successfully call DeleteCertificateAuthority | ||
| 434 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeleteCertificateAuthority.html), | ||
| 435 | the CA's status changes to C<DELETED>. However, the CA won't be | ||
| 436 | permanently deleted until the restoration period has passed. By | ||
| 437 | default, if you do not set the C<PermanentDeletionTimeInDays> | ||
| 438 | parameter, the CA remains restorable for 30 days. You can set the | ||
| 439 | parameter from 7 to 30 days. The DescribeCertificateAuthority | ||
| 440 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DescribeCertificateAuthority.html) | ||
| 441 | action returns the time remaining in the restoration window of a | ||
| 442 | private CA in the C<DELETED> state. To restore an eligible CA, call the | ||
| 443 | RestoreCertificateAuthority | ||
| 444 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RestoreCertificateAuthority.html) | ||
| 445 | action. | ||
| 446 | |||
| 447 | |||
| 448 | =head2 DeletePermission | ||
| 449 | |||
| 450 | =over | ||
| 451 | |||
| 452 | =item CertificateAuthorityArn => Str | ||
| 453 | |||
| 454 | =item Principal => Str | ||
| 455 | |||
| 456 | =item [SourceAccount => Str] | ||
| 457 | |||
| 458 | |||
| 459 | =back | ||
| 460 | |||
| 461 | Each argument is described in detail in: L<Paws::ACMPCA::DeletePermission> | ||
| 462 | |||
| 463 | Returns: nothing | ||
| 464 | |||
| 465 | Revokes permissions on a private CA granted to the AWS Certificate | ||
| 466 | Manager (ACM) service principal (acm.amazonaws.com). | ||
| 467 | |||
| 468 | These permissions allow ACM to issue and renew ACM certificates that | ||
| 469 | reside in the same AWS account as the CA. If you revoke these | ||
| 470 | permissions, ACM will no longer renew the affected certificates | ||
| 471 | automatically. | ||
| 472 | |||
| 473 | Permissions can be granted with the CreatePermission | ||
| 474 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html) | ||
| 475 | action and listed with the ListPermissions | ||
| 476 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html) | ||
| 477 | action. | ||
| 478 | |||
| 479 | B<About Permissions> | ||
| 480 | |||
| 481 | =over | ||
| 482 | |||
| 483 | =item * | ||
| 484 | |||
| 485 | If the private CA and the certificates it issues reside in the same | ||
| 486 | account, you can use C<CreatePermission> to grant permissions for ACM | ||
| 487 | to carry out automatic certificate renewals. | ||
| 488 | |||
| 489 | =item * | ||
| 490 | |||
| 491 | For automatic certificate renewal to succeed, the ACM service principal | ||
| 492 | needs permissions to create, retrieve, and list certificates. | ||
| 493 | |||
| 494 | =item * | ||
| 495 | |||
| 496 | If the private CA and the ACM certificates reside in different | ||
| 497 | accounts, then permissions cannot be used to enable automatic renewals. | ||
| 498 | Instead, the ACM certificate owner must set up a resource-based policy | ||
| 499 | to enable cross-account issuance and renewals. For more information, | ||
| 500 | see Using a Resource Based Policy with ACM Private CA | ||
| 501 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html). | ||
| 502 | |||
| 503 | =back | ||
| 504 | |||
| 505 | |||
| 506 | |||
| 507 | =head2 DeletePolicy | ||
| 508 | |||
| 509 | =over | ||
| 510 | |||
| 511 | =item ResourceArn => Str | ||
| 512 | |||
| 513 | |||
| 514 | =back | ||
| 515 | |||
| 516 | Each argument is described in detail in: L<Paws::ACMPCA::DeletePolicy> | ||
| 517 | |||
| 518 | Returns: nothing | ||
| 519 | |||
| 520 | Deletes the resource-based policy attached to a private CA. Deletion | ||
| 521 | will remove any access that the policy has granted. If there is no | ||
| 522 | policy attached to the private CA, this action will return successful. | ||
| 523 | |||
| 524 | If you delete a policy that was applied through AWS Resource Access | ||
| 525 | Manager (RAM), the CA will be removed from all shares in which it was | ||
| 526 | included. | ||
| 527 | |||
| 528 | The AWS Certificate Manager Service Linked Role that the policy | ||
| 529 | supports is not affected when you delete the policy. | ||
| 530 | |||
| 531 | The current policy can be shown with GetPolicy | ||
| 532 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html) | ||
| 533 | and updated with PutPolicy | ||
| 534 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html). | ||
| 535 | |||
| 536 | B<About Policies> | ||
| 537 | |||
| 538 | =over | ||
| 539 | |||
| 540 | =item * | ||
| 541 | |||
| 542 | A policy grants access on a private CA to an AWS customer account, to | ||
| 543 | AWS Organizations, or to an AWS Organizations unit. Policies are under | ||
| 544 | the control of a CA administrator. For more information, see Using a | ||
| 545 | Resource Based Policy with ACM Private CA | ||
| 546 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html). | ||
| 547 | |||
| 548 | =item * | ||
| 549 | |||
| 550 | A policy permits a user of AWS Certificate Manager (ACM) to issue ACM | ||
| 551 | certificates signed by a CA in another account. | ||
| 552 | |||
| 553 | =item * | ||
| 554 | |||
| 555 | For ACM to manage automatic renewal of these certificates, the ACM user | ||
| 556 | must configure a Service Linked Role (SLR). The SLR allows the ACM | ||
| 557 | service to assume the identity of the user, subject to confirmation | ||
| 558 | against the ACM Private CA policy. For more information, see Using a | ||
| 559 | Service Linked Role with ACM | ||
| 560 | (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html). | ||
| 561 | |||
| 562 | =item * | ||
| 563 | |||
| 564 | Updates made in AWS Resource Manager (RAM) are reflected in policies. | ||
| 565 | For more information, see Attach a Policy for Cross-Account Access | ||
| 566 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html). | ||
| 567 | |||
| 568 | =back | ||
| 569 | |||
| 570 | |||
| 571 | |||
| 572 | =head2 DescribeCertificateAuthority | ||
| 573 | |||
| 574 | =over | ||
| 575 | |||
| 576 | =item CertificateAuthorityArn => Str | ||
| 577 | |||
| 578 | |||
| 579 | =back | ||
| 580 | |||
| 581 | Each argument is described in detail in: L<Paws::ACMPCA::DescribeCertificateAuthority> | ||
| 582 | |||
| 583 | Returns: a L<Paws::ACMPCA::DescribeCertificateAuthorityResponse> instance | ||
| 584 | |||
| 585 | Lists information about your private certificate authority (CA) or one | ||
| 586 | that has been shared with you. You specify the private CA on input by | ||
| 587 | its ARN (Amazon Resource Name). The output contains the status of your | ||
| 588 | CA. This can be any of the following: | ||
| 589 | |||
| 590 | =over | ||
| 591 | |||
| 592 | =item * | ||
| 593 | |||
| 594 | C<CREATING> - ACM Private CA is creating your private certificate | ||
| 595 | authority. | ||
| 596 | |||
| 597 | =item * | ||
| 598 | |||
| 599 | C<PENDING_CERTIFICATE> - The certificate is pending. You must use your | ||
| 600 | ACM Private CA-hosted or on-premises root or subordinate CA to sign | ||
| 601 | your private CA CSR and then import it into PCA. | ||
| 602 | |||
| 603 | =item * | ||
| 604 | |||
| 605 | C<ACTIVE> - Your private CA is active. | ||
| 606 | |||
| 607 | =item * | ||
| 608 | |||
| 609 | C<DISABLED> - Your private CA has been disabled. | ||
| 610 | |||
| 611 | =item * | ||
| 612 | |||
| 613 | C<EXPIRED> - Your private CA certificate has expired. | ||
| 614 | |||
| 615 | =item * | ||
| 616 | |||
| 617 | C<FAILED> - Your private CA has failed. Your CA can fail because of | ||
| 618 | problems such a network outage or back-end AWS failure or other errors. | ||
| 619 | A failed CA can never return to the pending state. You must create a | ||
| 620 | new CA. | ||
| 621 | |||
| 622 | =item * | ||
| 623 | |||
| 624 | C<DELETED> - Your private CA is within the restoration period, after | ||
| 625 | which it is permanently deleted. The length of time remaining in the | ||
| 626 | CA's restoration period is also included in this action's output. | ||
| 627 | |||
| 628 | =back | ||
| 629 | |||
| 630 | |||
| 631 | |||
| 632 | =head2 DescribeCertificateAuthorityAuditReport | ||
| 633 | |||
| 634 | =over | ||
| 635 | |||
| 636 | =item AuditReportId => Str | ||
| 637 | |||
| 638 | =item CertificateAuthorityArn => Str | ||
| 639 | |||
| 640 | |||
| 641 | =back | ||
| 642 | |||
| 643 | Each argument is described in detail in: L<Paws::ACMPCA::DescribeCertificateAuthorityAuditReport> | ||
| 644 | |||
| 645 | Returns: a L<Paws::ACMPCA::DescribeCertificateAuthorityAuditReportResponse> instance | ||
| 646 | |||
| 647 | Lists information about a specific audit report created by calling the | ||
| 648 | CreateCertificateAuthorityAuditReport | ||
| 649 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) | ||
| 650 | action. Audit information is created every time the certificate | ||
| 651 | authority (CA) private key is used. The private key is used when you | ||
| 652 | call the IssueCertificate | ||
| 653 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html) | ||
| 654 | action or the RevokeCertificate | ||
| 655 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html) | ||
| 656 | action. | ||
| 657 | |||
| 658 | |||
| 659 | =head2 GetCertificate | ||
| 660 | |||
| 661 | =over | ||
| 662 | |||
| 663 | =item CertificateArn => Str | ||
| 664 | |||
| 665 | =item CertificateAuthorityArn => Str | ||
| 666 | |||
| 667 | |||
| 668 | =back | ||
| 669 | |||
| 670 | Each argument is described in detail in: L<Paws::ACMPCA::GetCertificate> | ||
| 671 | |||
| 672 | Returns: a L<Paws::ACMPCA::GetCertificateResponse> instance | ||
| 673 | |||
| 674 | Retrieves a certificate from your private CA or one that has been | ||
| 675 | shared with you. The ARN of the certificate is returned when you call | ||
| 676 | the IssueCertificate | ||
| 677 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html) | ||
| 678 | action. You must specify both the ARN of your private CA and the ARN of | ||
| 679 | the issued certificate when calling the B<GetCertificate> action. You | ||
| 680 | can retrieve the certificate if it is in the B<ISSUED> state. You can | ||
| 681 | call the CreateCertificateAuthorityAuditReport | ||
| 682 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) | ||
| 683 | action to create a report that contains information about all of the | ||
| 684 | certificates issued and revoked by your private CA. | ||
| 685 | |||
| 686 | |||
| 687 | =head2 GetCertificateAuthorityCertificate | ||
| 688 | |||
| 689 | =over | ||
| 690 | |||
| 691 | =item CertificateAuthorityArn => Str | ||
| 692 | |||
| 693 | |||
| 694 | =back | ||
| 695 | |||
| 696 | Each argument is described in detail in: L<Paws::ACMPCA::GetCertificateAuthorityCertificate> | ||
| 697 | |||
| 698 | Returns: a L<Paws::ACMPCA::GetCertificateAuthorityCertificateResponse> instance | ||
| 699 | |||
| 700 | Retrieves the certificate and certificate chain for your private | ||
| 701 | certificate authority (CA) or one that has been shared with you. Both | ||
| 702 | the certificate and the chain are base64 PEM-encoded. The chain does | ||
| 703 | not include the CA certificate. Each certificate in the chain signs the | ||
| 704 | one before it. | ||
| 705 | |||
| 706 | |||
| 707 | =head2 GetCertificateAuthorityCsr | ||
| 708 | |||
| 709 | =over | ||
| 710 | |||
| 711 | =item CertificateAuthorityArn => Str | ||
| 712 | |||
| 713 | |||
| 714 | =back | ||
| 715 | |||
| 716 | Each argument is described in detail in: L<Paws::ACMPCA::GetCertificateAuthorityCsr> | ||
| 717 | |||
| 718 | Returns: a L<Paws::ACMPCA::GetCertificateAuthorityCsrResponse> instance | ||
| 719 | |||
| 720 | Retrieves the certificate signing request (CSR) for your private | ||
| 721 | certificate authority (CA). The CSR is created when you call the | ||
| 722 | CreateCertificateAuthority | ||
| 723 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) | ||
| 724 | action. Sign the CSR with your ACM Private CA-hosted or on-premises | ||
| 725 | root or subordinate CA. Then import the signed certificate back into | ||
| 726 | ACM Private CA by calling the ImportCertificateAuthorityCertificate | ||
| 727 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) | ||
| 728 | action. The CSR is returned as a base64 PEM-encoded string. | ||
| 729 | |||
| 730 | |||
| 731 | =head2 GetPolicy | ||
| 732 | |||
| 733 | =over | ||
| 734 | |||
| 735 | =item ResourceArn => Str | ||
| 736 | |||
| 737 | |||
| 738 | =back | ||
| 739 | |||
| 740 | Each argument is described in detail in: L<Paws::ACMPCA::GetPolicy> | ||
| 741 | |||
| 742 | Returns: a L<Paws::ACMPCA::GetPolicyResponse> instance | ||
| 743 | |||
| 744 | Retrieves the resource-based policy attached to a private CA. If either | ||
| 745 | the private CA resource or the policy cannot be found, this action | ||
| 746 | returns a C<ResourceNotFoundException>. | ||
| 747 | |||
| 748 | The policy can be attached or updated with PutPolicy | ||
| 749 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html) | ||
| 750 | and removed with DeletePolicy | ||
| 751 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePolicy.html). | ||
| 752 | |||
| 753 | B<About Policies> | ||
| 754 | |||
| 755 | =over | ||
| 756 | |||
| 757 | =item * | ||
| 758 | |||
| 759 | A policy grants access on a private CA to an AWS customer account, to | ||
| 760 | AWS Organizations, or to an AWS Organizations unit. Policies are under | ||
| 761 | the control of a CA administrator. For more information, see Using a | ||
| 762 | Resource Based Policy with ACM Private CA | ||
| 763 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html). | ||
| 764 | |||
| 765 | =item * | ||
| 766 | |||
| 767 | A policy permits a user of AWS Certificate Manager (ACM) to issue ACM | ||
| 768 | certificates signed by a CA in another account. | ||
| 769 | |||
| 770 | =item * | ||
| 771 | |||
| 772 | For ACM to manage automatic renewal of these certificates, the ACM user | ||
| 773 | must configure a Service Linked Role (SLR). The SLR allows the ACM | ||
| 774 | service to assume the identity of the user, subject to confirmation | ||
| 775 | against the ACM Private CA policy. For more information, see Using a | ||
| 776 | Service Linked Role with ACM | ||
| 777 | (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html). | ||
| 778 | |||
| 779 | =item * | ||
| 780 | |||
| 781 | Updates made in AWS Resource Manager (RAM) are reflected in policies. | ||
| 782 | For more information, see Attach a Policy for Cross-Account Access | ||
| 783 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html). | ||
| 784 | |||
| 785 | =back | ||
| 786 | |||
| 787 | |||
| 788 | |||
| 789 | =head2 ImportCertificateAuthorityCertificate | ||
| 790 | |||
| 791 | =over | ||
| 792 | |||
| 793 | =item Certificate => Str | ||
| 794 | |||
| 795 | =item CertificateAuthorityArn => Str | ||
| 796 | |||
| 797 | =item [CertificateChain => Str] | ||
| 798 | |||
| 799 | |||
| 800 | =back | ||
| 801 | |||
| 802 | Each argument is described in detail in: L<Paws::ACMPCA::ImportCertificateAuthorityCertificate> | ||
| 803 | |||
| 804 | Returns: nothing | ||
| 805 | |||
| 806 | Imports a signed private CA certificate into ACM Private CA. This | ||
| 807 | action is used when you are using a chain of trust whose root is | ||
| 808 | located outside ACM Private CA. Before you can call this action, the | ||
| 809 | following preparations must in place: | ||
| 810 | |||
| 811 | =over | ||
| 812 | |||
| 813 | =item 1. | ||
| 814 | |||
| 815 | In ACM Private CA, call the CreateCertificateAuthority | ||
| 816 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) | ||
| 817 | action to create the private CA that you plan to back with the imported | ||
| 818 | certificate. | ||
| 819 | |||
| 820 | =item 2. | ||
| 821 | |||
| 822 | Call the GetCertificateAuthorityCsr | ||
| 823 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificateAuthorityCsr.html) | ||
| 824 | action to generate a certificate signing request (CSR). | ||
| 825 | |||
| 826 | =item 3. | ||
| 827 | |||
| 828 | Sign the CSR using a root or intermediate CA hosted by either an | ||
| 829 | on-premises PKI hierarchy or by a commercial CA. | ||
| 830 | |||
| 831 | =item 4. | ||
| 832 | |||
| 833 | Create a certificate chain and copy the signed certificate and the | ||
| 834 | certificate chain to your working directory. | ||
| 835 | |||
| 836 | =back | ||
| 837 | |||
| 838 | ACM Private CA supports three scenarios for installing a CA | ||
| 839 | certificate: | ||
| 840 | |||
| 841 | =over | ||
| 842 | |||
| 843 | =item * | ||
| 844 | |||
| 845 | Installing a certificate for a root CA hosted by ACM Private CA. | ||
| 846 | |||
| 847 | =item * | ||
| 848 | |||
| 849 | Installing a subordinate CA certificate whose parent authority is | ||
| 850 | hosted by ACM Private CA. | ||
| 851 | |||
| 852 | =item * | ||
| 853 | |||
| 854 | Installing a subordinate CA certificate whose parent authority is | ||
| 855 | externally hosted. | ||
| 856 | |||
| 857 | =back | ||
| 858 | |||
| 859 | The following additional requirements apply when you import a CA | ||
| 860 | certificate. | ||
| 861 | |||
| 862 | =over | ||
| 863 | |||
| 864 | =item * | ||
| 865 | |||
| 866 | Only a self-signed certificate can be imported as a root CA. | ||
| 867 | |||
| 868 | =item * | ||
| 869 | |||
| 870 | A self-signed certificate cannot be imported as a subordinate CA. | ||
| 871 | |||
| 872 | =item * | ||
| 873 | |||
| 874 | Your certificate chain must not include the private CA certificate that | ||
| 875 | you are importing. | ||
| 876 | |||
| 877 | =item * | ||
| 878 | |||
| 879 | Your root CA must be the last certificate in your chain. The | ||
| 880 | subordinate certificate, if any, that your root CA signed must be next | ||
| 881 | to last. The subordinate certificate signed by the preceding | ||
| 882 | subordinate CA must come next, and so on until your chain is built. | ||
| 883 | |||
| 884 | =item * | ||
| 885 | |||
| 886 | The chain must be PEM-encoded. | ||
| 887 | |||
| 888 | =item * | ||
| 889 | |||
| 890 | The maximum allowed size of a certificate is 32 KB. | ||
| 891 | |||
| 892 | =item * | ||
| 893 | |||
| 894 | The maximum allowed size of a certificate chain is 2 MB. | ||
| 895 | |||
| 896 | =back | ||
| 897 | |||
| 898 | I<Enforcement of Critical Constraints> | ||
| 899 | |||
| 900 | ACM Private CA allows the following extensions to be marked critical in | ||
| 901 | the imported CA certificate or chain. | ||
| 902 | |||
| 903 | =over | ||
| 904 | |||
| 905 | =item * | ||
| 906 | |||
| 907 | Basic constraints (I<must> be marked critical) | ||
| 908 | |||
| 909 | =item * | ||
| 910 | |||
| 911 | Subject alternative names | ||
| 912 | |||
| 913 | =item * | ||
| 914 | |||
| 915 | Key usage | ||
| 916 | |||
| 917 | =item * | ||
| 918 | |||
| 919 | Extended key usage | ||
| 920 | |||
| 921 | =item * | ||
| 922 | |||
| 923 | Authority key identifier | ||
| 924 | |||
| 925 | =item * | ||
| 926 | |||
| 927 | Subject key identifier | ||
| 928 | |||
| 929 | =item * | ||
| 930 | |||
| 931 | Issuer alternative name | ||
| 932 | |||
| 933 | =item * | ||
| 934 | |||
| 935 | Subject directory attributes | ||
| 936 | |||
| 937 | =item * | ||
| 938 | |||
| 939 | Subject information access | ||
| 940 | |||
| 941 | =item * | ||
| 942 | |||
| 943 | Certificate policies | ||
| 944 | |||
| 945 | =item * | ||
| 946 | |||
| 947 | Policy mappings | ||
| 948 | |||
| 949 | =item * | ||
| 950 | |||
| 951 | Inhibit anyPolicy | ||
| 952 | |||
| 953 | =back | ||
| 954 | |||
| 955 | ACM Private CA rejects the following extensions when they are marked | ||
| 956 | critical in an imported CA certificate or chain. | ||
| 957 | |||
| 958 | =over | ||
| 959 | |||
| 960 | =item * | ||
| 961 | |||
| 962 | Name constraints | ||
| 963 | |||
| 964 | =item * | ||
| 965 | |||
| 966 | Policy constraints | ||
| 967 | |||
| 968 | =item * | ||
| 969 | |||
| 970 | CRL distribution points | ||
| 971 | |||
| 972 | =item * | ||
| 973 | |||
| 974 | Authority information access | ||
| 975 | |||
| 976 | =item * | ||
| 977 | |||
| 978 | Freshest CRL | ||
| 979 | |||
| 980 | =item * | ||
| 981 | |||
| 982 | Any other extension | ||
| 983 | |||
| 984 | =back | ||
| 985 | |||
| 986 | |||
| 987 | |||
| 988 | =head2 IssueCertificate | ||
| 989 | |||
| 990 | =over | ||
| 991 | |||
| 992 | =item CertificateAuthorityArn => Str | ||
| 993 | |||
| 994 | =item Csr => Str | ||
| 995 | |||
| 996 | =item SigningAlgorithm => Str | ||
| 997 | |||
| 998 | =item Validity => L<Paws::ACMPCA::Validity> | ||
| 999 | |||
| 1000 | =item [ApiPassthrough => L<Paws::ACMPCA::ApiPassthrough>] | ||
| 1001 | |||
| 1002 | =item [IdempotencyToken => Str] | ||
| 1003 | |||
| 1004 | =item [TemplateArn => Str] | ||
| 1005 | |||
| 1006 | =item [ValidityNotBefore => L<Paws::ACMPCA::Validity>] | ||
| 1007 | |||
| 1008 | |||
| 1009 | =back | ||
| 1010 | |||
| 1011 | Each argument is described in detail in: L<Paws::ACMPCA::IssueCertificate> | ||
| 1012 | |||
| 1013 | Returns: a L<Paws::ACMPCA::IssueCertificateResponse> instance | ||
| 1014 | |||
| 1015 | Uses your private certificate authority (CA), or one that has been | ||
| 1016 | shared with you, to issue a client certificate. This action returns the | ||
| 1017 | Amazon Resource Name (ARN) of the certificate. You can retrieve the | ||
| 1018 | certificate by calling the GetCertificate | ||
| 1019 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificate.html) | ||
| 1020 | action and specifying the ARN. | ||
| 1021 | |||
| 1022 | You cannot use the ACM B<ListCertificateAuthorities> action to retrieve | ||
| 1023 | the ARNs of the certificates that you issue by using ACM Private CA. | ||
| 1024 | |||
| 1025 | |||
| 1026 | =head2 ListCertificateAuthorities | ||
| 1027 | |||
| 1028 | =over | ||
| 1029 | |||
| 1030 | =item [MaxResults => Int] | ||
| 1031 | |||
| 1032 | =item [NextToken => Str] | ||
| 1033 | |||
| 1034 | =item [ResourceOwner => Str] | ||
| 1035 | |||
| 1036 | |||
| 1037 | =back | ||
| 1038 | |||
| 1039 | Each argument is described in detail in: L<Paws::ACMPCA::ListCertificateAuthorities> | ||
| 1040 | |||
| 1041 | Returns: a L<Paws::ACMPCA::ListCertificateAuthoritiesResponse> instance | ||
| 1042 | |||
| 1043 | Lists the private certificate authorities that you created by using the | ||
| 1044 | CreateCertificateAuthority | ||
| 1045 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) | ||
| 1046 | action. | ||
| 1047 | |||
| 1048 | |||
| 1049 | =head2 ListPermissions | ||
| 1050 | |||
| 1051 | =over | ||
| 1052 | |||
| 1053 | =item CertificateAuthorityArn => Str | ||
| 1054 | |||
| 1055 | =item [MaxResults => Int] | ||
| 1056 | |||
| 1057 | =item [NextToken => Str] | ||
| 1058 | |||
| 1059 | |||
| 1060 | =back | ||
| 1061 | |||
| 1062 | Each argument is described in detail in: L<Paws::ACMPCA::ListPermissions> | ||
| 1063 | |||
| 1064 | Returns: a L<Paws::ACMPCA::ListPermissionsResponse> instance | ||
| 1065 | |||
| 1066 | List all permissions on a private CA, if any, granted to the AWS | ||
| 1067 | Certificate Manager (ACM) service principal (acm.amazonaws.com). | ||
| 1068 | |||
| 1069 | These permissions allow ACM to issue and renew ACM certificates that | ||
| 1070 | reside in the same AWS account as the CA. | ||
| 1071 | |||
| 1072 | Permissions can be granted with the CreatePermission | ||
| 1073 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html) | ||
| 1074 | action and revoked with the DeletePermission | ||
| 1075 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html) | ||
| 1076 | action. | ||
| 1077 | |||
| 1078 | B<About Permissions> | ||
| 1079 | |||
| 1080 | =over | ||
| 1081 | |||
| 1082 | =item * | ||
| 1083 | |||
| 1084 | If the private CA and the certificates it issues reside in the same | ||
| 1085 | account, you can use C<CreatePermission> to grant permissions for ACM | ||
| 1086 | to carry out automatic certificate renewals. | ||
| 1087 | |||
| 1088 | =item * | ||
| 1089 | |||
| 1090 | For automatic certificate renewal to succeed, the ACM service principal | ||
| 1091 | needs permissions to create, retrieve, and list certificates. | ||
| 1092 | |||
| 1093 | =item * | ||
| 1094 | |||
| 1095 | If the private CA and the ACM certificates reside in different | ||
| 1096 | accounts, then permissions cannot be used to enable automatic renewals. | ||
| 1097 | Instead, the ACM certificate owner must set up a resource-based policy | ||
| 1098 | to enable cross-account issuance and renewals. For more information, | ||
| 1099 | see Using a Resource Based Policy with ACM Private CA | ||
| 1100 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html). | ||
| 1101 | |||
| 1102 | =back | ||
| 1103 | |||
| 1104 | |||
| 1105 | |||
| 1106 | =head2 ListTags | ||
| 1107 | |||
| 1108 | =over | ||
| 1109 | |||
| 1110 | =item CertificateAuthorityArn => Str | ||
| 1111 | |||
| 1112 | =item [MaxResults => Int] | ||
| 1113 | |||
| 1114 | =item [NextToken => Str] | ||
| 1115 | |||
| 1116 | |||
| 1117 | =back | ||
| 1118 | |||
| 1119 | Each argument is described in detail in: L<Paws::ACMPCA::ListTags> | ||
| 1120 | |||
| 1121 | Returns: a L<Paws::ACMPCA::ListTagsResponse> instance | ||
| 1122 | |||
| 1123 | Lists the tags, if any, that are associated with your private CA or one | ||
| 1124 | that has been shared with you. Tags are labels that you can use to | ||
| 1125 | identify and organize your CAs. Each tag consists of a key and an | ||
| 1126 | optional value. Call the TagCertificateAuthority | ||
| 1127 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_TagCertificateAuthority.html) | ||
| 1128 | action to add one or more tags to your CA. Call the | ||
| 1129 | UntagCertificateAuthority | ||
| 1130 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UntagCertificateAuthority.html) | ||
| 1131 | action to remove tags. | ||
| 1132 | |||
| 1133 | |||
| 1134 | =head2 PutPolicy | ||
| 1135 | |||
| 1136 | =over | ||
| 1137 | |||
| 1138 | =item Policy => Str | ||
| 1139 | |||
| 1140 | =item ResourceArn => Str | ||
| 1141 | |||
| 1142 | |||
| 1143 | =back | ||
| 1144 | |||
| 1145 | Each argument is described in detail in: L<Paws::ACMPCA::PutPolicy> | ||
| 1146 | |||
| 1147 | Returns: nothing | ||
| 1148 | |||
| 1149 | Attaches a resource-based policy to a private CA. | ||
| 1150 | |||
| 1151 | A policy can also be applied by sharing a private CA through AWS | ||
| 1152 | Resource Access Manager (RAM). For more information, see Attach a | ||
| 1153 | Policy for Cross-Account Access | ||
| 1154 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html). | ||
| 1155 | |||
| 1156 | The policy can be displayed with GetPolicy | ||
| 1157 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html) | ||
| 1158 | and removed with DeletePolicy | ||
| 1159 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePolicy.html). | ||
| 1160 | |||
| 1161 | B<About Policies> | ||
| 1162 | |||
| 1163 | =over | ||
| 1164 | |||
| 1165 | =item * | ||
| 1166 | |||
| 1167 | A policy grants access on a private CA to an AWS customer account, to | ||
| 1168 | AWS Organizations, or to an AWS Organizations unit. Policies are under | ||
| 1169 | the control of a CA administrator. For more information, see Using a | ||
| 1170 | Resource Based Policy with ACM Private CA | ||
| 1171 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html). | ||
| 1172 | |||
| 1173 | =item * | ||
| 1174 | |||
| 1175 | A policy permits a user of AWS Certificate Manager (ACM) to issue ACM | ||
| 1176 | certificates signed by a CA in another account. | ||
| 1177 | |||
| 1178 | =item * | ||
| 1179 | |||
| 1180 | For ACM to manage automatic renewal of these certificates, the ACM user | ||
| 1181 | must configure a Service Linked Role (SLR). The SLR allows the ACM | ||
| 1182 | service to assume the identity of the user, subject to confirmation | ||
| 1183 | against the ACM Private CA policy. For more information, see Using a | ||
| 1184 | Service Linked Role with ACM | ||
| 1185 | (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html). | ||
| 1186 | |||
| 1187 | =item * | ||
| 1188 | |||
| 1189 | Updates made in AWS Resource Manager (RAM) are reflected in policies. | ||
| 1190 | For more information, see Attach a Policy for Cross-Account Access | ||
| 1191 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html). | ||
| 1192 | |||
| 1193 | =back | ||
| 1194 | |||
| 1195 | |||
| 1196 | |||
| 1197 | =head2 RestoreCertificateAuthority | ||
| 1198 | |||
| 1199 | =over | ||
| 1200 | |||
| 1201 | =item CertificateAuthorityArn => Str | ||
| 1202 | |||
| 1203 | |||
| 1204 | =back | ||
| 1205 | |||
| 1206 | Each argument is described in detail in: L<Paws::ACMPCA::RestoreCertificateAuthority> | ||
| 1207 | |||
| 1208 | Returns: nothing | ||
| 1209 | |||
| 1210 | Restores a certificate authority (CA) that is in the C<DELETED> state. | ||
| 1211 | You can restore a CA during the period that you defined in the | ||
| 1212 | B<PermanentDeletionTimeInDays> parameter of the | ||
| 1213 | DeleteCertificateAuthority | ||
| 1214 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeleteCertificateAuthority.html) | ||
| 1215 | action. Currently, you can specify 7 to 30 days. If you did not specify | ||
| 1216 | a B<PermanentDeletionTimeInDays> value, by default you can restore the | ||
| 1217 | CA at any time in a 30 day period. You can check the time remaining in | ||
| 1218 | the restoration period of a private CA in the C<DELETED> state by | ||
| 1219 | calling the DescribeCertificateAuthority | ||
| 1220 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DescribeCertificateAuthority.html) | ||
| 1221 | or ListCertificateAuthorities | ||
| 1222 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) | ||
| 1223 | actions. The status of a restored CA is set to its pre-deletion status | ||
| 1224 | when the B<RestoreCertificateAuthority> action returns. To change its | ||
| 1225 | status to C<ACTIVE>, call the UpdateCertificateAuthority | ||
| 1226 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) | ||
| 1227 | action. If the private CA was in the C<PENDING_CERTIFICATE> state at | ||
| 1228 | deletion, you must use the ImportCertificateAuthorityCertificate | ||
| 1229 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) | ||
| 1230 | action to import a certificate authority into the private CA before it | ||
| 1231 | can be activated. You cannot restore a CA after the restoration period | ||
| 1232 | has ended. | ||
| 1233 | |||
| 1234 | |||
| 1235 | =head2 RevokeCertificate | ||
| 1236 | |||
| 1237 | =over | ||
| 1238 | |||
| 1239 | =item CertificateAuthorityArn => Str | ||
| 1240 | |||
| 1241 | =item CertificateSerial => Str | ||
| 1242 | |||
| 1243 | =item RevocationReason => Str | ||
| 1244 | |||
| 1245 | |||
| 1246 | =back | ||
| 1247 | |||
| 1248 | Each argument is described in detail in: L<Paws::ACMPCA::RevokeCertificate> | ||
| 1249 | |||
| 1250 | Returns: nothing | ||
| 1251 | |||
| 1252 | Revokes a certificate that was issued inside ACM Private CA. If you | ||
| 1253 | enable a certificate revocation list (CRL) when you create or update | ||
| 1254 | your private CA, information about the revoked certificates will be | ||
| 1255 | included in the CRL. ACM Private CA writes the CRL to an S3 bucket that | ||
| 1256 | you specify. A CRL is typically updated approximately 30 minutes after | ||
| 1257 | a certificate is revoked. If for any reason the CRL update fails, ACM | ||
| 1258 | Private CA attempts makes further attempts every 15 minutes. With | ||
| 1259 | Amazon CloudWatch, you can create alarms for the metrics | ||
| 1260 | C<CRLGenerated> and C<MisconfiguredCRLBucket>. For more information, | ||
| 1261 | see Supported CloudWatch Metrics | ||
| 1262 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCloudWatch.html). | ||
| 1263 | |||
| 1264 | Both PCA and the IAM principal must have permission to write to the S3 | ||
| 1265 | bucket that you specify. If the IAM principal making the call does not | ||
| 1266 | have permission to write to the bucket, then an exception is thrown. | ||
| 1267 | For more information, see Configure Access to ACM Private CA | ||
| 1268 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html). | ||
| 1269 | |||
| 1270 | ACM Private CA also writes revocation information to the audit report. | ||
| 1271 | For more information, see CreateCertificateAuthorityAuditReport | ||
| 1272 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html). | ||
| 1273 | |||
| 1274 | You cannot revoke a root CA self-signed certificate. | ||
| 1275 | |||
| 1276 | |||
| 1277 | =head2 TagCertificateAuthority | ||
| 1278 | |||
| 1279 | =over | ||
| 1280 | |||
| 1281 | =item CertificateAuthorityArn => Str | ||
| 1282 | |||
| 1283 | =item Tags => ArrayRef[L<Paws::ACMPCA::Tag>] | ||
| 1284 | |||
| 1285 | |||
| 1286 | =back | ||
| 1287 | |||
| 1288 | Each argument is described in detail in: L<Paws::ACMPCA::TagCertificateAuthority> | ||
| 1289 | |||
| 1290 | Returns: nothing | ||
| 1291 | |||
| 1292 | Adds one or more tags to your private CA. Tags are labels that you can | ||
| 1293 | use to identify and organize your AWS resources. Each tag consists of a | ||
| 1294 | key and an optional value. You specify the private CA on input by its | ||
| 1295 | Amazon Resource Name (ARN). You specify the tag by using a key-value | ||
| 1296 | pair. You can apply a tag to just one private CA if you want to | ||
| 1297 | identify a specific characteristic of that CA, or you can apply the | ||
| 1298 | same tag to multiple private CAs if you want to filter for a common | ||
| 1299 | relationship among those CAs. To remove one or more tags, use the | ||
| 1300 | UntagCertificateAuthority | ||
| 1301 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UntagCertificateAuthority.html) | ||
| 1302 | action. Call the ListTags | ||
| 1303 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListTags.html) | ||
| 1304 | action to see what tags are associated with your CA. | ||
| 1305 | |||
| 1306 | |||
| 1307 | =head2 UntagCertificateAuthority | ||
| 1308 | |||
| 1309 | =over | ||
| 1310 | |||
| 1311 | =item CertificateAuthorityArn => Str | ||
| 1312 | |||
| 1313 | =item Tags => ArrayRef[L<Paws::ACMPCA::Tag>] | ||
| 1314 | |||
| 1315 | |||
| 1316 | =back | ||
| 1317 | |||
| 1318 | Each argument is described in detail in: L<Paws::ACMPCA::UntagCertificateAuthority> | ||
| 1319 | |||
| 1320 | Returns: nothing | ||
| 1321 | |||
| 1322 | Remove one or more tags from your private CA. A tag consists of a | ||
| 1323 | key-value pair. If you do not specify the value portion of the tag when | ||
| 1324 | calling this action, the tag will be removed regardless of value. If | ||
| 1325 | you specify a value, the tag is removed only if it is associated with | ||
| 1326 | the specified value. To add tags to a private CA, use the | ||
| 1327 | TagCertificateAuthority | ||
| 1328 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_TagCertificateAuthority.html). | ||
| 1329 | Call the ListTags | ||
| 1330 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListTags.html) | ||
| 1331 | action to see what tags are associated with your CA. | ||
| 1332 | |||
| 1333 | |||
| 1334 | =head2 UpdateCertificateAuthority | ||
| 1335 | |||
| 1336 | =over | ||
| 1337 | |||
| 1338 | =item CertificateAuthorityArn => Str | ||
| 1339 | |||
| 1340 | =item [RevocationConfiguration => L<Paws::ACMPCA::RevocationConfiguration>] | ||
| 1341 | |||
| 1342 | =item [Status => Str] | ||
| 1343 | |||
| 1344 | |||
| 1345 | =back | ||
| 1346 | |||
| 1347 | Each argument is described in detail in: L<Paws::ACMPCA::UpdateCertificateAuthority> | ||
| 1348 | |||
| 1349 | Returns: nothing | ||
| 1350 | |||
| 1351 | Updates the status or configuration of a private certificate authority | ||
| 1352 | (CA). Your private CA must be in the C<ACTIVE> or C<DISABLED> state | ||
| 1353 | before you can update it. You can disable a private CA that is in the | ||
| 1354 | C<ACTIVE> state or make a CA that is in the C<DISABLED> state active | ||
| 1355 | again. | ||
| 1356 | |||
| 1357 | Both PCA and the IAM principal must have permission to write to the S3 | ||
| 1358 | bucket that you specify. If the IAM principal making the call does not | ||
| 1359 | have permission to write to the bucket, then an exception is thrown. | ||
| 1360 | For more information, see Configure Access to ACM Private CA | ||
| 1361 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html). | ||
| 1362 | |||
| 1363 | |||
| 1364 | |||
| 1365 | |||
| 1366 | =head1 PAGINATORS | ||
| 1367 | |||
| 1368 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 1369 | |||
| 1370 | =head2 ListAllCertificateAuthorities(sub { },[MaxResults => Int, NextToken => Str, ResourceOwner => Str]) | ||
| 1371 | |||
| 1372 | =head2 ListAllCertificateAuthorities([MaxResults => Int, NextToken => Str, ResourceOwner => Str]) | ||
| 1373 | |||
| 1374 | |||
| 1375 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 1376 | |||
| 1377 | - CertificateAuthorities, passing the object as the first parameter, and the string 'CertificateAuthorities' as the second parameter | ||
| 1378 | |||
| 1379 | If not, it will return a a L<Paws::ACMPCA::ListCertificateAuthoritiesResponse> 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. | ||
| 1380 | |||
| 1381 | |||
| 1382 | =head2 ListAllPermissions(sub { },CertificateAuthorityArn => Str, [MaxResults => Int, NextToken => Str]) | ||
| 1383 | |||
| 1384 | =head2 ListAllPermissions(CertificateAuthorityArn => Str, [MaxResults => Int, NextToken => Str]) | ||
| 1385 | |||
| 1386 | |||
| 1387 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 1388 | |||
| 1389 | - Permissions, passing the object as the first parameter, and the string 'Permissions' as the second parameter | ||
| 1390 | |||
| 1391 | If not, it will return a a L<Paws::ACMPCA::ListPermissionsResponse> 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. | ||
| 1392 | |||
| 1393 | |||
| 1394 | =head2 ListAllTags(sub { },CertificateAuthorityArn => Str, [MaxResults => Int, NextToken => Str]) | ||
| 1395 | |||
| 1396 | =head2 ListAllTags(CertificateAuthorityArn => Str, [MaxResults => Int, NextToken => Str]) | ||
| 1397 | |||
| 1398 | |||
| 1399 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 1400 | |||
| 1401 | - Tags, passing the object as the first parameter, and the string 'Tags' as the second parameter | ||
| 1402 | |||
| 1403 | If not, it will return a a L<Paws::ACMPCA::ListTagsResponse> 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. | ||
| 1404 | |||
| 1405 | |||
| 1406 | |||
| 1407 | |||
| 1408 | |||
| 1409 | =head1 SEE ALSO | ||
| 1410 | |||
| 1411 | This service class forms part of L<Paws> | ||
| 1412 | |||
| 1413 | =head1 BUGS and CONTRIBUTIONS | ||
| 1414 | |||
| 1415 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 1416 | |||
| 1417 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 1418 | |||
| 1419 | =cut | ||
| 1420 |