AWS SDK for PHP 3.x

Service ID: acm-pca

Version: 2017-08-22

This page describes the parameters and results for the operations of the AWS Certificate Manager Private Certificate Authority (2017-08-22), and shows how to use the Aws\ACMPCA\ACMPCAClient object to call the described operations. This documentation is specific to the 2017-08-22 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateCertificateAuthority ( array $params = [] )
Creates a private subordinate certificate authority (CA).
CreateCertificateAuthorityAuditReport ( array $params = [] )
Creates an audit report that lists every time that your CA private key is used.
CreatePermission ( array $params = [] )
Assigns permissions from a private CA to a designated AWS service.
DeleteCertificateAuthority ( array $params = [] )
Deletes a private certificate authority (CA).
DeletePermission ( array $params = [] )
Revokes permissions that a private CA assigned to a designated AWS service.
DescribeCertificateAuthority ( array $params = [] )
Lists information about your private certificate authority (CA).
DescribeCertificateAuthorityAuditReport ( array $params = [] )
Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport operation.
GetCertificate ( array $params = [] )
Retrieves a certificate from your private CA.
GetCertificateAuthorityCertificate ( array $params = [] )
Retrieves the certificate and certificate chain for your private certificate authority (CA).
GetCertificateAuthorityCsr ( array $params = [] )
Retrieves the certificate signing request (CSR) for your private certificate authority (CA).
ImportCertificateAuthorityCertificate ( array $params = [] )
Imports your signed private CA certificate into ACM PCA.
IssueCertificate ( array $params = [] )
Uses your private certificate authority (CA) to issue a client certificate.
ListCertificateAuthorities ( array $params = [] )
Lists the private certificate authorities that you created by using the CreateCertificateAuthority operation.
ListPermissions ( array $params = [] )
Lists all the permissions, if any, that have been assigned by a private CA.
ListTags ( array $params = [] )
Lists the tags, if any, that are associated with your private CA.
RestoreCertificateAuthority ( array $params = [] )
Restores a certificate authority (CA) that is in the DELETED state.
RevokeCertificate ( array $params = [] )
Revokes a certificate that you issued by calling the IssueCertificate operation.
TagCertificateAuthority ( array $params = [] )
Adds one or more tags to your private CA.
UntagCertificateAuthority ( array $params = [] )
Remove one or more tags from your private CA.
UpdateCertificateAuthority ( array $params = [] )
Updates the status or configuration of a private certificate authority (CA).

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListCertificateAuthorities
ListPermissions
ListTags

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
CertificateAuthorityCSRCreated	GetCertificateAuthorityCsr	3	60
CertificateIssued	GetCertificate	3	60
AuditReportCreated	DescribeCertificateAuthorityAuditReport	3	60

Operations

CreateCertificateAuthority

$result = $client->createCertificateAuthority([/* ... */]);
$promise = $client->createCertificateAuthorityAsync([/* ... */]);

Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses to sign, and X.500 subject information. The CRL (certificate revocation list) configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this operation returns the Amazon Resource Name (ARN) of the CA.

Parameter Syntax

