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

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

TooManyTagsException:

An input parameter was invalid.

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

The request was denied because it exceeded a quota.

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

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

ResourceInUseException:

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

DeleteCertificate

result=result = result=client->deleteCertificate([/* ... /]); promise=promise = 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=result = result=client->deleteCertificate([ 'CertificateArn' => '', // 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

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

The request was denied because it exceeded a quota.

AccessDeniedException:

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

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.

You do not have access required to perform this action.

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

DescribeCertificate

result=result = result=client->describeCertificate([/* ... /]); promise=promise = 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=result = result=client->describeCertificate([ 'CertificateArn' => '', // 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

Result Details

Members

Certificate

Type: CertificateDetail structure

Metadata about an ACM certificate.

Errors

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

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

ExportCertificate

result=result = result=client->exportCertificate([/* ... /]); promise=promise = 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=result = result=client->exportCertificate([ 'CertificateArn' => '', // 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' => '', 'CertificateChain' => '', 'PrivateKey' => '', ]

Result Details

Members

Certificate

The base64 PEM-encoded certificate.

CertificateChain

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

PrivateKey

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

RequestInProgressException:

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

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

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

GetAccountConfiguration

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

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

Parameter Syntax

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

Parameter Details

Members

Result Syntax

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

Result Details

Members

ExpiryEvents

Type: ExpiryEventsConfiguration structure

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

Errors

AccessDeniedException:

The request was denied because it exceeded a quota.

You do not have access required to perform this action.

GetCertificate

result=result = result=client->getCertificate([/* ... /]); promise=promise = 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=result = result=client->getCertificate([ 'CertificateArn' => '', // 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' => '', 'CertificateChain' => '', ]

Result Details

Members

Certificate

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

CertificateChain

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

RequestInProgressException:

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

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

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

ImportCertificate

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

Parameter Details

Members

Certificate

Required: Yes

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

The certificate to import.

CertificateArn

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' => '', ]

Result Details

Errors

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

TooManyTagsException:

An input parameter was invalid.

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

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

LimitExceededException:

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

An ACM quota has been exceeded.

InvalidArgsException:

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

ListCertificates

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

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.

Parameter Syntax

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

Parameter Details

Members

CertificateStatuses

Filter the certificate list by status value.

Includes

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

MaxItems

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

NextToken

Use this parameter 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

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

SortOrder

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

Result Syntax

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

Result Details

Members

CertificateSummaryList

Type: Array of CertificateSummary structures

A list of ACM certificates.

NextToken

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

ValidationException:

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

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

ListTagsForCertificate

result=result = result=client->listTagsForCertificate([/* ... /]); promise=promise = 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=result = result=client->listTagsForCertificate([ 'CertificateArn' => '', // 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' => '', 'Value' => '', ], // ... ], ]

Result Details

Members

Tags

Type: Array of Tag structures

The key-value pairs that define the applied tags.

Errors

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

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

PutAccountConfiguration

result=result = result=client->putAccountConfiguration([/* ... /]); promise=promise = 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=result = result=client->putAccountConfiguration([ 'ExpiryEvents' => [ 'DaysBeforeExpiry' => , ], 'IdempotencyToken' => '', // 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.

AccessDeniedException:

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.

You do not have access required to perform this action.

RemoveTagsFromCertificate

result=result = result=client->removeTagsFromCertificate([/* ... /]); promise=promise = 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=result = result=client->removeTagsFromCertificate([ 'CertificateArn' => '', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '', // REQUIRED 'Value' => '', ], // ... ], ]);

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

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

An input parameter was invalid.

The request was denied because it exceeded a quota.

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

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

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

RenewCertificate

result=result = result=client->renewCertificate([/* ... /]); promise=promise = 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=result = result=client->renewCertificate([ 'CertificateArn' => '', // 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

RequestInProgressException:

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

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

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

RequestCertificate

result=result = result=client->requestCertificate([/* ... /]); promise=promise = 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=result = result=client->requestCertificate([ 'CertificateAuthorityArn' => '', 'DomainName' => '', // REQUIRED 'DomainValidationOptions' => [ [ 'DomainName' => '', // REQUIRED 'ValidationDomain' => '', // REQUIRED ], // ... ], 'IdempotencyToken' => '', 'KeyAlgorithm' => 'RSA_1024|RSA_2048|RSA_3072|RSA_4096|EC_prime256v1|EC_secp384r1|EC_secp521r1', 'ManagedBy' => 'CLOUDFRONT', 'Options' => [ 'CertificateTransparencyLoggingPreference' => 'ENABLED|DISABLED', ], 'SubjectAlternativeNames' => ['', ...], 'Tags' => [ [ 'Key' => '', // REQUIRED 'Value' => '', ], // ... ], 'ValidationMethod' => 'EMAIL|DNS|HTTP', ]);

Parameter Details

Members

CertificateAuthorityArn

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

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

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

ManagedBy

Identifies the Amazon Web Services service that manages the certificate issued by ACM.

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

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

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' => '', ]

Result Details

Members

CertificateArn

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

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

TooManyTagsException:

An input parameter was invalid.

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

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

InvalidDomainValidationOptionsException:

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

One or more values in the DomainValidationOption structure is incorrect.

LimitExceededException:

An ACM quota has been exceeded.

ResendValidationEmail

result=result = result=client->resendValidationEmail([/* ... /]); promise=promise = 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=result = result=client->resendValidationEmail([ 'CertificateArn' => '', // REQUIRED 'Domain' => '', // REQUIRED 'ValidationDomain' => '', // 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:

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidDomainValidationOptionsException:

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

One or more values in the DomainValidationOption structure is incorrect.

InvalidStateException:

Processing has reached an invalid state.

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

UpdateCertificateOptions

result=result = result=client->updateCertificateOptions([/* ... /]); promise=promise = 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=result = result=client->updateCertificateOptions([ 'CertificateArn' => '', // 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

LimitExceededException:

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

An ACM quota has been exceeded.

InvalidStateException:

Processing has reached an invalid state.