SDK for PHP 3.x

Client: Aws\Acm\AcmClient
Service ID: acm
Version: 2015-12-08

This page describes the parameters and results for the operations of the AWS Certificate Manager (2015-12-08), and shows how to use the Aws\Acm\AcmClient object to call the described operations. This documentation is specific to the 2015-12-08 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 */).

AddTagsToCertificate ( array $params = [] )
Adds one or more tags to an ACM certificate.
DeleteCertificate ( array $params = [] )
Deletes a certificate and its associated private key.
DescribeCertificate ( array $params = [] )
Returns detailed metadata about the specified ACM certificate.
ExportCertificate ( array $params = [] )
Exports a private certificate issued by a private certificate authority (CA) for use anywhere.
GetAccountConfiguration ( array $params = [] )
Returns the account configuration options associated with an Amazon Web Services account.
GetCertificate ( array $params = [] )
Retrieves a certificate and its certificate chain.
ImportCertificate ( array $params = [] )
Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.
ListCertificates ( array $params = [] )
Retrieves a list of certificate ARNs and domain names.
ListTagsForCertificate ( array $params = [] )
Lists the tags that have been applied to the ACM certificate.
PutAccountConfiguration ( array $params = [] )
Adds or modifies account-level configurations in ACM.
RemoveTagsFromCertificate ( array $params = [] )
Remove one or more tags from an ACM certificate.
RenewCertificate ( array $params = [] )
Renews an eligible ACM certificate.
RequestCertificate ( array $params = [] )
Requests an ACM certificate for use with other Amazon Web Services services.
ResendValidationEmail ( array $params = [] )
Resends the email that requests domain ownership validation.
UpdateCertificateOptions ( array $params = [] )
Updates a certificate.

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:

ListCertificates

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
CertificateValidated DescribeCertificate 60 40

Operations

AddTagsToCertificate

$result = $client->addTagsToCertificate([/* ... */]);
$promise = $client->addTagsToCertificateAsync([/* ... */]);

Adds one or more tags to an ACM certificate. 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 certificate 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 certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

Parameter Syntax

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

Parameter Details

Members
CertificateArn
Required: Yes
Type: string

String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

Tags
Required: Yes
Type: Array of Tag structures

The key-value pair that defines the tag. The tag value is optional.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

InvalidArnException:

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

InvalidTagException:

One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

TooManyTagsException:

The request contains too many tags. Try the request again with fewer tags.

TagPolicyException:

A specified tag did not comply with an existing tag policy and was rejected.

InvalidParameterException:

An input parameter was invalid.

ThrottlingException:

The request was denied because it exceeded a quota.

DeleteCertificate

$result = $client->deleteCertificate([/* ... */]);
$promise = $client->deleteCertificateAsync([/* ... */]);

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by Amazon Web Services services integrated with ACM.

You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed.

Parameter Syntax

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

Parameter Details

Members
CertificateArn
Required: Yes
Type: string

String that contains the ARN of the ACM certificate to be deleted. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

ResourceInUseException:

The certificate is in use by another Amazon Web Services service in the caller's account. Remove the association and try again.

AccessDeniedException:

You do not have access required to perform this action.

ThrottlingException:

The request was denied because it exceeded a quota.

ConflictException:

You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.

InvalidArnException:

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

DescribeCertificate

$result = $client->describeCertificate([/* ... */]);
$promise = $client->describeCertificateAsync([/* ... */]);

Returns detailed metadata about the specified ACM certificate.

If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it.

Parameter Syntax

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

Parameter Details

Members
CertificateArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

Result Syntax

[
    'Certificate' => [
        'CertificateArn' => '<string>',
        'CertificateAuthorityArn' => '<string>',
        'CreatedAt' => <DateTime>,
        'DomainName' => '<string>',
        'DomainValidationOptions' => [
            [
                'DomainName' => '<string>',
                'ResourceRecord' => [
                    'Name' => '<string>',
                    'Type' => 'CNAME',
                    'Value' => '<string>',
                ],
                'ValidationDomain' => '<string>',
                'ValidationEmails' => ['<string>', ...],
                'ValidationMethod' => 'EMAIL|DNS',
                'ValidationStatus' => 'PENDING_VALIDATION|SUCCESS|FAILED',
            ],
            // ...
        ],
        'ExtendedKeyUsages' => [
            [
                'Name' => 'TLS_WEB_SERVER_AUTHENTICATION|TLS_WEB_CLIENT_AUTHENTICATION|CODE_SIGNING|EMAIL_PROTECTION|TIME_STAMPING|OCSP_SIGNING|IPSEC_END_SYSTEM|IPSEC_TUNNEL|IPSEC_USER|ANY|NONE|CUSTOM',
                'OID' => '<string>',
            ],
            // ...
        ],
        'FailureReason' => 'NO_AVAILABLE_CONTACTS|ADDITIONAL_VERIFICATION_REQUIRED|DOMAIN_NOT_ALLOWED|INVALID_PUBLIC_DOMAIN|DOMAIN_VALIDATION_DENIED|CAA_ERROR|PCA_LIMIT_EXCEEDED|PCA_INVALID_ARN|PCA_INVALID_STATE|PCA_REQUEST_FAILED|PCA_NAME_CONSTRAINTS_VALIDATION|PCA_RESOURCE_NOT_FOUND|PCA_INVALID_ARGS|PCA_INVALID_DURATION|PCA_ACCESS_DENIED|SLR_NOT_FOUND|OTHER',
        'ImportedAt' => <DateTime>,
        'InUseBy' => ['<string>', ...],
        'IssuedAt' => <DateTime>,
        'Issuer' => '<string>',
        'KeyAlgorithm' => 'RSA_1024|RSA_2048|RSA_3072|RSA_4096|EC_prime256v1|EC_secp384r1|EC_secp521r1',
        'KeyUsages' => [
            [
                'Name' => 'DIGITAL_SIGNATURE|NON_REPUDIATION|KEY_ENCIPHERMENT|DATA_ENCIPHERMENT|KEY_AGREEMENT|CERTIFICATE_SIGNING|CRL_SIGNING|ENCIPHER_ONLY|DECIPHER_ONLY|ANY|CUSTOM',
            ],
            // ...
        ],
        'NotAfter' => <DateTime>,
        'NotBefore' => <DateTime>,
        'Options' => [
            'CertificateTransparencyLoggingPreference' => 'ENABLED|DISABLED',
        ],
        'RenewalEligibility' => 'ELIGIBLE|INELIGIBLE',
        'RenewalSummary' => [
            'DomainValidationOptions' => [
                [
                    'DomainName' => '<string>',
                    'ResourceRecord' => [
                        'Name' => '<string>',
                        'Type' => 'CNAME',
                        'Value' => '<string>',
                    ],
                    'ValidationDomain' => '<string>',
                    'ValidationEmails' => ['<string>', ...],
                    'ValidationMethod' => 'EMAIL|DNS',
                    'ValidationStatus' => 'PENDING_VALIDATION|SUCCESS|FAILED',
                ],
                // ...
            ],
            'RenewalStatus' => 'PENDING_AUTO_RENEWAL|PENDING_VALIDATION|SUCCESS|FAILED',
            'RenewalStatusReason' => 'NO_AVAILABLE_CONTACTS|ADDITIONAL_VERIFICATION_REQUIRED|DOMAIN_NOT_ALLOWED|INVALID_PUBLIC_DOMAIN|DOMAIN_VALIDATION_DENIED|CAA_ERROR|PCA_LIMIT_EXCEEDED|PCA_INVALID_ARN|PCA_INVALID_STATE|PCA_REQUEST_FAILED|PCA_NAME_CONSTRAINTS_VALIDATION|PCA_RESOURCE_NOT_FOUND|PCA_INVALID_ARGS|PCA_INVALID_DURATION|PCA_ACCESS_DENIED|SLR_NOT_FOUND|OTHER',
            'UpdatedAt' => <DateTime>,
        ],
        'RevocationReason' => 'UNSPECIFIED|KEY_COMPROMISE|CA_COMPROMISE|AFFILIATION_CHANGED|SUPERCEDED|CESSATION_OF_OPERATION|CERTIFICATE_HOLD|REMOVE_FROM_CRL|PRIVILEGE_WITHDRAWN|A_A_COMPROMISE',
        'RevokedAt' => <DateTime>,
        'Serial' => '<string>',
        'SignatureAlgorithm' => '<string>',
        'Status' => 'PENDING_VALIDATION|ISSUED|INACTIVE|EXPIRED|VALIDATION_TIMED_OUT|REVOKED|FAILED',
        'Subject' => '<string>',
        'SubjectAlternativeNames' => ['<string>', ...],
        'Type' => 'IMPORTED|AMAZON_ISSUED|PRIVATE',
    ],
]

Result Details

Members
Certificate
Type: CertificateDetail structure

Metadata about an ACM certificate.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

InvalidArnException:

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

ExportCertificate

$result = $client->exportCertificate([/* ... */]);
$promise = $client->exportCertificateAsync([/* ... */]);

Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it.

For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate.

Parameter Syntax

$result = $client->exportCertificate([
    'CertificateArn' => '<string>', // REQUIRED
    'Passphrase' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
]);

Parameter Details

Members
CertificateArn
Required: Yes
Type: string

An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:

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

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

Passphrase to associate with the encrypted exported private key.

When creating your passphrase, you can use any ASCII character except #, $, or %.

If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key. After entering the command, you are prompted for the passphrase.

openssl rsa -in encrypted_key.pem -out decrypted_key.pem

Result Syntax

[
    'Certificate' => '<string>',
    'CertificateChain' => '<string>',
    'PrivateKey' => '<string>',
]

Result Details

Members
Certificate
Type: string

The base64 PEM-encoded certificate.

CertificateChain
Type: string

The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.

PrivateKey
Type: string

The encrypted private key associated with the public key in the certificate. The key is output in PKCS #8 format and is base64 PEM-encoded.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

RequestInProgressException:

The certificate request is in process and the certificate in your account has not yet been issued.

InvalidArnException:

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

GetAccountConfiguration

$result = $client->getAccountConfiguration([/* ... */]);
$promise = $client->getAccountConfigurationAsync([/* ... */]);

Returns the account configuration options associated with an Amazon Web Services account.

Parameter Syntax

$result = $client->getAccountConfiguration([
]);

Parameter Details

Members

Result Syntax

[
    'ExpiryEvents' => [
        'DaysBeforeExpiry' => <integer>,
    ],
]

Result Details

Members
ExpiryEvents
Type: ExpiryEventsConfiguration structure

Expiration events configuration options associated with the Amazon Web Services account.

Errors

AccessDeniedException:

You do not have access required to perform this action.

ThrottlingException:

The request was denied because it exceeded a quota.

GetCertificate

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

Retrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM RequestCertificate action, or a certificate imported into ACM using the ImportCertificate action. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.

Parameter Syntax

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

Parameter Details

Members
CertificateArn
Required: Yes
Type: string

String that contains a certificate ARN in the following format:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

Result Syntax

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

Result Details

Members
Certificate
Type: string

The ACM-issued certificate corresponding to the ARN specified as input.

CertificateChain
Type: string

Certificates forming the requested certificate's chain of trust. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

RequestInProgressException:

The certificate request is in process and the certificate in your account has not yet been issued.

InvalidArnException:

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

ImportCertificate

$result = $client->importCertificate([/* ... */]);
$promise = $client->importCertificateAsync([/* ... */]);

Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide.

ACM does not provide managed renewal for certificates that you import.

Note the following guidelines when importing third party certificates:

  • You must enter the private key that matches the certificate you are importing.

  • The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.

  • The private key must be no larger than 5 KB (5,120 bytes).

  • The certificate, private key, and certificate chain must be PEM-encoded.

  • The current time must be between the Not Before and Not After certificate fields.

  • The Issuer field must not be empty.

  • The OCSP authority URL, if present, must not exceed 1000 characters.

  • To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate.

  • When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\temp folder as fileb://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.

  • When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.

  • The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.

This operation returns the Amazon Resource Name (ARN) of the imported certificate.

Parameter Syntax

