AWS SDK for PHP 3.x (original) (raw)

An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.

InvalidPolicyException:

One or more of the specified arguments was not valid.

InvalidTagException:

The tag associated with the CA is not valid. The invalid argument is contained in the message field.

The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see Overview of JSON Policies.

CreateCertificateAuthorityAuditReport

result=result = result=client->createCertificateAuthorityAuditReport([/* ... /]); promise=promise = promise=client->createCertificateAuthorityAuditReportAsync([/ ... */]);

Creates an audit report that lists every time that your CA private key is used to issue a certificate. The IssueCertificate and RevokeCertificate actions use the private key.

To save the audit report to your designated Amazon S3 bucket, you must create a bucket policy that grants Amazon Web Services Private CA permission to access and write to it. For an example policy, see Prepare an Amazon S3 bucket for audit reports.

Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.

You can generate a maximum of one report every 30 minutes.

Parameter Syntax

result=result = result=client->createCertificateAuthorityAuditReport([ 'AuditReportResponseFormat' => 'JSON|CSV', // REQUIRED 'CertificateAuthorityArn' => '', // REQUIRED 'S3BucketName' => '', // REQUIRED ]);

Parameter Details

Members

AuditReportResponseFormat

Required: Yes

Type: string

The format in which to create the report. This can be either JSON or CSV.

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_ .

S3BucketName

Required: Yes

Type: string

The name of the S3 bucket that will contain the audit report.

Result Syntax

[ 'AuditReportId' => '', 'S3Key' => '', ]

Result Details

Members

AuditReportId

An alphanumeric string that contains a report identifier.

S3Key

The key that uniquely identifies the report file in your S3 bucket.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

One or more of the specified arguments was not valid.

The request has failed for an unspecified reason.

The state of the private CA does not allow this action to occur.

Your request is already in progress.

CreatePermission

result=result = result=client->createPermission([/* ... /]); promise=promise = promise=client->createPermissionAsync([/ ... */]);

Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

About Permissions

If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.
For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.
If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

Parameter Syntax

result=result = result=client->createPermission([ 'Actions' => ['', ...], // REQUIRED 'CertificateAuthorityArn' => '', // REQUIRED 'Principal' => '', // REQUIRED 'SourceAccount' => '', ]);

Parameter Details

Members

Actions

Required: Yes

Type: Array of strings

The actions that the specified Amazon Web Services service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_ .

Principal

Required: Yes

Type: string

The Amazon Web Services service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

SourceAccount

The ID of the calling account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

PermissionAlreadyExistsException:

An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.

The designated permission has already been given to the user.

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request has failed for an unspecified reason.

The state of the private CA does not allow this action to occur.

DeleteCertificateAuthority

result=result = result=client->deleteCertificateAuthority([/* ... /]); promise=promise = promise=client->deleteCertificateAuthorityAsync([/ ... */]);

Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.

Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.

Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.

Parameter Syntax

result=result = result=client->deleteCertificateAuthority([ 'CertificateAuthorityArn' => '', // REQUIRED 'PermanentDeletionTimeInDays' => , ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_ .

PermanentDeletionTimeInDays

The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The state of the private CA does not allow this action to occur.

A previous update to your private CA is still ongoing.

DeletePermission

result=result = result=client->deletePermission([/* ... /]); promise=promise = promise=client->deletePermissionAsync([/ ... */]);

Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.

About Permissions

If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.
For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.
If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

Parameter Syntax

result=result = result=client->deletePermission([ 'CertificateAuthorityArn' => '', // REQUIRED 'Principal' => '', // REQUIRED 'SourceAccount' => '', ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_ .

Principal

Required: Yes

Type: string

The Amazon Web Services service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

SourceAccount

The Amazon Web Services account that calls this action.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request has failed for an unspecified reason.

LockoutPreventedException:

The state of the private CA does not allow this action to occur.

DeletePolicy

result=result = result=client->deletePolicy([/* ... /]); promise=promise = promise=client->deletePolicyAsync([/ ... */]);

Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.

The current policy can be shown with GetPolicy and updated with PutPolicy.

About Policies

A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.
A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

Parameter Syntax

result=result = result=client->deletePolicy([ 'ResourceArn' => '', // REQUIRED ]);

Parameter Details

Members

ResourceArn

Required: Yes

Type: string

The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The current action was prevented because it would lock the caller out from performing subsequent actions. Verify that the specified parameters would not result in the caller being denied access to the resource.

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request has failed for an unspecified reason.

The state of the private CA does not allow this action to occur.

A previous update to your private CA is still ongoing.

DescribeCertificateAuthority

result=result = result=client->describeCertificateAuthority([/* ... /]); promise=promise = promise=client->describeCertificateAuthorityAsync([/ ... */]);

Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

CREATING - Amazon Web Services Private CA is creating your private certificate authority.
PENDING_CERTIFICATE - The certificate is pending. You must use your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into Amazon Web Services Private CA.
ACTIVE - Your private CA is active.
DISABLED - Your private CA has been disabled.
EXPIRED - Your private CA certificate has expired.
FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or back-end Amazon Web Services failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.

Parameter Syntax

result=result = result=client->describeCertificateAuthority([ 'CertificateAuthorityArn' => '', // REQUIRED ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_ .

Result Syntax

[ 'CertificateAuthority' => [ 'Arn' => '', 'CertificateAuthorityConfiguration' => [ 'CsrExtensions' => [ 'KeyUsage' => [ 'CRLSign' => true || false, 'DataEncipherment' => true || false, 'DecipherOnly' => true || false, 'DigitalSignature' => true || false, 'EncipherOnly' => true || false, 'KeyAgreement' => true || false, 'KeyCertSign' => true || false, 'KeyEncipherment' => true || false, 'NonRepudiation' => true || false, ], 'SubjectInformationAccess' => [ [ 'AccessLocation' => [ 'DirectoryName' => [ 'CommonName' => '', 'Country' => '', 'CustomAttributes' => [ [ 'ObjectIdentifier' => '', 'Value' => '', ], // ... ], 'DistinguishedNameQualifier' => '', 'GenerationQualifier' => '', 'GivenName' => '', 'Initials' => '', 'Locality' => '', 'Organization' => '', 'OrganizationalUnit' => '', 'Pseudonym' => '', 'SerialNumber' => '', 'State' => '', 'Surname' => '', 'Title' => '', ], 'DnsName' => '', 'EdiPartyName' => [ 'NameAssigner' => '', 'PartyName' => '', ], 'IpAddress' => '', 'OtherName' => [ 'TypeId' => '', 'Value' => '', ], 'RegisteredId' => '', 'Rfc822Name' => '', 'UniformResourceIdentifier' => '', ], 'AccessMethod' => [ 'AccessMethodType' => 'CA_REPOSITORY|RESOURCE_PKI_MANIFEST|RESOURCE_PKI_NOTIFY', 'CustomObjectIdentifier' => '', ], ], // ... ], ], 'KeyAlgorithm' => 'RSA_2048|RSA_3072|RSA_4096|EC_prime256v1|EC_secp384r1|EC_secp521r1|SM2', 'SigningAlgorithm' => 'SHA256WITHECDSA|SHA384WITHECDSA|SHA512WITHECDSA|SHA256WITHRSA|SHA384WITHRSA|SHA512WITHRSA|SM3WITHSM2', 'Subject' => [ 'CommonName' => '', 'Country' => '', 'CustomAttributes' => [ [ 'ObjectIdentifier' => '', 'Value' => '', ], // ... ], 'DistinguishedNameQualifier' => '', 'GenerationQualifier' => '', 'GivenName' => '', 'Initials' => '', 'Locality' => '', 'Organization' => '', 'OrganizationalUnit' => '', 'Pseudonym' => '', 'SerialNumber' => '', 'State' => '', 'Surname' => '', 'Title' => '', ], ], 'CreatedAt' => , 'FailureReason' => 'REQUEST_TIMED_OUT|UNSUPPORTED_ALGORITHM|OTHER', 'KeyStorageSecurityStandard' => 'FIPS_140_2_LEVEL_2_OR_HIGHER|FIPS_140_2_LEVEL_3_OR_HIGHER|CCPC_LEVEL_1_OR_HIGHER', 'LastStateChangeAt' => , 'NotAfter' => , 'NotBefore' => , 'OwnerAccount' => '', 'RestorableUntil' => , 'RevocationConfiguration' => [ 'CrlConfiguration' => [ 'CrlDistributionPointExtensionConfiguration' => [ 'OmitExtension' => true || false, ], 'CrlType' => 'COMPLETE|PARTITIONED', 'CustomCname' => '', 'CustomPath' => '', 'Enabled' => true || false, 'ExpirationInDays' => , 'S3BucketName' => '', 'S3ObjectAcl' => 'PUBLIC_READ|BUCKET_OWNER_FULL_CONTROL', ], 'OcspConfiguration' => [ 'Enabled' => true || false, 'OcspCustomCname' => '', ], ], 'Serial' => '', 'Status' => 'CREATING|PENDING_CERTIFICATE|ACTIVE|DELETED|DISABLED|EXPIRED|FAILED', 'Type' => 'ROOT|SUBORDINATE', 'UsageMode' => 'GENERAL_PURPOSE|SHORT_LIVED_CERTIFICATE', ], ]

Result Details

Members

CertificateAuthority

Type: CertificateAuthority structure

A CertificateAuthority structure that contains information about your private CA.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

DescribeCertificateAuthorityAuditReport

result=result = result=client->describeCertificateAuthorityAuditReport([/* ... /]); promise=promise = promise=client->describeCertificateAuthorityAuditReportAsync([/ ... */]);

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.

Parameter Syntax

result=result = result=client->describeCertificateAuthorityAuditReport([ 'AuditReportId' => '', // REQUIRED 'CertificateAuthorityArn' => '', // REQUIRED ]);

Parameter Details

Members

AuditReportId

Required: Yes

Type: string

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the private CA. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_ .

Result Syntax

[ 'AuditReportStatus' => 'CREATING|SUCCESS|FAILED', 'CreatedAt' => , 'S3BucketName' => '', 'S3Key' => '', ]

Result Details

Members

AuditReportStatus

Specifies whether report creation is in progress, has succeeded, or has failed.

CreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time at which the report was created.

S3BucketName

Name of the S3 bucket that contains the report.

S3Key

S3 key that uniquely identifies the report file in your S3 bucket.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

One or more of the specified arguments was not valid.

GetCertificate

result=result = result=client->getCertificate([/* ... /]); promise=promise = promise=client->getCertificateAsync([/ ... */]);

Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.

Parameter Syntax

result=result = result=client->getCertificate([ 'CertificateArn' => '', // REQUIRED 'CertificateAuthorityArn' => '', // REQUIRED ]);

Parameter Details

Members

CertificateArn

Required: Yes

Type: string

The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_/certificate/_286535153982981100925020015808220737245_

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_ .

Result Syntax

[ 'Certificate' => '', 'CertificateChain' => '', ]

Result Details

Members

Certificate

The base64 PEM-encoded certificate specified by the CertificateArn parameter.

CertificateChain

The base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request has failed for an unspecified reason.

The state of the private CA does not allow this action to occur.

Your request is already in progress.

GetCertificateAuthorityCertificate

result=result = result=client->getCertificateAuthorityCertificate([/* ... /]); promise=promise = promise=client->getCertificateAuthorityCertificateAsync([/ ... */]);

Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.

Parameter Syntax

result=result = result=client->getCertificateAuthorityCertificate([ 'CertificateAuthorityArn' => '', // REQUIRED ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of your private CA. This is of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_ .

Result Syntax

[ 'Certificate' => '', 'CertificateChain' => '', ]

Result Details

Members

Certificate

Base64-encoded certificate authority (CA) certificate.

CertificateChain

Base64-encoded certificate chain that includes any intermediate certificates and chains up to root certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. If this is a root CA, the value will be null.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The state of the private CA does not allow this action to occur.

GetCertificateAuthorityCsr

result=result = result=client->getCertificateAuthorityCsr([/* ... /]); promise=promise = promise=client->getCertificateAuthorityCsrAsync([/ ... */]);

Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into Amazon Web Services Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.

Parameter Syntax

result=result = result=client->getCertificateAuthorityCsr([ 'CertificateAuthorityArn' => '', // REQUIRED ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_

Result Syntax

[ 'Csr' => '', ]

Result Details

Members

Csr

The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request has failed for an unspecified reason.

The state of the private CA does not allow this action to occur.

Your request is already in progress.

GetPolicy

result=result = result=client->getPolicy([/* ... /]); promise=promise = promise=client->getPolicyAsync([/ ... */]);

Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

About Policies

A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.
A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

Parameter Syntax

result=result = result=client->getPolicy([ 'ResourceArn' => '', // REQUIRED ]);

Parameter Details

Members

ResourceArn

Required: Yes

Type: string

The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.

 </p>

Result Syntax

[ 'Policy' => '', ]

Result Details

Members

Policy

The policy attached to the private CA as a JSON document.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request has failed for an unspecified reason.

CertificateMismatchException:

The state of the private CA does not allow this action to occur.

ImportCertificateAuthorityCertificate

result=result = result=client->importCertificateAuthorityCertificate([/* ... /]); promise=promise = promise=client->importCertificateAuthorityCertificateAsync([/ ... */]);

Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place:

In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate.
Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.
Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

Amazon Web Services Private CA supports three scenarios for installing a CA certificate:

Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA.
Installing a subordinate CA certificate whose parent authority is externally hosted.

The following additional requirements apply when you import a CA certificate.

Only a self-signed certificate can be imported as a root CA.
A self-signed certificate cannot be imported as a subordinate CA.
Your certificate chain must not include the private CA certificate that you are importing.
Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
The chain must be PEM-encoded.
The maximum allowed size of a certificate is 32 KB.
The maximum allowed size of a certificate chain is 2 MB.

Enforcement of Critical Constraints

Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

Authority key identifier
Basic constraints (must be marked critical)
Certificate policies
Extended key usage
Inhibit anyPolicy
Issuer alternative name
Key usage
Name constraints
Policy mappings
Subject alternative name
Subject directory attributes
Subject key identifier
Subject information access

Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

Authority information access
CRL distribution points
Freshest CRL
Policy constraints

Amazon Web Services Private Certificate Authority will also reject any other extension marked as critical not contained on the preceding list of allowed extensions.

Parameter Syntax

result=result = result=client->importCertificateAuthorityCertificate([ 'Certificate' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'CertificateAuthorityArn' => '', // REQUIRED 'CertificateChain' => <string || resource || Psr\Http\Message\StreamInterface>, ]);

Parameter Details

Members

Certificate

Required: Yes

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The PEM-encoded certificate for a private CA. This may be a self-signed certificate in the case of a root CA, or it may be signed by another CA that you control.

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_

CertificateChain

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.

This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.

MalformedCertificateException:

One or more fields in the certificate are invalid.

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

InvalidRequestException:

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request action cannot be performed or is prohibited.

The request has failed for an unspecified reason.

The state of the private CA does not allow this action to occur.

A previous update to your private CA is still ongoing.

Your request is already in progress.

IssueCertificate

result=result = result=client->issueCertificate([/* ... /]); promise=promise = promise=client->issueCertificateAsync([/ ... */]);

Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using Amazon Web Services Private CA.

Parameter Syntax

result=result = result=client->issueCertificate([ 'ApiPassthrough' => [ 'Extensions' => [ 'CertificatePolicies' => [ [ 'CertPolicyId' => '', // REQUIRED 'PolicyQualifiers' => [ [ 'PolicyQualifierId' => 'CPS', // REQUIRED 'Qualifier' => [ // REQUIRED 'CpsUri' => '', // REQUIRED ], ], // ... ], ], // ... ], 'CustomExtensions' => [ [ 'Critical' => true || false, 'ObjectIdentifier' => '', // REQUIRED 'Value' => '', // REQUIRED ], // ... ], 'ExtendedKeyUsage' => [ [ 'ExtendedKeyUsageObjectIdentifier' => '', 'ExtendedKeyUsageType' => 'SERVER_AUTH|CLIENT_AUTH|CODE_SIGNING|EMAIL_PROTECTION|TIME_STAMPING|OCSP_SIGNING|SMART_CARD_LOGIN|DOCUMENT_SIGNING|CERTIFICATE_TRANSPARENCY', ], // ... ], 'KeyUsage' => [ 'CRLSign' => true || false, 'DataEncipherment' => true || false, 'DecipherOnly' => true || false, 'DigitalSignature' => true || false, 'EncipherOnly' => true || false, 'KeyAgreement' => true || false, 'KeyCertSign' => true || false, 'KeyEncipherment' => true || false, 'NonRepudiation' => true || false, ], 'SubjectAlternativeNames' => [ [ 'DirectoryName' => [ 'CommonName' => '', 'Country' => '', 'CustomAttributes' => [ [ 'ObjectIdentifier' => '', // REQUIRED 'Value' => '', // REQUIRED ], // ... ], 'DistinguishedNameQualifier' => '', 'GenerationQualifier' => '', 'GivenName' => '', 'Initials' => '', 'Locality' => '', 'Organization' => '', 'OrganizationalUnit' => '', 'Pseudonym' => '', 'SerialNumber' => '', 'State' => '', 'Surname' => '', 'Title' => '', ], 'DnsName' => '', 'EdiPartyName' => [ 'NameAssigner' => '', 'PartyName' => '', // REQUIRED ], 'IpAddress' => '', 'OtherName' => [ 'TypeId' => '', // REQUIRED 'Value' => '', // REQUIRED ], 'RegisteredId' => '', 'Rfc822Name' => '', 'UniformResourceIdentifier' => '', ], // ... ], ], 'Subject' => [ 'CommonName' => '', 'Country' => '', 'CustomAttributes' => [ [ 'ObjectIdentifier' => '', // REQUIRED 'Value' => '', // REQUIRED ], // ... ], 'DistinguishedNameQualifier' => '', 'GenerationQualifier' => '', 'GivenName' => '', 'Initials' => '', 'Locality' => '', 'Organization' => '', 'OrganizationalUnit' => '', 'Pseudonym' => '', 'SerialNumber' => '', 'State' => '', 'Surname' => '', 'Title' => '', ], ], 'CertificateAuthorityArn' => '', // REQUIRED 'Csr' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'IdempotencyToken' => '', 'SigningAlgorithm' => 'SHA256WITHECDSA|SHA384WITHECDSA|SHA512WITHECDSA|SHA256WITHRSA|SHA384WITHRSA|SHA512WITHRSA|SM3WITHSM2', // REQUIRED 'TemplateArn' => '', 'Validity' => [ // REQUIRED 'Type' => 'END_DATE|ABSOLUTE|DAYS|MONTHS|YEARS', // REQUIRED 'Value' => , // REQUIRED ], 'ValidityNotBefore' => [ 'Type' => 'END_DATE|ABSOLUTE|DAYS|MONTHS|YEARS', // REQUIRED 'Value' => , // REQUIRED ], ]);

Parameter Details

Members

ApiPassthrough

Type: ApiPassthrough structure

Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.

If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_

Csr

Required: Yes

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The certificate signing request (CSR) for the certificate you want to issue. As an example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

If you have a configuration file, you can then use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

IdempotencyToken

Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after five minutes. Therefore, if you call IssueCertificate multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.

SigningAlgorithm

Required: Yes

Type: string

The name of the algorithm that will be used to sign the certificate to be issued.

This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action.

The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

TemplateArn

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, Amazon Web Services Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLen_N_ portion of the ARN, where N is the CA depth.

Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding Certificate Templates.

Validity

Required: Yes

Type: Validity structure

Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.

Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.

ValidityNotBefore

Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.

By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.

Unlike the Validity parameter, the ValidityNotBefore parameter is optional.

The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.

Result Syntax

[ 'CertificateArn' => '', ]

Result Details

Members

CertificateArn

The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_/certificate/_286535153982981100925020015808220737245_

Errors

An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

One or more of the specified arguments was not valid.

MalformedCSRException:

The state of the private CA does not allow this action to occur.

The certificate signing request is invalid.

ListCertificateAuthorities

result=result = result=client->listCertificateAuthorities([/* ... /]); promise=promise = promise=client->listCertificateAuthoritiesAsync([/ ... */]);

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.

Parameter Syntax

result=result = result=client->listCertificateAuthorities([ 'MaxResults' => , 'NextToken' => '', 'ResourceOwner' => 'SELF|OTHER_ACCOUNTS', ]);

Parameter Details

Members

MaxResults

Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

Although the maximum value is 1000, the action only returns a maximum of 100 items.

NextToken

Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.

ResourceOwner

Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF.

Result Syntax

[ 'CertificateAuthorities' => [ [ 'Arn' => '', 'CertificateAuthorityConfiguration' => [ 'CsrExtensions' => [ 'KeyUsage' => [ 'CRLSign' => true || false, 'DataEncipherment' => true || false, 'DecipherOnly' => true || false, 'DigitalSignature' => true || false, 'EncipherOnly' => true || false, 'KeyAgreement' => true || false, 'KeyCertSign' => true || false, 'KeyEncipherment' => true || false, 'NonRepudiation' => true || false, ], 'SubjectInformationAccess' => [ [ 'AccessLocation' => [ 'DirectoryName' => [ 'CommonName' => '', 'Country' => '', 'CustomAttributes' => [ [ 'ObjectIdentifier' => '', 'Value' => '', ], // ... ], 'DistinguishedNameQualifier' => '', 'GenerationQualifier' => '', 'GivenName' => '', 'Initials' => '', 'Locality' => '', 'Organization' => '', 'OrganizationalUnit' => '', 'Pseudonym' => '', 'SerialNumber' => '', 'State' => '', 'Surname' => '', 'Title' => '', ], 'DnsName' => '', 'EdiPartyName' => [ 'NameAssigner' => '', 'PartyName' => '', ], 'IpAddress' => '', 'OtherName' => [ 'TypeId' => '', 'Value' => '', ], 'RegisteredId' => '', 'Rfc822Name' => '', 'UniformResourceIdentifier' => '', ], 'AccessMethod' => [ 'AccessMethodType' => 'CA_REPOSITORY|RESOURCE_PKI_MANIFEST|RESOURCE_PKI_NOTIFY', 'CustomObjectIdentifier' => '', ], ], // ... ], ], 'KeyAlgorithm' => 'RSA_2048|RSA_3072|RSA_4096|EC_prime256v1|EC_secp384r1|EC_secp521r1|SM2', 'SigningAlgorithm' => 'SHA256WITHECDSA|SHA384WITHECDSA|SHA512WITHECDSA|SHA256WITHRSA|SHA384WITHRSA|SHA512WITHRSA|SM3WITHSM2', 'Subject' => [ 'CommonName' => '', 'Country' => '', 'CustomAttributes' => [ [ 'ObjectIdentifier' => '', 'Value' => '', ], // ... ], 'DistinguishedNameQualifier' => '', 'GenerationQualifier' => '', 'GivenName' => '', 'Initials' => '', 'Locality' => '', 'Organization' => '', 'OrganizationalUnit' => '', 'Pseudonym' => '', 'SerialNumber' => '', 'State' => '', 'Surname' => '', 'Title' => '', ], ], 'CreatedAt' => , 'FailureReason' => 'REQUEST_TIMED_OUT|UNSUPPORTED_ALGORITHM|OTHER', 'KeyStorageSecurityStandard' => 'FIPS_140_2_LEVEL_2_OR_HIGHER|FIPS_140_2_LEVEL_3_OR_HIGHER|CCPC_LEVEL_1_OR_HIGHER', 'LastStateChangeAt' => , 'NotAfter' => , 'NotBefore' => , 'OwnerAccount' => '', 'RestorableUntil' => , 'RevocationConfiguration' => [ 'CrlConfiguration' => [ 'CrlDistributionPointExtensionConfiguration' => [ 'OmitExtension' => true || false, ], 'CrlType' => 'COMPLETE|PARTITIONED', 'CustomCname' => '', 'CustomPath' => '', 'Enabled' => true || false, 'ExpirationInDays' => , 'S3BucketName' => '', 'S3ObjectAcl' => 'PUBLIC_READ|BUCKET_OWNER_FULL_CONTROL', ], 'OcspConfiguration' => [ 'Enabled' => true || false, 'OcspCustomCname' => '', ], ], 'Serial' => '', 'Status' => 'CREATING|PENDING_CERTIFICATE|ACTIVE|DELETED|DISABLED|EXPIRED|FAILED', 'Type' => 'ROOT|SUBORDINATE', 'UsageMode' => 'GENERAL_PURPOSE|SHORT_LIVED_CERTIFICATE', ], // ... ], 'NextToken' => '', ]

Result Details

Members

CertificateAuthorities

Type: Array of CertificateAuthority structures

Summary information about each certificate authority you have created.

NextToken

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

Errors

InvalidNextTokenException:

The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.

ListPermissions

result=result = result=client->listPermissions([/* ... /]); promise=promise = promise=client->listPermissionsAsync([/ ... */]);

List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

About Permissions

If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.
For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.
If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

Parameter Syntax

result=result = result=client->listPermissions([ 'CertificateAuthorityArn' => '', // REQUIRED 'MaxResults' => , 'NextToken' => '', ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.

MaxResults

When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

NextToken

When paginating results, use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

Result Syntax

[ 'NextToken' => '', 'Permissions' => [ [ 'Actions' => ['', ...], 'CertificateAuthorityArn' => '', 'CreatedAt' => , 'Policy' => '', 'Principal' => '', 'SourceAccount' => '', ], // ... ], ]

Result Details

Members

NextToken

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

Permissions

Type: Array of Permission structures

Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request has failed for an unspecified reason.

InvalidNextTokenException:

The state of the private CA does not allow this action to occur.

The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.

result=result = result=client->listTags([/* ... /]); promise=promise = promise=client->listTagsAsync([/ ... */]);

Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.

Parameter Syntax

result=result = result=client->listTags([ 'CertificateAuthorityArn' => '', // REQUIRED 'MaxResults' => , 'NextToken' => '', ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_

MaxResults

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

NextToken

Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

Result Syntax

[ 'NextToken' => '', 'Tags' => [ [ 'Key' => '', 'Value' => '', ], // ... ], ]

Result Details

Members

NextToken

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

Tags

Type: Array of Tag structures

The tags associated with your private CA.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request has failed for an unspecified reason.

LockoutPreventedException:

The state of the private CA does not allow this action to occur.

PutPolicy

result=result = result=client->putPolicy([/* ... /]); promise=promise = promise=client->putPolicyAsync([/ ... */]);

Attaches a resource-based policy to a private CA.

A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.

The policy can be displayed with GetPolicy and removed with DeletePolicy.

About Policies

A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.
A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

Parameter Syntax

result=result = result=client->putPolicy([ 'Policy' => '', // REQUIRED 'ResourceArn' => '', // REQUIRED ]);

Parameter Details

Members

Policy

Required: Yes

Type: string

The path and file name of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.

ResourceArn

Required: Yes

Type: string

The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request has failed for an unspecified reason.

The state of the private CA does not allow this action to occur.

InvalidPolicyException:

A previous update to your private CA is still ongoing.

The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see Overview of JSON Policies.

RestoreCertificateAuthority

result=result = result=client->restoreCertificateAuthority([/* ... /]); promise=promise = promise=client->restoreCertificateAuthorityAsync([/ ... */]);

Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.

Parameter Syntax

result=result = result=client->restoreCertificateAuthority([ 'CertificateAuthorityArn' => '', // REQUIRED ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

RequestAlreadyProcessedException:

The state of the private CA does not allow this action to occur.

RevokeCertificate

result=result = result=client->revokeCertificate([/* ... /]); promise=promise = promise=client->revokeCertificateAsync([/ ... */]);

Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

You cannot revoke a root CA self-signed certificate.

Parameter Syntax

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_

CertificateSerial

Required: Yes

Type: string

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.

openssl x509 -in _filepath_ -text -noout

You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API Reference.

RevocationReason

Required: Yes

Type: string

Specifies why you revoked the certificate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Your request has already been completed.

An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

InvalidRequestException:

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The request action cannot be performed or is prohibited.

The request has failed for an unspecified reason.

The state of the private CA does not allow this action to occur.

A previous update to your private CA is still ongoing.

Your request is already in progress.

TagCertificateAuthority

result=result = result=client->tagCertificateAuthority([/* ... /]); promise=promise = promise=client->tagCertificateAuthorityAsync([/ ... */]);

Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.

To attach tags to a private CA during the creation procedure, a CA administrator must first associate an inline IAM policy with the CreateCertificateAuthority action and explicitly allow tagging. For more information, see Attaching tags to a CA at the time of creation.

Parameter Syntax

result=result = result=client->tagCertificateAuthority([ 'CertificateAuthorityArn' => '', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '', // REQUIRED 'Value' => '', ], // ... ], ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_

Tags

Required: Yes

Type: Array of Tag structures

List of tags to be associated with the CA.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

TooManyTagsException:

The state of the private CA does not allow this action to occur.

InvalidTagException:

The tag associated with the CA is not valid. The invalid argument is contained in the message field.

You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.

UntagCertificateAuthority

result=result = result=client->untagCertificateAuthority([/* ... /]); promise=promise = promise=client->untagCertificateAuthorityAsync([/ ... */]);

Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA.

Parameter Syntax

result=result = result=client->untagCertificateAuthority([ 'CertificateAuthorityArn' => '', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '', // REQUIRED 'Value' => '', ], // ... ], ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_

Tags

Required: Yes

Type: Array of Tag structures

List of tags to be removed from the CA.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

The state of the private CA does not allow this action to occur.

InvalidTagException:

The tag associated with the CA is not valid. The invalid argument is contained in the message field.

UpdateCertificateAuthority

result=result = result=client->updateCertificateAuthority([/* ... /]); promise=promise = promise=client->updateCertificateAuthorityAsync([/ ... */]);

Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.

Parameter Syntax

result=result = result=client->updateCertificateAuthority([ 'CertificateAuthorityArn' => '', // REQUIRED 'RevocationConfiguration' => [ 'CrlConfiguration' => [ 'CrlDistributionPointExtensionConfiguration' => [ 'OmitExtension' => true || false, // REQUIRED ], 'CrlType' => 'COMPLETE|PARTITIONED', 'CustomCname' => '', 'CustomPath' => '', 'Enabled' => true || false, // REQUIRED 'ExpirationInDays' => , 'S3BucketName' => '', 'S3ObjectAcl' => 'PUBLIC_READ|BUCKET_OWNER_FULL_CONTROL', ], 'OcspConfiguration' => [ 'Enabled' => true || false, // REQUIRED 'OcspCustomCname' => '', ], ], 'Status' => 'CREATING|PENDING_CERTIFICATE|ACTIVE|DELETED|DISABLED|EXPIRED|FAILED', ]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes

Type: string

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:_region_:_account_:certificate-authority/_12345678-1234-1234-1234-123456789012_

RevocationConfiguration

Type: RevocationConfiguration structure

Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. If you don't supply this parameter, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.

The following requirements apply to revocation configurations.

A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

If you update the S3BucketName of CrlConfiguration, you can break revocation for existing certificates. In other words, if you call UpdateCertificateAuthority to update the CRL configuration's S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you'll need to reissue old certificates to keep the revocation working. Alternatively, you can use a CustomCname in your CRL configuration if you might need to change the S3 bucket name in the future.

Status

Status of your private CA.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

One or more of the specified arguments was not valid.

The state of the private CA does not allow this action to occur.