$result = $client->createCertificateAuthority([
    'CertificateAuthorityConfiguration' => [ // REQUIRED
        'KeyAlgorithm' => 'RSA_2048|RSA_4096|EC_prime256v1|EC_secp384r1', // REQUIRED
        'SigningAlgorithm' => 'SHA256WITHECDSA|SHA384WITHECDSA|SHA512WITHECDSA|SHA256WITHRSA|SHA384WITHRSA|SHA512WITHRSA', // REQUIRED
        'Subject' => [ // REQUIRED
            'CommonName' => '<string>',
            'Country' => '<string>',
            'DistinguishedNameQualifier' => '<string>',
            'GenerationQualifier' => '<string>',
            'GivenName' => '<string>',
            'Initials' => '<string>',
            'Locality' => '<string>',
            'Organization' => '<string>',
            'OrganizationalUnit' => '<string>',
            'Pseudonym' => '<string>',
            'SerialNumber' => '<string>',
            'State' => '<string>',
            'Surname' => '<string>',
            'Title' => '<string>',
        ],
    ],
    'CertificateAuthorityType' => 'SUBORDINATE', // REQUIRED
    'IdempotencyToken' => '<string>',
    'RevocationConfiguration' => [
        'CrlConfiguration' => [
            'CustomCname' => '<string>',
            'Enabled' => true || false, // REQUIRED
            'ExpirationInDays' => <integer>,
            'S3BucketName' => '<string>',
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

CertificateAuthorityConfiguration

Required: Yes
Type: CertificateAuthorityConfiguration structure

Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.

CertificateAuthorityType

Required: Yes
Type: string

The type of the certificate authority. Currently, this must be SUBORDINATE.

IdempotencyToken

Type: string

Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within a five minute period, ACM PCA recognizes that you are requesting only one certificate. As a result, ACM PCA issues only one. If you change the idempotency token for each call, however, ACM PCA recognizes that you are requesting multiple certificates.

RevocationConfiguration

Type: RevocationConfiguration structure

Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM PCA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.

Tags

Type: Array of Tag structures

Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA.

Result Syntax

[
    'CertificateAuthorityArn' => '<string>',
]

Result Details

Members

CertificateAuthorityArn

Type: string

If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

Errors

InvalidArgsException:
One or more of the specified arguments was not valid.
InvalidPolicyException:
The S3 bucket policy is not valid. The policy must give ACM PCA rights to read from and write to the bucket and find the bucket location.
InvalidTagException:
The tag associated with the CA is not valid. The invalid argument is contained in the message field.
LimitExceededException:
An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.

CreateCertificateAuthorityAuditReport

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

Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate operations use the private key. You can generate a new report every 30 minutes.

Parameter Syntax

$result = $client->createCertificateAuthorityAuditReport([
    'AuditReportResponseFormat' => 'JSON|CSV', // REQUIRED
    'CertificateAuthorityArn' => '<string>', // REQUIRED
    'S3BucketName' => '<string>', // 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' => '<string>',
    'S3Key' => '<string>',
]

Result Details

Members

AuditReportId

Type: string

An alphanumeric string that contains a report identifier.

S3Key

Type: string

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

Errors

RequestInProgressException:
Your request is already in progress.
RequestFailedException:
The request has failed for an unspecified reason.
ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidArgsException:
One or more of the specified arguments was not valid.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.

CreatePermission

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

Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal.

At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked with the DeletePermission operation and listed with the ListPermissions operation.

Parameter Syntax

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

Parameter Details

Members

Actions

Required: Yes
Type: Array of strings

The actions that the specified AWS 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 operation. 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 AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

SourceAccount

Type: string

The ID of the calling account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
PermissionAlreadyExistsException:
The designated permission has already been given to the user.
LimitExceededException:
An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
RequestFailedException:
The request has failed for an unspecified reason.

DeleteCertificateAuthority

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

Deletes a private certificate authority (CA). You must provide the ARN (Amazon Resource Name) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities operation. Before you can delete a CA, you must disable it. Call the UpdateCertificateAuthority operation and set the CertificateAuthorityStatus parameter to DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (the Status field of the CertificateAuthority is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE) into ACM PCA.

If the CA is in one of the previously mentioned states and you 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 operation returns the time remaining in the restoration window of a Private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority operation.

Parameter Syntax

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

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

Type: int

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

ConcurrentModificationException:
A previous update to your private CA is still ongoing.
ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.

DeletePermission

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

Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the CreatePermission operation and listed with the ListPermissions operation.

Parameter Syntax

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

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 operation. 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 AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

SourceAccount

Type: string

The AWS account that calls this operation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
RequestFailedException:
The request has failed for an unspecified reason.

DescribeCertificateAuthority

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

Lists information about your private certificate authority (CA). 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 - ACM PCA is creating your private certificate authority.
PENDING_CERTIFICATE - The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.
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 backend AWS 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 operation's output.

Parameter Syntax

$result = $client->describeCertificateAuthority([
    'CertificateAuthorityArn' => '<string>', // 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' => '<string>',
        'CertificateAuthorityConfiguration' => [
            'KeyAlgorithm' => 'RSA_2048|RSA_4096|EC_prime256v1|EC_secp384r1',
            'SigningAlgorithm' => 'SHA256WITHECDSA|SHA384WITHECDSA|SHA512WITHECDSA|SHA256WITHRSA|SHA384WITHRSA|SHA512WITHRSA',
            'Subject' => [
                'CommonName' => '<string>',
                'Country' => '<string>',
                'DistinguishedNameQualifier' => '<string>',
                'GenerationQualifier' => '<string>',
                'GivenName' => '<string>',
                'Initials' => '<string>',
                'Locality' => '<string>',
                'Organization' => '<string>',
                'OrganizationalUnit' => '<string>',
                'Pseudonym' => '<string>',
                'SerialNumber' => '<string>',
                'State' => '<string>',
                'Surname' => '<string>',
                'Title' => '<string>',
            ],
        ],
        'CreatedAt' => <DateTime>,
        'FailureReason' => 'REQUEST_TIMED_OUT|UNSUPPORTED_ALGORITHM|OTHER',
        'LastStateChangeAt' => <DateTime>,
        'NotAfter' => <DateTime>,
        'NotBefore' => <DateTime>,
        'RestorableUntil' => <DateTime>,
        'RevocationConfiguration' => [
            'CrlConfiguration' => [
                'CustomCname' => '<string>',
                'Enabled' => true || false,
                'ExpirationInDays' => <integer>,
                'S3BucketName' => '<string>',
            ],
        ],
        'Serial' => '<string>',
        'Status' => 'CREATING|PENDING_CERTIFICATE|ACTIVE|DELETED|DISABLED|EXPIRED|FAILED',
        'Type' => 'SUBORDINATE',
    ],
]

Result Details

Members

CertificateAuthority

Type: CertificateAuthority structure

A CertificateAuthority structure that contains information about your private CA.

Errors

ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.

DescribeCertificateAuthorityAuditReport

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

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

Parameter Syntax

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

Parameter Details

Members

AuditReportId

Required: Yes
Type: string

The report ID returned by calling the CreateCertificateAuthorityAuditReport operation.

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' => <DateTime>,
    'S3BucketName' => '<string>',
    'S3Key' => '<string>',
]

Result Details

Members

AuditReportStatus

Type: string

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

Type: string

Name of the S3 bucket that contains the report.

S3Key

Type: string

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

Errors

ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidArgsException:
One or more of the specified arguments was not valid.

GetCertificate

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

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

Parameter Syntax

$result = $client->getCertificate([
    'CertificateArn' => '<string>', // REQUIRED
    'CertificateAuthorityArn' => '<string>', // 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' => '<string>',
    'CertificateChain' => '<string>',
]

Result Details

Members

Certificate

Type: string

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

CertificateChain

Type: string

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

Errors

RequestInProgressException:
Your request is already in progress.
RequestFailedException:
The request has failed for an unspecified reason.
ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.

GetCertificateAuthorityCertificate

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

Retrieves the certificate and certificate chain for your private certificate authority (CA). 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 = $client->getCertificateAuthorityCertificate([
    'CertificateAuthorityArn' => '<string>', // 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' => '<string>',
    'CertificateChain' => '<string>',
]

Result Details

Members

Certificate

Type: string

Base64-encoded certificate authority (CA) certificate.

CertificateChain

Type: string

Base64-encoded certificate chain that includes any intermediate certificates and chains up to root on-premises certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate.

Errors

ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.

GetCertificateAuthorityCsr

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

Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority operation. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the ImportCertificateAuthorityCertificate operation. The CSR is returned as a base64 PEM-encoded string.

Parameter Syntax

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

Parameter Details

Members

CertificateAuthorityArn

Required: Yes
Type: string

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

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Result Syntax

[
    'Csr' => '<string>',
]

Result Details

Members

Csr

Type: string

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

Errors

RequestInProgressException:
Your request is already in progress.
RequestFailedException:
The request has failed for an unspecified reason.
ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.

ImportCertificateAuthorityCertificate

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

Imports your signed private CA certificate into ACM PCA. Before you can call this operation, you must create the private certificate authority by calling the CreateCertificateAuthority operation. You must then generate a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr operation. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

Your certificate chain must not include the private CA certificate that you are importing.

Your on-premises CA certificate 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.

Parameter Syntax

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

Parameter Details

Members

Certificate

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

The PEM-encoded certificate for your private CA. This must be signed by using your on-premises CA.

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

Required: Yes
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 on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConcurrentModificationException:
A previous update to your private CA is still ongoing.
RequestInProgressException:
Your request is already in progress.
RequestFailedException:
The request has failed for an unspecified reason.
ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
MalformedCertificateException:
One or more fields in the certificate are invalid.
CertificateMismatchException:
The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.

IssueCertificate

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

Uses your private certificate authority (CA) to issue a client certificate. This operation returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate operation and specifying the ARN.

You cannot use the ACM ListCertificateAuthorities operation to retrieve the ARNs of the certificates that you issue by using ACM PCA.

Parameter Syntax

$result = $client->issueCertificate([
    'CertificateAuthorityArn' => '<string>', // REQUIRED
    'Csr' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'IdempotencyToken' => '<string>',
    'SigningAlgorithm' => 'SHA256WITHECDSA|SHA384WITHECDSA|SHA512WITHECDSA|SHA256WITHRSA|SHA384WITHRSA|SHA512WITHRSA', // REQUIRED
    'Validity' => [ // REQUIRED
        'Type' => 'END_DATE|ABSOLUTE|DAYS|MONTHS|YEARS', // REQUIRED
        'Value' => <integer>, // 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

Csr

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

The certificate signing request (CSR) for the certificate you want to issue. 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 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

IdempotencyToken

Type: string

Custom string that can be used to distinguish between calls to the IssueCertificate operation. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA 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.

Validity

Required: Yes
Type: Validity structure

The type of the validity period.

Result Syntax

[
    'CertificateArn' => '<string>',
]

Result Details

Members

CertificateArn

Type: string

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

LimitExceededException:
An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.
ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidArgsException:
One or more of the specified arguments was not valid.
MalformedCSRException:
The certificate signing request is invalid.

ListCertificateAuthorities

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

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

Parameter Syntax

$result = $client->listCertificateAuthorities([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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.

NextToken

Type: string

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.

Result Syntax

[
    'CertificateAuthorities' => [
        [
            'Arn' => '<string>',
            'CertificateAuthorityConfiguration' => [
                'KeyAlgorithm' => 'RSA_2048|RSA_4096|EC_prime256v1|EC_secp384r1',
                'SigningAlgorithm' => 'SHA256WITHECDSA|SHA384WITHECDSA|SHA512WITHECDSA|SHA256WITHRSA|SHA384WITHRSA|SHA512WITHRSA',
                'Subject' => [
                    'CommonName' => '<string>',
                    'Country' => '<string>',
                    'DistinguishedNameQualifier' => '<string>',
                    'GenerationQualifier' => '<string>',
                    'GivenName' => '<string>',
                    'Initials' => '<string>',
                    'Locality' => '<string>',
                    'Organization' => '<string>',
                    'OrganizationalUnit' => '<string>',
                    'Pseudonym' => '<string>',
                    'SerialNumber' => '<string>',
                    'State' => '<string>',
                    'Surname' => '<string>',
                    'Title' => '<string>',
                ],
            ],
            'CreatedAt' => <DateTime>,
            'FailureReason' => 'REQUEST_TIMED_OUT|UNSUPPORTED_ALGORITHM|OTHER',
            'LastStateChangeAt' => <DateTime>,
            'NotAfter' => <DateTime>,
            'NotBefore' => <DateTime>,
            'RestorableUntil' => <DateTime>,
            'RevocationConfiguration' => [
                'CrlConfiguration' => [
                    'CustomCname' => '<string>',
                    'Enabled' => true || false,
                    'ExpirationInDays' => <integer>,
                    'S3BucketName' => '<string>',
                ],
            ],
            'Serial' => '<string>',
            'Status' => 'CREATING|PENDING_CERTIFICATE|ACTIVE|DELETED|DISABLED|EXPIRED|FAILED',
            'Type' => 'SUBORDINATE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

CertificateAuthorities

Type: Array of CertificateAuthority structures

Summary information about each certificate authority you have created.

NextToken

Type: string

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 = $client->listPermissions([/* ... */]);
$promise = $client->listPermissionsAsync([/* ... */]);

Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the CreatePermission operation and revoked with the DeletePermission operation.

Parameter Syntax

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

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 operation. 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 operation.

MaxResults

Type: int

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

Type: string

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' => '<string>',
    'Permissions' => [
        [
            'Actions' => ['<string>', ...],
            'CertificateAuthorityArn' => '<string>',
            'CreatedAt' => <DateTime>,
            'Policy' => '<string>',
            'Principal' => '<string>',
            'SourceAccount' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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

ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidNextTokenException:
The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
RequestFailedException:
The request has failed for an unspecified reason.

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

Lists the tags, if any, that are associated with your private CA. 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 operation to add one or more tags to your CA. Call the UntagCertificateAuthority operation to remove tags.

Parameter Syntax

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

Parameter Details

Members

CertificateAuthorityArn

Required: Yes
Type: string

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

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

MaxResults

Type: int

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

Type: string

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' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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

ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.

RestoreCertificateAuthority

$result = $client->restoreCertificateAuthority([/* ... */]);
$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 operation. 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 operations. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority operation returns. To change its status to ACTIVE, call the UpdateCertificateAuthority operation. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate operation 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 = $client->restoreCertificateAuthority([
    'CertificateAuthorityArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

CertificateAuthorityArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. 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

ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.

RevokeCertificate

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

Revokes a certificate that you issued by calling the IssueCertificate operation. 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. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM PCA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

Parameter Syntax

$result = $client->revokeCertificate([
    'CertificateAuthorityArn' => '<string>', // REQUIRED
    'CertificateSerial' => '<string>', // REQUIRED
    'RevocationReason' => 'UNSPECIFIED|KEY_COMPROMISE|CERTIFICATE_AUTHORITY_COMPROMISE|AFFILIATION_CHANGED|SUPERSEDED|CESSATION_OF_OPERATION|PRIVILEGE_WITHDRAWN|A_A_COMPROMISE', // REQUIRED
]);

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 operation 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 file_path -text -noout

You can also copy the serial number from the console or use the DescribeCertificate operation in the AWS 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

ConcurrentModificationException:
A previous update to your private CA is still ongoing.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
LimitExceededException:
An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.
ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
RequestAlreadyProcessedException:
Your request has already been completed.
RequestInProgressException:
Your request is already in progress.
RequestFailedException:
The request has failed for an unspecified reason.

TagCertificateAuthority

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

Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS 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 operation. Call the ListTags operation to see what tags are associated with your CA.

Parameter Syntax

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

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

ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
InvalidTagException:
The tag associated with the CA is not valid. The invalid argument is contained in the message field.
TooManyTagsException:
You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.

UntagCertificateAuthority

$result = $client->untagCertificateAuthority([/* ... */]);
$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 operation, 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 operation to see what tags are associated with your CA.

Parameter Syntax

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

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

ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
InvalidTagException:
The tag associated with the CA is not valid. The invalid argument is contained in the message field.

UpdateCertificateAuthority

$result = $client->updateCertificateAuthority([/* ... */]);
$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 = $client->updateCertificateAuthority([
    'CertificateAuthorityArn' => '<string>', // REQUIRED
    'RevocationConfiguration' => [
        'CrlConfiguration' => [
            'CustomCname' => '<string>',
            'Enabled' => true || false, // REQUIRED
            'ExpirationInDays' => <integer>,
            'S3BucketName' => '<string>',
        ],
    ],
    '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

Revocation information for your private CA.

Status

Type: string

Status of your private CA.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConcurrentModificationException:
A previous update to your private CA is still ongoing.
ResourceNotFoundException:
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
InvalidArgsException:
One or more of the specified arguments was not valid.
InvalidArnException:
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidStateException:
The private CA is in a state during which a report or certificate cannot be generated.
InvalidPolicyException:
The S3 bucket policy is not valid. The policy must give ACM PCA rights to read from and write to the bucket and find the bucket location.

Shapes

ASN1Subject

Description

Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.

Members

CommonName

Type: string

Fully qualified domain name (FQDN) associated with the certificate subject.

Country

Type: string

Two-digit code that specifies the country in which the certificate subject located.

DistinguishedNameQualifier

Type: string

Disambiguating information for the certificate subject.

GenerationQualifier

Type: string

Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

GivenName

Type: string

First name.

Initials

Type: string

Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the SurName.

Locality

Type: string

The locality (such as a city or town) in which the certificate subject is located.

Organization

Type: string

Legal name of the organization with which the certificate subject is affiliated.

OrganizationalUnit

Type: string

A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

Pseudonym

Type: string

Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

SerialNumber

Type: string

The certificate serial number.

State

Type: string

State in which the subject of the certificate is located.

Surname

Type: string

Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

Title

Type: string

A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

CertificateAuthority

Description

Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority operation to create your private CA. You must then call the GetCertificateAuthorityCertificate operation to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the ImportCertificateAuthorityCertificate operation to import the signed certificate into AWS Certificate Manager (ACM).

Members

Arn

Type: string

Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .

CertificateAuthorityConfiguration

Type: CertificateAuthorityConfiguration structure

Your private CA configuration.

CreatedAt

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

Date and time at which your private CA was created.

FailureReason

Type: string

Reason the request to create your private CA failed.

LastStateChangeAt

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

Date and time at which your private CA was last updated.

NotAfter

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

Date and time after which your private CA certificate is not valid.

NotBefore

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

Date and time before which your private CA certificate is not valid.

RestorableUntil

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

The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest operation.

RevocationConfiguration

Type: RevocationConfiguration structure

Information about the certificate revocation list (CRL) created and maintained by your private CA.

Serial

Type: string

Serial number of your private CA.

Status

Type: string

Status of your private CA.

Type

Type: string

Type of your private CA.

CertificateAuthorityConfiguration

Description

Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority operation.

Members

KeyAlgorithm

Required: Yes
Type: string

Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate.

SigningAlgorithm

Required: Yes
Type: string

Name of the algorithm your private CA uses to sign certificate requests.

Subject

Required: Yes
Type: ASN1Subject structure

Structure that contains X.500 distinguished name information for your private CA.

CertificateMismatchException

Description

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

Members

message

Type: string

ConcurrentModificationException

Description

A previous update to your private CA is still ongoing.

Members

message

Type: string

CrlConfiguration

Description

Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM PCA.

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included.

CRLs contain the following fields:

Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.
Signature Algorithm: The name of the algorithm used to sign the CRL.
Issuer: The X.500 distinguished name of your private CA that issued the CRL.
Last Update: The issue date and time of this CRL.
Next Update: The day and time by which the next CRL will be issued.
Revoked Certificates: List of revoked certificates. Each list item contains the following information.
- Serial Number: The serial number, in hexadecimal format, of the revoked certificate.
- Revocation Date: Date and time the certificate was revoked.
- CRL Entry Extensions: Optional extensions for the CRL entry.
  - X509v3 CRL Reason Code: Reason the certificate was revoked.
CRL Extensions: Optional extensions for the CRL.
- X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.
- X509v3 CRL Number:: Decimal sequence number for the CRL.
Signature Algorithm: Algorithm used by your private CA to sign the CRL.
Signature Value: Signature computed over the CRL.

Certificate revocation lists created by ACM PCA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in crl_path -noout

Members

CustomCname

Type: string

Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.

Enabled

Required: Yes
Type: boolean

Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority operation or for an existing CA when you call the UpdateCertificateAuthority operation.

ExpirationInDays

Type: int

Number of days until a certificate expires.

S3BucketName

Type: string

Type: Array of strings

The private CA operations that can be performed by the designated AWS service.

CertificateAuthorityArn

Type: string

The Amazon Resource Number (ARN) of the private CA from which the permission was issued.

CreatedAt

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

The time at which the permission was created.

Policy

Type: string

The name of the policy that is associated with the permission.

Principal

Type: string

The AWS service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com.

SourceAccount

Type: string

Type: CrlConfiguration structure

Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.

Tag

Description

Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority operation. To remove a tag, call the UntagCertificateAuthority operation.

Members

Key

Required: Yes
Type: string

Key (name) of the tag.

Value

Type: string

Value of the tag.

TooManyTagsException

Description

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

Members

message

Type: string

Validity

Description

Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the IssueCertificate operation.

Members

Type

Required: Yes
Type: string

Specifies whether the Value parameter represents days, months, or years.

Value

Required: Yes
Type: long (int|float)

Time period.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Certificate Manager Private Certificate Authority 2017-08-22

Operation Summary

Paginators

Waiters

Operations

CreateCertificateAuthority

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCertificateAuthorityAuditReport

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreatePermission

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteCertificateAuthority

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeletePermission

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeCertificateAuthority

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeCertificateAuthorityAuditReport

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetCertificate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetCertificateAuthorityCertificate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors