aws-sdk-acmpca 1.46.0 → 1.47.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -376,20 +376,21 @@ module Aws::ACMPCA
376
376
  # CA. If successful, this action returns the Amazon Resource Name (ARN)
377
377
  # of the CA.
378
378
  #
379
- # ACM Private CA assets that are stored in Amazon S3 can be protected
380
- # with encryption. For more information, see [Encrypting Your CRLs][1].
379
+ # Amazon Web Services Private CA assets that are stored in Amazon S3 can
380
+ # be protected with encryption. For more information, see [Encrypting
381
+ # Your CRLs][1].
381
382
  #
382
383
  # <note markdown="1"> Both PCA and the IAM principal must have permission to write to the S3
383
384
  # bucket that you specify. If the IAM principal making the call does not
384
385
  # have permission to write to the bucket, then an exception is thrown.
385
- # For more information, see [Configure Access to ACM Private CA][2].
386
+ # For more information, see [Access policies for CRLs in Amazon S3][2].
386
387
  #
387
388
  # </note>
388
389
  #
389
390
  #
390
391
  #
391
392
  # [1]: https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption
392
- # [2]: https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html
393
+ # [2]: https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies
393
394
  #
394
395
  # @option params [required, Types::CertificateAuthorityConfiguration] :certificate_authority_configuration
395
396
  # Name and bit size of the private key algorithm, the name of the
@@ -415,10 +416,11 @@ module Aws::ACMPCA
415
416
  # **CreateCertificateAuthority** action. Idempotency tokens for
416
417
  # **CreateCertificateAuthority** time out after five minutes. Therefore,
417
418
  # if you call **CreateCertificateAuthority** multiple times with the
418
- # same idempotency token within five minutes, ACM Private CA recognizes
419
- # that you are requesting only certificate authority and will issue only
420
- # one. If you change the idempotency token for each call, PCA recognizes
421
- # that you are requesting multiple certificate authorities.
419
+ # same idempotency token within five minutes, Amazon Web Services
420
+ # Private CA recognizes that you are requesting only certificate
421
+ # authority and will issue only one. If you change the idempotency token
422
+ # for each call, PCA recognizes that you are requesting multiple
423
+ # certificate authorities.
422
424
  #
423
425
  # @option params [String] :key_storage_security_standard
424
426
  # Specifies a cryptographic key management compliance standard used for
@@ -469,6 +471,12 @@ module Aws::ACMPCA
469
471
  # initials: "String5",
470
472
  # pseudonym: "String128",
471
473
  # generation_qualifier: "String3",
474
+ # custom_attributes: [
475
+ # {
476
+ # object_identifier: "CustomObjectIdentifier", # required
477
+ # value: "String1To256", # required
478
+ # },
479
+ # ],
472
480
  # },
473
481
  # csr_extensions: {
474
482
  # key_usage: {
@@ -510,6 +518,12 @@ module Aws::ACMPCA
510
518
  # initials: "String5",
511
519
  # pseudonym: "String128",
512
520
  # generation_qualifier: "String3",
521
+ # custom_attributes: [
522
+ # {
523
+ # object_identifier: "CustomObjectIdentifier", # required
524
+ # value: "String1To256", # required
525
+ # },
526
+ # ],
513
527
  # },
514
528
  # edi_party_name: {
515
529
  # party_name: "String256", # required
@@ -568,19 +582,23 @@ module Aws::ACMPCA
568
582
  # <note markdown="1"> Both PCA and the IAM principal must have permission to write to the S3
569
583
  # bucket that you specify. If the IAM principal making the call does not
570
584
  # have permission to write to the bucket, then an exception is thrown.
571
- # For more information, see [Configure Access to ACM Private CA][3].
585
+ # For more information, see [Access policies for CRLs in Amazon S3][3].
572
586
  #
573
587
  # </note>
574
588
  #
575
- # ACM Private CA assets that are stored in Amazon S3 can be protected
576
- # with encryption. For more information, see [Encrypting Your Audit
577
- # Reports][4].
589
+ # Amazon Web Services Private CA assets that are stored in Amazon S3 can
590
+ # be protected with encryption. For more information, see [Encrypting
591
+ # Your Audit Reports][4].
592
+ #
593
+ # <note markdown="1"> You can generate a maximum of one report every 30 minutes.
594
+ #
595
+ # </note>
578
596
  #
579
597
  #
580
598
  #
581
599
  # [1]: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html
582
600
  # [2]: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html
583
- # [3]: https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html
601
+ # [3]: https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies
584
602
  # [4]: https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuditReport.html#audit-report-encryption
585
603
  #
586
604
  # @option params [required, String] :certificate_authority_arn
@@ -624,10 +642,10 @@ module Aws::ACMPCA
624
642
  req.send_request(options)
625
643
  end
626
644
 
627
- # Grants one or more permissions on a private CA to the AWS Certificate
645
+ # Grants one or more permissions on a private CA to the Certificate
628
646
  # Manager (ACM) service principal (`acm.amazonaws.com`). These
629
647
  # permissions allow ACM to issue and renew ACM certificates that reside
630
- # in the same AWS account as the CA.
648
+ # in the same Amazon Web Services account as the CA.
631
649
  #
632
650
  # You can list current permissions with the [ListPermissions][1] action
633
651
  # and revoke them with the [DeletePermission][2] action.
@@ -646,8 +664,8 @@ module Aws::ACMPCA
646
664
  # accounts, then permissions cannot be used to enable automatic
647
665
  # renewals. Instead, the ACM certificate owner must set up a
648
666
  # resource-based policy to enable cross-account issuance and renewals.
649
- # For more information, see [Using a Resource Based Policy with ACM
650
- # Private CA][3].
667
+ # For more information, see [Using a Resource Based Policy with Amazon
668
+ # Web Services Private CA][3].
651
669
  #
652
670
  #
653
671
  #
@@ -668,15 +686,17 @@ module Aws::ACMPCA
668
686
  # [1]: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html
669
687
  #
670
688
  # @option params [required, String] :principal
671
- # The AWS service or identity that receives the permission. At this
672
- # time, the only valid principal is `acm.amazonaws.com`.
689
+ # The Amazon Web Services service or identity that receives the
690
+ # permission. At this time, the only valid principal is
691
+ # `acm.amazonaws.com`.
673
692
  #
674
693
  # @option params [String] :source_account
675
694
  # The ID of the calling account.
676
695
  #
677
696
  # @option params [required, Array<String>] :actions
678
- # The actions that the specified AWS service principal can use. These
679
- # include `IssueCertificate`, `GetCertificate`, and `ListPermissions`.
697
+ # The actions that the specified Amazon Web Services service principal
698
+ # can use. These include `IssueCertificate`, `GetCertificate`, and
699
+ # `ListPermissions`.
680
700
  #
681
701
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
682
702
  #
@@ -716,8 +736,8 @@ module Aws::ACMPCA
716
736
  # Additionally, you can delete a CA if you are waiting for it to be
717
737
  # created (that is, the status of the CA is `CREATING`). You can also
718
738
  # delete it if the CA has been created but you haven't yet imported the
719
- # signed certificate into ACM Private CA (that is, the status of the CA
720
- # is `PENDING_CERTIFICATE`).
739
+ # signed certificate into Amazon Web Services Private CA (that is, the
740
+ # status of the CA is `PENDING_CERTIFICATE`).
721
741
  #
722
742
  # When you successfully call [DeleteCertificateAuthority][3], the CA's
723
743
  # status changes to `DELETED`. However, the CA won't be permanently
@@ -770,13 +790,13 @@ module Aws::ACMPCA
770
790
  req.send_request(options)
771
791
  end
772
792
 
773
- # Revokes permissions on a private CA granted to the AWS Certificate
774
- # Manager (ACM) service principal (acm.amazonaws.com).
793
+ # Revokes permissions on a private CA granted to the Certificate Manager
794
+ # (ACM) service principal (acm.amazonaws.com).
775
795
  #
776
796
  # These permissions allow ACM to issue and renew ACM certificates that
777
- # reside in the same AWS account as the CA. If you revoke these
778
- # permissions, ACM will no longer renew the affected certificates
779
- # automatically.
797
+ # reside in the same Amazon Web Services account as the CA. If you
798
+ # revoke these permissions, ACM will no longer renew the affected
799
+ # certificates automatically.
780
800
  #
781
801
  # Permissions can be granted with the [CreatePermission][1] action and
782
802
  # listed with the [ListPermissions][2] action.
@@ -795,8 +815,8 @@ module Aws::ACMPCA
795
815
  # accounts, then permissions cannot be used to enable automatic
796
816
  # renewals. Instead, the ACM certificate owner must set up a
797
817
  # resource-based policy to enable cross-account issuance and renewals.
798
- # For more information, see [Using a Resource Based Policy with ACM
799
- # Private CA][3].
818
+ # For more information, see [Using a Resource Based Policy with Amazon
819
+ # Web Services Private CA][3].
800
820
  #
801
821
  #
802
822
  #
@@ -818,11 +838,12 @@ module Aws::ACMPCA
818
838
  # [1]: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html
819
839
  #
820
840
  # @option params [required, String] :principal
821
- # The AWS service or identity that will have its CA permissions revoked.
822
- # At this time, the only valid service principal is `acm.amazonaws.com`
841
+ # The Amazon Web Services service or identity that will have its CA
842
+ # permissions revoked. At this time, the only valid service principal is
843
+ # `acm.amazonaws.com`
823
844
  #
824
845
  # @option params [String] :source_account
825
- # The AWS account that calls this action.
846
+ # The Amazon Web Services account that calls this action.
826
847
  #
827
848
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
828
849
  #
@@ -847,35 +868,36 @@ module Aws::ACMPCA
847
868
  # will remove any access that the policy has granted. If there is no
848
869
  # policy attached to the private CA, this action will return successful.
849
870
  #
850
- # If you delete a policy that was applied through AWS Resource Access
851
- # Manager (RAM), the CA will be removed from all shares in which it was
852
- # included.
871
+ # If you delete a policy that was applied through Amazon Web Services
872
+ # Resource Access Manager (RAM), the CA will be removed from all shares
873
+ # in which it was included.
853
874
  #
854
- # The AWS Certificate Manager Service Linked Role that the policy
855
- # supports is not affected when you delete the policy.
875
+ # The Certificate Manager Service Linked Role that the policy supports
876
+ # is not affected when you delete the policy.
856
877
  #
857
878
  # The current policy can be shown with [GetPolicy][1] and updated with
858
879
  # [PutPolicy][2].
859
880
  #
860
881
  # **About Policies**
861
882
  #
862
- # * A policy grants access on a private CA to an AWS customer account,
863
- # to AWS Organizations, or to an AWS Organizations unit. Policies are
864
- # under the control of a CA administrator. For more information, see
865
- # [Using a Resource Based Policy with ACM Private CA][3].
883
+ # * A policy grants access on a private CA to an Amazon Web Services
884
+ # customer account, to Amazon Web Services Organizations, or to an
885
+ # Amazon Web Services Organizations unit. Policies are under the
886
+ # control of a CA administrator. For more information, see [Using a
887
+ # Resource Based Policy with Amazon Web Services Private CA][3].
866
888
  #
867
- # * A policy permits a user of AWS Certificate Manager (ACM) to issue
868
- # ACM certificates signed by a CA in another account.
889
+ # * A policy permits a user of Certificate Manager (ACM) to issue ACM
890
+ # certificates signed by a CA in another account.
869
891
  #
870
892
  # * For ACM to manage automatic renewal of these certificates, the ACM
871
893
  # user must configure a Service Linked Role (SLR). The SLR allows the
872
894
  # ACM service to assume the identity of the user, subject to
873
- # confirmation against the ACM Private CA policy. For more
874
- # information, see [Using a Service Linked Role with ACM][4].
895
+ # confirmation against the Amazon Web Services Private CA policy. For
896
+ # more information, see [Using a Service Linked Role with ACM][4].
875
897
  #
876
- # * Updates made in AWS Resource Manager (RAM) are reflected in
877
- # policies. For more information, see [Attach a Policy for
878
- # Cross-Account Access][5].
898
+ # * Updates made in Amazon Web Services Resource Manager (RAM) are
899
+ # reflected in policies. For more information, see [Attach a Policy
900
+ # for Cross-Account Access][5].
879
901
  #
880
902
  #
881
903
  #
@@ -918,12 +940,13 @@ module Aws::ACMPCA
918
940
  # its ARN (Amazon Resource Name). The output contains the status of your
919
941
  # CA. This can be any of the following:
920
942
  #
921
- # * `CREATING` - ACM Private CA is creating your private certificate
922
- # authority.
943
+ # * `CREATING` - Amazon Web Services Private CA is creating your private
944
+ # certificate authority.
923
945
  #
924
946
  # * `PENDING_CERTIFICATE` - The certificate is pending. You must use
925
- # your ACM Private CA-hosted or on-premises root or subordinate CA to
926
- # sign your private CA CSR and then import it into PCA.
947
+ # your Amazon Web Services Private CA-hosted or on-premises root or
948
+ # subordinate CA to sign your private CA CSR and then import it into
949
+ # PCA.
927
950
  #
928
951
  # * `ACTIVE` - Your private CA is active.
929
952
  #
@@ -932,9 +955,9 @@ module Aws::ACMPCA
932
955
  # * `EXPIRED` - Your private CA certificate has expired.
933
956
  #
934
957
  # * `FAILED` - Your private CA has failed. Your CA can fail because of
935
- # problems such a network outage or back-end AWS failure or other
936
- # errors. A failed CA can never return to the pending state. You must
937
- # create a new CA.
958
+ # problems such a network outage or back-end Amazon Web Services
959
+ # failure or other errors. A failed CA can never return to the pending
960
+ # state. You must create a new CA.
938
961
  #
939
962
  # * `DELETED` - Your private CA is within the restoration period, after
940
963
  # which it is permanently deleted. The length of time remaining in the
@@ -989,6 +1012,9 @@ module Aws::ACMPCA
989
1012
  # resp.certificate_authority.certificate_authority_configuration.subject.initials #=> String
990
1013
  # resp.certificate_authority.certificate_authority_configuration.subject.pseudonym #=> String
991
1014
  # resp.certificate_authority.certificate_authority_configuration.subject.generation_qualifier #=> String
1015
+ # resp.certificate_authority.certificate_authority_configuration.subject.custom_attributes #=> Array
1016
+ # resp.certificate_authority.certificate_authority_configuration.subject.custom_attributes[0].object_identifier #=> String
1017
+ # resp.certificate_authority.certificate_authority_configuration.subject.custom_attributes[0].value #=> String
992
1018
  # resp.certificate_authority.certificate_authority_configuration.csr_extensions.key_usage.digital_signature #=> Boolean
993
1019
  # resp.certificate_authority.certificate_authority_configuration.csr_extensions.key_usage.non_repudiation #=> Boolean
994
1020
  # resp.certificate_authority.certificate_authority_configuration.csr_extensions.key_usage.key_encipherment #=> Boolean
@@ -1019,6 +1045,9 @@ module Aws::ACMPCA
1019
1045
  # resp.certificate_authority.certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.initials #=> String
1020
1046
  # resp.certificate_authority.certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.pseudonym #=> String
1021
1047
  # resp.certificate_authority.certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.generation_qualifier #=> String
1048
+ # resp.certificate_authority.certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.custom_attributes #=> Array
1049
+ # resp.certificate_authority.certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.custom_attributes[0].object_identifier #=> String
1050
+ # resp.certificate_authority.certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.custom_attributes[0].value #=> String
1022
1051
  # resp.certificate_authority.certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.edi_party_name.party_name #=> String