$result = $client->importCertificate([
    'Certificate' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'CertificateArn' => '<string>',
    'CertificateChain' => <string || resource || Psr\Http\Message\StreamInterface>,
    'PrivateKey' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

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

The certificate to import.

CertificateArn
Type: string

The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.

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

The PEM encoded certificate chain.

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

The private key that matches the public key in the certificate.

Tags
Type: Array of Tag structures

One or more resource tags to associate with the imported certificate.

Note: You cannot apply tags when reimporting a certificate.

Result Syntax

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

Result Details

Members
CertificateArn
Type: string

The Amazon Resource Name (ARN) of the imported certificate.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

LimitExceededException:

An ACM quota has been exceeded.

InvalidTagException:

One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

TooManyTagsException:

The request contains too many tags. Try the request again with fewer tags.

TagPolicyException:

A specified tag did not comply with an existing tag policy and was rejected.

InvalidParameterException:

An input parameter was invalid.

InvalidArnException:

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

ListCertificates

$result = $client->listCertificates([/* ... */]);
$promise = $client->listCertificatesAsync([/* ... */]);

Retrieves a list of certificate ARNs and domain names. By default, the API returns RSA_2048 certificates. To return all certificates in the account, include the keyType filter with the values [RSA_1024, RSA_2048, RSA_3072, RSA_4096, EC_prime256v1, EC_secp384r1, EC_secp521r1].

In addition to keyType, you can also filter by the CertificateStatuses, keyUsage, and extendedKeyUsage attributes on the certificate. For more information, see Filters.

Parameter Syntax

$result = $client->listCertificates([
    'CertificateStatuses' => ['<string>', ...],
    'Includes' => [
        'extendedKeyUsage' => ['<string>', ...],
        'keyTypes' => ['<string>', ...],
        'keyUsage' => ['<string>', ...],
    ],
    'MaxItems' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => 'CREATED_AT',
    'SortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Members
CertificateStatuses
Type: Array of strings

Filter the certificate list by status value.

Includes
Type: Filters structure

Filter the certificate list. For more information, see the Filters structure.

MaxItems
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 only when paginating results and only 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.

SortBy
Type: string

Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

SortOrder
Type: string

Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

Result Syntax

[
    'CertificateSummaryList' => [
        [
            'CertificateArn' => '<string>',
            'CreatedAt' => <DateTime>,
            'DomainName' => '<string>',
            'Exported' => true || false,
            'ExtendedKeyUsages' => ['<string>', ...],
            'HasAdditionalSubjectAlternativeNames' => true || false,
            'ImportedAt' => <DateTime>,
            'InUse' => true || false,
            'IssuedAt' => <DateTime>,
            'KeyAlgorithm' => 'RSA_1024|RSA_2048|RSA_3072|RSA_4096|EC_prime256v1|EC_secp384r1|EC_secp521r1',
            'KeyUsages' => ['<string>', ...],
            'NotAfter' => <DateTime>,
            'NotBefore' => <DateTime>,
            'RenewalEligibility' => 'ELIGIBLE|INELIGIBLE',
            'RevokedAt' => <DateTime>,
            'Status' => 'PENDING_VALIDATION|ISSUED|INACTIVE|EXPIRED|VALIDATION_TIMED_OUT|REVOKED|FAILED',
            'SubjectAlternativeNameSummaries' => ['<string>', ...],
            'Type' => 'IMPORTED|AMAZON_ISSUED|PRIVATE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CertificateSummaryList
Type: Array of CertificateSummary structures

A list of ACM certificates.

NextToken
Type: string

When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

Errors

InvalidArgsException:

One or more of of request parameters specified is not valid.

ValidationException:

The supplied input failed to satisfy constraints of an Amazon Web Services service.

ListTagsForCertificate

$result = $client->listTagsForCertificate([/* ... */]);
$promise = $client->listTagsForCertificateAsync([/* ... */]);

Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

Parameter Syntax

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

Parameter Details

Members
CertificateArn
Required: Yes
Type: string

String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
Type: Array of Tag structures

The key-value pairs that define the applied tags.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

InvalidArnException:

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

PutAccountConfiguration

$result = $client->putAccountConfiguration([/* ... */]);
$promise = $client->putAccountConfigurationAsync([/* ... */]);

Adds or modifies account-level configurations in ACM.

The supported configuration option is DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.

Parameter Syntax

$result = $client->putAccountConfiguration([
    'ExpiryEvents' => [
        'DaysBeforeExpiry' => <integer>,
    ],
    'IdempotencyToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
ExpiryEvents
Type: ExpiryEventsConfiguration structure

Specifies expiration events associated with an account.

IdempotencyToken
Required: Yes
Type: string

Customer-chosen string used to distinguish between calls to PutAccountConfiguration. Idempotency tokens time out after one hour. If you call PutAccountConfiguration multiple times with the same unexpired idempotency token, ACM treats it as the same request and returns the original result. If you change the idempotency token for each call, ACM treats each call as a new request.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The supplied input failed to satisfy constraints of an Amazon Web Services service.

ThrottlingException:

The request was denied because it exceeded a quota.

AccessDeniedException:

You do not have access required to perform this action.

ConflictException:

You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.

RemoveTagsFromCertificate

$result = $client->removeTagsFromCertificate([/* ... */]);
$promise = $client->removeTagsFromCertificateAsync([/* ... */]);

Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, 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 certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.

Parameter Syntax

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

Parameter Details

Members
CertificateArn
Required: Yes
Type: string

String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

Tags
Required: Yes
Type: Array of Tag structures

The key-value pair that defines the tag to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

InvalidArnException:

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

InvalidTagException:

One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

TagPolicyException:

A specified tag did not comply with an existing tag policy and was rejected.

InvalidParameterException:

An input parameter was invalid.

ThrottlingException:

The request was denied because it exceeded a quota.

RenewCertificate

$result = $client->renewCertificate([/* ... */]);
$promise = $client->renewCertificateAsync([/* ... */]);

Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.

Parameter Syntax

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

Parameter Details

Members
CertificateArn
Required: Yes
Type: string

String that contains the ARN of the ACM certificate to be renewed. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

InvalidArnException:

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

RequestCertificate

$result = $client->requestCertificate([/* ... */]);
$promise = $client->requestCertificateAsync([/* ... */]);

Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.

ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN).

After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate.

Parameter Syntax

$result = $client->requestCertificate([
    'CertificateAuthorityArn' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'DomainValidationOptions' => [
        [
            'DomainName' => '<string>', // REQUIRED
            'ValidationDomain' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'IdempotencyToken' => '<string>',
    'KeyAlgorithm' => 'RSA_1024|RSA_2048|RSA_3072|RSA_4096|EC_prime256v1|EC_secp384r1|EC_secp521r1',
    'Options' => [
        'CertificateTransparencyLoggingPreference' => 'ENABLED|DISABLED',
    ],
    'SubjectAlternativeNames' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'ValidationMethod' => 'EMAIL|DNS',
]);

Parameter Details

Members
CertificateAuthorityArn
Type: string

The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority user guide. The ARN must have the following form:

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

DomainName
Required: Yes
Type: string

Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.

In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.

DomainValidationOptions
Type: Array of DomainValidationOption structures

The domain name that you want ACM to use to send you emails so that you can validate domain ownership.

IdempotencyToken
Type: string

Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.

KeyAlgorithm
Type: string

Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms.

Algorithms supported for an ACM certificate request include:

  • RSA_2048

  • EC_prime256v1

  • EC_secp384r1

Other listed algorithms are for imported certificates only.

When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

Default: RSA_2048

Options
Type: CertificateOptions structure

Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.

SubjectAlternativeNames
Type: Array of strings

Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:

  • (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.

  • (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.

  • (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.

Tags
Type: Array of Tag structures

One or more resource tags to associate with the certificate.

ValidationMethod
Type: string

The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.

Result Syntax

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

Result Details

Members
CertificateArn
Type: string

String that contains the ARN of the issued certificate. This must be of the form:

arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

Errors

LimitExceededException:

An ACM quota has been exceeded.

InvalidDomainValidationOptionsException:

One or more values in the DomainValidationOption structure is incorrect.

InvalidArnException:

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

InvalidTagException:

One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

TooManyTagsException:

The request contains too many tags. Try the request again with fewer tags.

TagPolicyException:

A specified tag did not comply with an existing tag policy and was rejected.

InvalidParameterException:

An input parameter was invalid.

ResendValidationEmail

$result = $client->resendValidationEmail([/* ... */]);
$promise = $client->resendValidationEmailAsync([/* ... */]);

Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.

Parameter Syntax

$result = $client->resendValidationEmail([
    'CertificateArn' => '<string>', // REQUIRED
    'Domain' => '<string>', // REQUIRED
    'ValidationDomain' => '<string>', // REQUIRED
]);

Parameter Details

Members
CertificateArn
Required: Yes
Type: string

String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the RequestCertificate action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form:

arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

Domain
Required: Yes
Type: string

The fully qualified domain name (FQDN) of the certificate that needs to be validated.

ValidationDomain
Required: Yes
Type: string

The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:

  • admin@subdomain.example.com

  • administrator@subdomain.example.com

  • hostmaster@subdomain.example.com

  • postmaster@subdomain.example.com

  • webmaster@subdomain.example.com

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

InvalidStateException:

Processing has reached an invalid state.

InvalidArnException:

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

InvalidDomainValidationOptionsException:

One or more values in the DomainValidationOption structure is incorrect.

UpdateCertificateOptions

$result = $client->updateCertificateOptions([/* ... */]);
$promise = $client->updateCertificateOptionsAsync([/* ... */]);

Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.

Parameter Syntax

$result = $client->updateCertificateOptions([
    'CertificateArn' => '<string>', // REQUIRED
    'Options' => [ // REQUIRED
        'CertificateTransparencyLoggingPreference' => 'ENABLED|DISABLED',
    ],
]);

Parameter Details

Members
CertificateArn
Required: Yes
Type: string

ARN of the requested certificate to update. This must be of the form:

arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012

Options
Required: Yes
Type: CertificateOptions structure

Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

LimitExceededException:

An ACM quota has been exceeded.

InvalidStateException:

Processing has reached an invalid state.

InvalidArnException:

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

Shapes

AccessDeniedException

Description

You do not have access required to perform this action.

Members
Message
Type: string

CertificateDetail

Description

Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.

Members
CertificateArn
Type: string

The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CertificateAuthorityArn
Type: string

The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:

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

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

The time at which the certificate was requested.

DomainName
Type: string

The fully qualified domain name for the certificate, such as www.example.com or example.com.

DomainValidationOptions
Type: Array of DomainValidation structures

Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

ExtendedKeyUsages
Type: Array of ExtendedKeyUsage structures

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

FailureReason
Type: string

The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the Certificate Manager User Guide.

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

The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

InUseBy
Type: Array of strings

A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.

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

The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

Issuer
Type: string

The name of the certificate authority that issued and signed the certificate.

KeyAlgorithm
Type: string

The algorithm that was used to generate the public-private key pair.

KeyUsages
Type: Array of KeyUsage structures

A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

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

The time after which the certificate is not valid.

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

The time before which the certificate is not valid.

Options
Type: CertificateOptions structure

Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.

RenewalEligibility
Type: string

Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

RenewalSummary
Type: RenewalSummary structure

Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

RevocationReason
Type: string

The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.

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

The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

Serial
Type: string

The serial number of the certificate.

SignatureAlgorithm
Type: string

The algorithm that was used to sign the certificate.

Status
Type: string

The status of the certificate.

A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

Subject
Type: string

The name of the entity that is associated with the public key contained in the certificate.

SubjectAlternativeNames
Type: Array of strings

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

Type
Type: string

The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.

CertificateOptions

Description

Structure that contains options for your certificate. Currently, you can use this only to specify whether to opt in to or out of certificate transparency logging. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see Certificate Transparency Logging.

Members
CertificateTransparencyLoggingPreference
Type: string

You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

CertificateSummary

Description

This structure is returned in the response object of ListCertificates action.

Members
CertificateArn
Type: string

Amazon Resource Name (ARN) of the certificate. This is of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

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

The time at which the certificate was requested.

DomainName
Type: string

Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.

Exported
Type: boolean

Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.

ExtendedKeyUsages
Type: Array of strings

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

HasAdditionalSubjectAlternativeNames
Type: boolean

When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

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

The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

InUse
Type: boolean

Indicates whether the certificate is currently in use by any Amazon Web Services resources.

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

The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

KeyAlgorithm
Type: string

The algorithm that was used to generate the public-private key pair.

KeyUsages
Type: Array of strings

A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

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

The time after which the certificate is not valid.

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

The time before which the certificate is not valid.

RenewalEligibility
Type: string

Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

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

The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

Status
Type: string

The status of the certificate.

A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

SubjectAlternativeNameSummaries
Type: Array of strings

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

Type
Type: string

The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.

ConflictException

Description

You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.

Members
message
Type: string

DomainValidation

Description

Contains information about the validation of each domain name in the certificate.

Members
DomainName
Required: Yes
Type: string

A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

ResourceRecord
Type: ResourceRecord structure

Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.

Note: The CNAME information that you need does not include the name of your domain. If you include
 your domain name in the DNS database CNAME record, validation fails.
 For example, if the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.

ValidationDomain
Type: string

The domain name that ACM used to send domain validation emails.

ValidationEmails
Type: Array of strings

A list of email addresses that ACM used to send domain validation emails.

ValidationMethod
Type: string

Specifies the domain validation method.

ValidationStatus
Type: string

The validation status of the domain name. This can be one of the following values:

  • PENDING_VALIDATION

  • SUCCESS

  • FAILED

DomainValidationOption

Description

Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.

Members
DomainName
Required: Yes
Type: string

A fully qualified domain name (FQDN) in the certificate request.

ValidationDomain
Required: Yes
Type: string

The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com, you can specify example.com for this value. In that case, ACM sends domain validation emails to the following five addresses:

  • admin@example.com

  • administrator@example.com

  • hostmaster@example.com

  • postmaster@example.com

  • webmaster@example.com

ExpiryEventsConfiguration

Description

Object containing expiration events options associated with an Amazon Web Services account.

Members
DaysBeforeExpiry
Type: int

Specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.

ExtendedKeyUsage

Description

The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension.

Members
Name
Type: string

The name of an Extended Key Usage value.

OID
Type: string

An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280.

  • 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)

  • 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)

  • 1.3.6.1.5.5.7.3.3 (CODE_SIGNING)

  • 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)

  • 1.3.6.1.5.5.7.3.8 (TIME_STAMPING)

  • 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)

  • 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)

  • 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)

  • 1.3.6.1.5.5.7.3.7 (IPSEC_USER)

Filters

Description

This structure can be used in the ListCertificates action to filter the output of the certificate list.

Members
extendedKeyUsage
Type: Array of strings

Specify one or more ExtendedKeyUsage extension values.

keyTypes
Type: Array of strings

Specify one or more algorithms that can be used to generate key pairs.

Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048","RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.

keyUsage
Type: Array of strings

Specify one or more KeyUsage extension values.

InvalidArgsException

Description

One or more of of request parameters specified is not valid.

Members
message
Type: string

InvalidArnException

Description

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

Members
message
Type: string

InvalidDomainValidationOptionsException

Description

One or more values in the DomainValidationOption structure is incorrect.

Members
message
Type: string

InvalidParameterException

Description

An input parameter was invalid.

Members
message
Type: string

InvalidStateException

Description

Processing has reached an invalid state.

Members
message
Type: string

InvalidTagException

Description

One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

Members
message
Type: string

KeyUsage

Description

The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.

Members
Name
Type: string

A string value that contains a Key Usage extension name.

LimitExceededException

Description

An ACM quota has been exceeded.

Members
message
Type: string

RenewalSummary

Description

Contains information about the status of ACM's managed renewal for the certificate. This structure exists only when the certificate type is AMAZON_ISSUED.

Members
DomainValidationOptions
Required: Yes
Type: Array of DomainValidation structures

Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

RenewalStatus
Required: Yes
Type: string

The status of ACM's managed renewal of the certificate.

RenewalStatusReason
Type: string

The reason that a renewal request was unsuccessful.

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

The time at which the renewal summary was last updated.

RequestInProgressException

Description

The certificate request is in process and the certificate in your account has not yet been issued.

Members
message
Type: string

ResourceInUseException

Description

The certificate is in use by another Amazon Web Services service in the caller's account. Remove the association and try again.

Members
message
Type: string

ResourceNotFoundException

Description

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

Members
message
Type: string

ResourceRecord

Description

Contains a DNS record value that you can use to validate ownership or control of a domain. This is used by the DescribeCertificate action.

Members
Name
Required: Yes
Type: string

The name of the DNS record to create in your domain. This is supplied by ACM.

Type
Required: Yes
Type: string

The type of DNS record. Currently this can be CNAME.

Value
Required: Yes
Type: string

The value of the CNAME record to add to your DNS database. This is supplied by ACM.

Tag

Description

A key-value pair that identifies or specifies metadata about an ACM resource.

Members
Key
Required: Yes
Type: string

The key of the tag.

Value
Type: string

The value of the tag.

TagPolicyException

Description

A specified tag did not comply with an existing tag policy and was rejected.

Members
message
Type: string

ThrottlingException

Description

The request was denied because it exceeded a quota.

Members
message
Type: string

TooManyTagsException

Description

The request contains too many tags. Try the request again with fewer tags.

Members
message
Type: string

ValidationException

Description

The supplied input failed to satisfy constraints of an Amazon Web Services service.

Members
message
Type: string