1023
1052
  # resp.certificate_authority.certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.edi_party_name.name_assigner #=> String
1024
1053
  # resp.certificate_authority.certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.uniform_resource_identifier #=> String
@@ -1209,11 +1238,11 @@ module Aws::ACMPCA
1209
1238
 
1210
1239
  # Retrieves the certificate signing request (CSR) for your private
1211
1240
  # certificate authority (CA). The CSR is created when you call the
1212
- # [CreateCertificateAuthority][1] action. Sign the CSR with your ACM
1213
- # Private CA-hosted or on-premises root or subordinate CA. Then import
1214
- # the signed certificate back into ACM Private CA by calling the
1215
- # [ImportCertificateAuthorityCertificate][2] action. The CSR is returned
1216
- # as a base64 PEM-encoded string.
1241
+ # [CreateCertificateAuthority][1] action. Sign the CSR with your Amazon
1242
+ # Web Services Private CA-hosted or on-premises root or subordinate CA.
1243
+ # Then import the signed certificate back into Amazon Web Services
1244
+ # Private CA by calling the [ImportCertificateAuthorityCertificate][2]
1245
+ # action. The CSR is returned as a base64 PEM-encoded string.
1217
1246
  #
1218
1247
  #
1219
1248
  #
@@ -1268,23 +1297,24 @@ module Aws::ACMPCA
1268
1297
  #
1269
1298
  # **About Policies**
1270
1299
  #
1271
- # * A policy grants access on a private CA to an AWS customer account,
1272
- # to AWS Organizations, or to an AWS Organizations unit. Policies are
1273
- # under the control of a CA administrator. For more information, see
1274
- # [Using a Resource Based Policy with ACM Private CA][3].
1300
+ # * A policy grants access on a private CA to an Amazon Web Services
1301
+ # customer account, to Amazon Web Services Organizations, or to an
1302
+ # Amazon Web Services Organizations unit. Policies are under the
1303
+ # control of a CA administrator. For more information, see [Using a
1304
+ # Resource Based Policy with Amazon Web Services Private CA][3].
1275
1305
  #
1276
- # * A policy permits a user of AWS Certificate Manager (ACM) to issue
1277
- # ACM certificates signed by a CA in another account.
1306
+ # * A policy permits a user of Certificate Manager (ACM) to issue ACM
1307
+ # certificates signed by a CA in another account.
1278
1308
  #
1279
1309
  # * For ACM to manage automatic renewal of these certificates, the ACM
1280
1310
  # user must configure a Service Linked Role (SLR). The SLR allows the
1281
1311
  # ACM service to assume the identity of the user, subject to
1282
- # confirmation against the ACM Private CA policy. For more
1283
- # information, see [Using a Service Linked Role with ACM][4].
1312
+ # confirmation against the Amazon Web Services Private CA policy. For
1313
+ # more information, see [Using a Service Linked Role with ACM][4].
1284
1314
  #
1285
- # * Updates made in AWS Resource Manager (RAM) are reflected in
1286
- # policies. For more information, see [Attach a Policy for
1287
- # Cross-Account Access][5].
1315
+ # * Updates made in Amazon Web Services Resource Manager (RAM) are
1316
+ # reflected in policies. For more information, see [Attach a Policy
1317
+ # for Cross-Account Access][5].
1288
1318
  #
1289
1319
  #
1290
1320
  #
@@ -1322,14 +1352,14 @@ module Aws::ACMPCA
1322
1352
  req.send_request(options)
1323
1353
  end
1324
1354
 
1325
- # Imports a signed private CA certificate into ACM Private CA. This
1326
- # action is used when you are using a chain of trust whose root is
1327
- # located outside ACM Private CA. Before you can call this action, the
1328
- # following preparations must in place:
1355
+ # Imports a signed private CA certificate into Amazon Web Services
1356
+ # Private CA. This action is used when you are using a chain of trust
1357
+ # whose root is located outside Amazon Web Services Private CA. Before
1358
+ # you can call this action, the following preparations must in place:
1329
1359
  #
1330
- # 1. In ACM Private CA, call the [CreateCertificateAuthority][1] action
1331
- # to create the private CA that you plan to back with the imported
1332
- # certificate.
1360
+ # 1. In Amazon Web Services Private CA, call the
1361
+ # [CreateCertificateAuthority][1] action to create the private CA
1362
+ # that you plan to back with the imported certificate.
1333
1363
  #
1334
1364
  # 2. Call the [GetCertificateAuthorityCsr][2] action to generate a
1335
1365
  # certificate signing request (CSR).
@@ -1340,13 +1370,14 @@ module Aws::ACMPCA
1340
1370
  # 4. Create a certificate chain and copy the signed certificate and the
1341
1371
  # certificate chain to your working directory.
1342
1372
  #
1343
- # ACM Private CA supports three scenarios for installing a CA
1344
- # certificate:
1373
+ # Amazon Web Services Private CA supports three scenarios for installing
1374
+ # a CA certificate:
1345
1375
  #
1346
- # * Installing a certificate for a root CA hosted by ACM Private CA.
1376
+ # * Installing a certificate for a root CA hosted by Amazon Web Services
1377
+ # Private CA.
1347
1378
  #
1348
1379
  # * Installing a subordinate CA certificate whose parent authority is
1349
- # hosted by ACM Private CA.
1380
+ # hosted by Amazon Web Services Private CA.
1350
1381
  #
1351
1382
  # * Installing a subordinate CA certificate whose parent authority is
1352
1383
  # externally hosted.
@@ -1374,8 +1405,8 @@ module Aws::ACMPCA
1374
1405
  #
1375
1406
  # *Enforcement of Critical Constraints*
1376
1407
  #
1377
- # ACM Private CA allows the following extensions to be marked critical
1378
- # in the imported CA certificate or chain.
1408
+ # Amazon Web Services Private CA allows the following extensions to be
1409
+ # marked critical in the imported CA certificate or chain.
1379
1410
  #
1380
1411
  # * Basic constraints (*must* be marked critical)
1381
1412
  #
@@ -1401,8 +1432,8 @@ module Aws::ACMPCA
1401
1432
  #
1402
1433
  # * Inhibit anyPolicy
1403
1434
  #
1404
- # ACM Private CA rejects the following extensions when they are marked
1405
- # critical in an imported CA certificate or chain.
1435
+ # Amazon Web Services Private CA rejects the following extensions when
1436
+ # they are marked critical in an imported CA certificate or chain.
1406
1437
  #
1407
1438
  # * Name constraints
1408
1439
  #
@@ -1440,8 +1471,9 @@ module Aws::ACMPCA
1440
1471
  # @option params [String, StringIO, File] :certificate_chain
1441
1472
  # A PEM-encoded file that contains all of your certificates, other than
1442
1473
  # the certificate you're importing, chaining up to your root CA. Your
1443
- # ACM Private CA-hosted or on-premises root certificate is the last in
1444
- # the chain, and each certificate in the chain signs the one preceding.
1474
+ # Amazon Web Services Private CA-hosted or on-premises root certificate
1475
+ # is the last in the chain, and each certificate in the chain signs the
1476
+ # one preceding.
1445
1477
  #
1446
1478
  # This parameter must be supplied when you import a subordinate CA. When
1447
1479
  # you import a root CA, there is no chain.
@@ -1472,8 +1504,8 @@ module Aws::ACMPCA
1472
1504
  # specifying the ARN.
1473
1505
  #
1474
1506
  # <note markdown="1"> You cannot use the ACM **ListCertificateAuthorities** action to
1475
- # retrieve the ARNs of the certificates that you issue by using ACM
1476
- # Private CA.
1507
+ # retrieve the ARNs of the certificates that you issue by using Amazon
1508
+ # Web Services Private CA.
1477
1509
  #
1478
1510
  # </note>
1479
1511
  #
@@ -1489,8 +1521,8 @@ module Aws::ACMPCA
1489
1521
  # Certificate Templates][1].
1490
1522
  #
1491
1523
  # If conflicting or duplicate certificate information is supplied during
1492
- # certificate issuance, ACM Private CA applies [order of operation
1493
- # rules][2] to determine what information is used.
1524
+ # certificate issuance, Amazon Web Services Private CA applies [order of
1525
+ # operation rules][2] to determine what information is used.
1494
1526
  #
1495
1527
  #
1496
1528
  #
@@ -1521,7 +1553,7 @@ module Aws::ACMPCA
1521
1553
  # contains your X509 version 3 extensions.
1522
1554
  #
1523
1555
  # `openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey
1524
- # rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out
1556
+ # rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out
1525
1557
  # csr/test_cert_.csr`
1526
1558
  #
1527
1559
  # Note: A CSR must provide either a *subject name* or a *subject
@@ -1535,10 +1567,15 @@ module Aws::ACMPCA
1535
1567
  # parameter used to sign a CSR in the `CreateCertificateAuthority`
1536
1568
  # action.
1537
1569
  #
1570
+ # <note markdown="1"> The specified signing algorithm family (RSA or ECDSA) much match the
1571
+ # algorithm family of the CA's secret key.
1572
+ #
1573
+ # </note>
1574
+ #
1538
1575
  # @option params [String] :template_arn
1539
1576
  # Specifies a custom configuration template to use when issuing a
1540
- # certificate. If this parameter is not provided, ACM Private CA
1541
- # defaults to the `EndEntityCertificate/V1` template. For CA
1577
+ # certificate. If this parameter is not provided, Amazon Web Services
1578
+ # Private CA defaults to the `EndEntityCertificate/V1` template. For CA
1542
1579
  # certificates, you should choose the shortest path length that meets
1543
1580
  # your needs. The path length is indicated by the PathLen*N* portion of
1544
1581
  # the ARN, where *N* is the [CA depth][1].
@@ -1546,8 +1583,8 @@ module Aws::ACMPCA
1546
1583
  # Note: The CA depth configured on a subordinate CA certificate must not
1547
1584
  # exceed the limit set by its parents in the CA hierarchy.
1548
1585
  #
1549
- # For a list of `TemplateArn` values supported by ACM Private CA, see
1550
- # [Understanding Certificate Templates][2].
1586
+ # For a list of `TemplateArn` values supported by Amazon Web Services
1587
+ # Private CA, see [Understanding Certificate Templates][2].
1551
1588
  #
1552
1589
  #
1553
1590
  #
@@ -1575,17 +1612,17 @@ module Aws::ACMPCA
1575
1612
  #
1576
1613
  #
1577
1614
  #
1578
- # [1]: https://tools.ietf.org/html/rfc5280#section-4.1.2.5
1615
+ # [1]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5
1579
1616
  #
1580
1617
  # @option params [Types::Validity] :validity_not_before
1581
1618
  # Information describing the start of the validity period of the
1582
1619
  # certificate. This parameter sets the “Not Before" date for the
1583
1620
  # certificate.
1584
1621
  #
1585
- # By default, when issuing a certificate, ACM Private CA sets the "Not
1586
- # Before" date to the issuance time minus 60 minutes. This compensates
1587
- # for clock inconsistencies across computer systems. The
1588
- # `ValidityNotBefore` parameter can be used to customize the “Not
1622
+ # By default, when issuing a certificate, Amazon Web Services Private CA
1623
+ # sets the "Not Before" date to the issuance time minus 60 minutes.
1624
+ # This compensates for clock inconsistencies across computer systems.
1625
+ # The `ValidityNotBefore` parameter can be used to customize the “Not
1589
1626
  # Before” value.
1590
1627
  #
1591
1628
  # Unlike the `Validity` parameter, the `ValidityNotBefore` parameter is
@@ -1599,17 +1636,17 @@ module Aws::ACMPCA
1599
1636
  #
1600
1637
  #
1601
1638
  # [1]: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_Validity.html
1602
- # [2]: https://tools.ietf.org/html/rfc5280#section-4.1.2.5
1639
+ # [2]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5
1603
1640
  #
1604
1641
  # @option params [String] :idempotency_token
1605
1642
  # Alphanumeric string that can be used to distinguish between calls to
1606
1643
  # the **IssueCertificate** action. Idempotency tokens for
1607
1644
  # **IssueCertificate** time out after one minute. Therefore, if you call
1608
1645
  # **IssueCertificate** multiple times with the same idempotency token
1609
- # within one minute, ACM Private CA recognizes that you are requesting
1610
- # only one certificate and will issue only one. If you change the
1611
- # idempotency token for each call, PCA recognizes that you are
1612
- # requesting multiple certificates.
1646
+ # within one minute, Amazon Web Services Private CA recognizes that you
1647
+ # are requesting only one certificate and will issue only one. If you
1648
+ # change the idempotency token for each call, PCA recognizes that you
1649
+ # are requesting multiple certificates.
1613
1650
  #
1614
1651
  # @return [Types::IssueCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1615
1652
  #
@@ -1673,6 +1710,12 @@ module Aws::ACMPCA
1673
1710
  # initials: "String5",
1674
1711
  # pseudonym: "String128",
1675
1712
  # generation_qualifier: "String3",
1713
+ # custom_attributes: [
1714
+ # {
1715
+ # object_identifier: "CustomObjectIdentifier", # required
1716
+ # value: "String1To256", # required
1717
+ # },
1718
+ # ],
1676
1719
  # },
1677
1720
  # edi_party_name: {
1678
1721
  # party_name: "String256", # required
@@ -1683,6 +1726,13 @@ module Aws::ACMPCA
1683
1726
  # registered_id: "CustomObjectIdentifier",
1684
1727
  # },
1685
1728
  # ],
1729
+ # custom_extensions: [
1730
+ # {
1731
+ # object_identifier: "CustomObjectIdentifier", # required
1732
+ # value: "Base64String1To4096", # required
1733
+ # critical: false,
1734
+ # },
1735
+ # ],
1686
1736
  # },
1687
1737
  # subject: {
1688
1738
  # country: "CountryCodeString",
@@ -1699,6 +1749,12 @@ module Aws::ACMPCA
1699
1749
  # initials: "String5",
1700
1750
  # pseudonym: "String128",
1701
1751
  # generation_qualifier: "String3",
1752
+ # custom_attributes: [
1753
+ # {
1754
+ # object_identifier: "CustomObjectIdentifier", # required
1755
+ # value: "String1To256", # required
1756
+ # },
1757
+ # ],
1702
1758
  # },
1703
1759
  # },
1704
1760
  # certificate_authority_arn: "Arn", # required
@@ -1797,6 +1853,9 @@ module Aws::ACMPCA
1797
1853
  # resp.certificate_authorities[0].certificate_authority_configuration.subject.initials #=> String
1798
1854
  # resp.certificate_authorities[0].certificate_authority_configuration.subject.pseudonym #=> String
1799
1855
  # resp.certificate_authorities[0].certificate_authority_configuration.subject.generation_qualifier #=> String
1856
+ # resp.certificate_authorities[0].certificate_authority_configuration.subject.custom_attributes #=> Array
1857
+ # resp.certificate_authorities[0].certificate_authority_configuration.subject.custom_attributes[0].object_identifier #=> String
1858
+ # resp.certificate_authorities[0].certificate_authority_configuration.subject.custom_attributes[0].value #=> String
1800
1859
  # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.key_usage.digital_signature #=> Boolean
1801
1860
  # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.key_usage.non_repudiation #=> Boolean
1802
1861
  # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.key_usage.key_encipherment #=> Boolean
@@ -1827,6 +1886,9 @@ module Aws::ACMPCA
1827
1886
  # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.initials #=> String
1828
1887
  # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.pseudonym #=> String
1829
1888
  # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.generation_qualifier #=> String
1889
+ # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.custom_attributes #=> Array
1890
+ # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.custom_attributes[0].object_identifier #=> String
1891
+ # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.directory_name.custom_attributes[0].value #=> String
1830
1892
  # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.edi_party_name.party_name #=> String
1831
1893
  # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.edi_party_name.name_assigner #=> String
1832
1894
  # resp.certificate_authorities[0].certificate_authority_configuration.csr_extensions.subject_information_access[0].access_location.uniform_resource_identifier #=> String
@@ -1852,11 +1914,11 @@ module Aws::ACMPCA
1852
1914
  req.send_request(options)
1853
1915
  end
1854
1916
 
1855
- # List all permissions on a private CA, if any, granted to the AWS
1917
+ # List all permissions on a private CA, if any, granted to the
1856
1918
  # Certificate Manager (ACM) service principal (acm.amazonaws.com).
1857
1919
  #
1858
1920
  # These permissions allow ACM to issue and renew ACM certificates that
1859
- # reside in the same AWS account as the CA.
1921
+ # reside in the same Amazon Web Services account as the CA.
1860
1922
  #
1861
1923
  # Permissions can be granted with the [CreatePermission][1] action and
1862
1924
  # revoked with the [DeletePermission][2] action.
@@ -1875,8 +1937,8 @@ module Aws::ACMPCA
1875
1937
  # accounts, then permissions cannot be used to enable automatic
1876
1938
  # renewals. Instead, the ACM certificate owner must set up a
1877
1939
  # resource-based policy to enable cross-account issuance and renewals.
1878
- # For more information, see [Using a Resource Based Policy with ACM
1879
- # Private CA][3].
1940
+ # For more information, see [Using a Resource Based Policy with Amazon
1941
+ # Web Services Private CA][3].
1880
1942
  #
1881
1943
  #
1882
1944
  #
@@ -2012,32 +2074,33 @@ module Aws::ACMPCA
2012
2074
 
2013
2075
  # Attaches a resource-based policy to a private CA.
2014
2076
  #
2015
- # A policy can also be applied by sharing a private CA through AWS
2016
- # Resource Access Manager (RAM). For more information, see [Attach a
2017
- # Policy for Cross-Account Access][1].
2077
+ # A policy can also be applied by sharing a private CA through Amazon
2078
+ # Web Services Resource Access Manager (RAM). For more information, see
2079
+ # [Attach a Policy for Cross-Account Access][1].
2018
2080
  #
2019
2081
  # The policy can be displayed with [GetPolicy][2] and removed with
2020
2082
  # [DeletePolicy][3].
2021
2083
  #
2022
2084
  # **About Policies**
2023
2085
  #
2024
- # * A policy grants access on a private CA to an AWS customer account,
2025
- # to AWS Organizations, or to an AWS Organizations unit. Policies are
2026
- # under the control of a CA administrator. For more information, see
2027
- # [Using a Resource Based Policy with ACM Private CA][4].
2086
+ # * A policy grants access on a private CA to an Amazon Web Services
2087
+ # customer account, to Amazon Web Services Organizations, or to an
2088
+ # Amazon Web Services Organizations unit. Policies are under the
2089
+ # control of a CA administrator. For more information, see [Using a
2090
+ # Resource Based Policy with Amazon Web Services Private CA][4].
2028
2091
  #
2029
- # * A policy permits a user of AWS Certificate Manager (ACM) to issue
2030
- # ACM certificates signed by a CA in another account.
2092
+ # * A policy permits a user of Certificate Manager (ACM) to issue ACM
2093
+ # certificates signed by a CA in another account.
2031
2094
  #
2032
2095
  # * For ACM to manage automatic renewal of these certificates, the ACM
2033
2096
  # user must configure a Service Linked Role (SLR). The SLR allows the
2034
2097
  # ACM service to assume the identity of the user, subject to
2035
- # confirmation against the ACM Private CA policy. For more
2036
- # information, see [Using a Service Linked Role with ACM][5].
2098
+ # confirmation against the Amazon Web Services Private CA policy. For
2099
+ # more information, see [Using a Service Linked Role with ACM][5].
2037
2100
  #
2038
- # * Updates made in AWS Resource Manager (RAM) are reflected in
2039
- # policies. For more information, see [Attach a Policy for
2040
- # Cross-Account Access][1].
2101
+ # * Updates made in Amazon Web Services Resource Manager (RAM) are
2102
+ # reflected in policies. For more information, see [Attach a Policy
2103
+ # for Cross-Account Access][1].
2041
2104
  #
2042
2105
  #
2043
2106
  #
@@ -2142,26 +2205,28 @@ module Aws::ACMPCA
2142
2205
  req.send_request(options)
2143
2206
  end
2144
2207
 
2145
- # Revokes a certificate that was issued inside ACM Private CA. If you
2146
- # enable a certificate revocation list (CRL) when you create or update
2147
- # your private CA, information about the revoked certificates will be
2148
- # included in the CRL. ACM Private CA writes the CRL to an S3 bucket
2149
- # that you specify. A CRL is typically updated approximately 30 minutes
2150
- # after a certificate is revoked. If for any reason the CRL update
2151
- # fails, ACM Private CA attempts makes further attempts every 15
2152
- # minutes. With Amazon CloudWatch, you can create alarms for the metrics
2153
- # `CRLGenerated` and `MisconfiguredCRLBucket`. For more information, see
2154
- # [Supported CloudWatch Metrics][1].
2208
+ # Revokes a certificate that was issued inside Amazon Web Services
2209
+ # Private CA. If you enable a certificate revocation list (CRL) when you
2210
+ # create or update your private CA, information about the revoked
2211
+ # certificates will be included in the CRL. Amazon Web Services Private
2212
+ # CA writes the CRL to an S3 bucket that you specify. A CRL is typically
2213
+ # updated approximately 30 minutes after a certificate is revoked. If
2214
+ # for any reason the CRL update fails, Amazon Web Services Private CA
2215
+ # attempts makes further attempts every 15 minutes. With Amazon
2216
+ # CloudWatch, you can create alarms for the metrics `CRLGenerated` and
2217
+ # `MisconfiguredCRLBucket`. For more information, see [Supported
2218
+ # CloudWatch Metrics][1].
2155
2219
  #
2156
2220
  # <note markdown="1"> Both PCA and the IAM principal must have permission to write to the S3
2157
2221
  # bucket that you specify. If the IAM principal making the call does not
2158
2222
  # have permission to write to the bucket, then an exception is thrown.
2159
- # For more information, see [Configure Access to ACM Private CA][2].
2223
+ # For more information, see [Access policies for CRLs in Amazon S3][2].
2160
2224
  #
2161
2225
  # </note>
2162
2226
  #
2163
- # ACM Private CA also writes revocation information to the audit report.
2164
- # For more information, see [CreateCertificateAuthorityAuditReport][3].
2227
+ # Amazon Web Services Private CA also writes revocation information to
2228
+ # the audit report. For more information, see
2229
+ # [CreateCertificateAuthorityAuditReport][3].
2165
2230
  #
2166
2231
  # <note markdown="1"> You cannot revoke a root CA self-signed certificate.
2167
2232
  #
@@ -2170,7 +2235,7 @@ module Aws::ACMPCA
2170
2235
  #
2171
2236
  #
2172
2237
  # [1]: https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCloudWatch.html
2173
- # [2]: https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html
2238
+ # [2]: https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies
2174
2239
  # [3]: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html
2175
2240
  #
2176
2241
  # @option params [required, String] :certificate_authority_arn
@@ -2192,7 +2257,7 @@ module Aws::ACMPCA
2192
2257
  # `openssl x509 -in file_path -text -noout`
2193
2258
  #
2194
2259
  # You can also copy the serial number from the console or use the
2195
- # [DescribeCertificate][2] action in the *AWS Certificate Manager API
2260
+ # [DescribeCertificate][2] action in the *Certificate Manager API
2196
2261
  # Reference*.
2197
2262
  #
2198
2263
  #
@@ -2223,15 +2288,15 @@ module Aws::ACMPCA
2223
2288
  end
2224
2289
 
2225
2290
  # Adds one or more tags to your private CA. Tags are labels that you can
2226
- # use to identify and organize your AWS resources. Each tag consists of
2227
- # a key and an optional value. You specify the private CA on input by
2228
- # its Amazon Resource Name (ARN). You specify the tag by using a
2229
- # key-value pair. You can apply a tag to just one private CA if you want
2230
- # to identify a specific characteristic of that CA, or you can apply the
2231
- # same tag to multiple private CAs if you want to filter for a common
2232
- # relationship among those CAs. To remove one or more tags, use the
2233
- # [UntagCertificateAuthority][1] action. Call the [ListTags][2] action
2234
- # to see what tags are associated with your CA.
2291
+ # use to identify and organize your Amazon Web Services resources. Each
2292
+ # tag consists of a key and an optional value. You specify the private
2293
+ # CA on input by its Amazon Resource Name (ARN). You specify the tag by
2294
+ # using a key-value pair. You can apply a tag to just one private CA if
2295
+ # you want to identify a specific characteristic of that CA, or you can
2296
+ # apply the same tag to multiple private CAs if you want to filter for a
2297
+ # common relationship among those CAs. To remove one or more tags, use
2298
+ # the [UntagCertificateAuthority][1] action. Call the [ListTags][2]
2299
+ # action to see what tags are associated with your CA.
2235
2300
  #
2236
2301
  #
2237
2302
  #
@@ -2334,13 +2399,13 @@ module Aws::ACMPCA
2334
2399
  # <note markdown="1"> Both PCA and the IAM principal must have permission to write to the S3
2335
2400
  # bucket that you specify. If the IAM principal making the call does not
2336
2401
  # have permission to write to the bucket, then an exception is thrown.
2337
- # For more information, see [Configure Access to ACM Private CA][1].
2402
+ # For more information, see [Access policies for CRLs in Amazon S3][1].
2338
2403
  #
2339
2404
  # </note>
2340
2405
  #
2341
2406
  #
2342
2407
  #
2343
- # [1]: https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html
2408
+ # [1]: https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies
2344
2409
  #
2345
2410
  # @option params [required, String] :certificate_authority_arn
2346
2411
  # Amazon Resource Name (ARN) of the private CA that issued the
@@ -2408,7 +2473,7 @@ module Aws::ACMPCA
2408
2473
  params: params,
2409
2474
  config: config)
2410
2475
  context[:gem_name] = 'aws-sdk-acmpca'
2411
- context[:gem_version] = '1.46.0'
2476
+ context[:gem_version] = '1.47.0'
2412
2477
  Seahorse::Client::Request.new(handlers, context)
2413
2478
  end
2414
2479