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.
This action applies only to the certificate resource type. For all other ACM resource types, use TagResource instead.
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.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "CreateAcmeDomainValidation":{ "name":"CreateAcmeDomainValidation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAcmeDomainValidationRequest"}, "output":{"shape":"CreateAcmeDomainValidationResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates a domain validation for an ACME endpoint. Domain validations authorize the endpoint to issue certificates for specified domain names. You configure prevalidation to prove domain ownership.
", "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "CreateAcmeEndpoint":{ "name":"CreateAcmeEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAcmeEndpointRequest"}, "output":{"shape":"CreateAcmeEndpointResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL. After creation, ACME clients can use the endpoint URL to automate certificate issuance using the ACME protocol.
", "idempotent":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "CreateAcmeExternalAccountBinding":{ "name":"CreateAcmeExternalAccountBinding", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAcmeExternalAccountBindingRequest"}, "output":{"shape":"CreateAcmeExternalAccountBindingResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates an external account binding (EAB) for an ACME endpoint. An EAB provides credentials that authorize an ACME client to register an account with the endpoint. Each EAB is associated with an IAM role that controls what certificate operations the ACME client can perform.
", "idempotent":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "DeleteAcmeDomainValidation":{ "name":"DeleteAcmeDomainValidation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAcmeDomainValidationRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes a domain validation. After deletion, the ACME endpoint can no longer issue certificates for the associated domain.
", "idempotent":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "DeleteAcmeEndpoint":{ "name":"DeleteAcmeEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAcmeEndpointRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes an ACME endpoint. After deletion, the endpoint URL is no longer accessible and ACME clients cannot issue certificates through it. Any existing external account bindings and domain validations associated with the endpoint are also deleted.
", "idempotent":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "DeleteAcmeExternalAccountBinding":{ "name":"DeleteAcmeExternalAccountBinding", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAcmeExternalAccountBindingRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes an external account binding. Previously fetched credentials for this binding will no longer be usable for account registration. A deleted binding cannot be recovered.
", "idempotent":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "DeleteCertificate":{ "name":"DeleteCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCertificateRequest"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"InvalidArnException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes a certificate and its associated private key. If this action succeeds, the certificate is not available for use by Amazon Web Services services integrated with ACM. Deleting a certificate is eventually consistent. The may be a short delay before 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.
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, you must first remove the certificate association using the console or the CLI for the associated service.
Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting Your Private CA in the Private Certificate Authority User Guide.
You cannot delete a certificate with a CertificateKeyPairOrigin of ACME. ACM automatically deletes these certificates 1 year after they expire.
Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting your private CA in the Amazon Web Services Private Certificate Authority User Guide.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "DescribeAcmeAccount":{ "name":"DescribeAcmeAccount", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAcmeAccountRequest"}, "output":{"shape":"DescribeAcmeAccountResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "DescribeAcmeDomainValidation":{ "name":"DescribeAcmeDomainValidation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAcmeDomainValidationRequest"}, "output":{"shape":"DescribeAcmeDomainValidationResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "DescribeAcmeEndpoint":{ "name":"DescribeAcmeEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAcmeEndpointRequest"}, "output":{"shape":"DescribeAcmeEndpointResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "DescribeAcmeExternalAccountBinding":{ "name":"DescribeAcmeExternalAccountBinding", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAcmeExternalAccountBindingRequest"}, "output":{"shape":"DescribeAcmeExternalAccountBindingResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "DescribeCertificate":{ "name":"DescribeCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCertificateRequest"}, "output":{"shape":"DescribeCertificateResponse"}, "errors":[ {"shape":"InvalidArnException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 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 and Export a public certificate.
ACM public certificates created prior to June 17, 2025 cannot be exported.
Returns the account configuration options associated with an Amazon Web Services account.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "GetAcmeExternalAccountBindingCredentials":{ "name":"GetAcmeExternalAccountBindingCredentials", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAcmeExternalAccountBindingCredentialsRequest"}, "output":{"shape":"GetAcmeExternalAccountBindingCredentialsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves the key ID and MAC key credentials for an external account binding. These credentials are used by ACME clients during account registration to bind to the endpoint.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "GetCertificate":{ "name":"GetCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCertificateRequest"}, "output":{"shape":"GetCertificateResponse"}, "errors":[ {"shape":"InvalidArnException"}, {"shape":"RequestInProgressException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
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.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "ListAcmeAccounts":{ "name":"ListAcmeAccounts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAcmeAccountsRequest"}, "output":{"shape":"ListAcmeAccountsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a list of ACME accounts registered with the specified ACME endpoint. ACME accounts are created when clients use external account binding credentials to register.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "ListAcmeDomainValidations":{ "name":"ListAcmeDomainValidations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAcmeDomainValidationsRequest"}, "output":{"shape":"ListAcmeDomainValidationsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a list of domain validations for the specified ACME endpoint.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "ListAcmeEndpoints":{ "name":"ListAcmeEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAcmeEndpointsRequest"}, "output":{"shape":"ListAcmeEndpointsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a list of ACME endpoints in your account. Use this operation to view all configured ACME endpoints and their current status.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "ListAcmeExternalAccountBindings":{ "name":"ListAcmeExternalAccountBindings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAcmeExternalAccountBindingsRequest"}, "output":{"shape":"ListAcmeExternalAccountBindingsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a list of external account bindings for the specified ACME endpoint.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "ListCertificateDomainValidations":{ "name":"ListCertificateDomainValidations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCertificateDomainValidationsRequest"}, "output":{"shape":"ListCertificateDomainValidationsResponse"}, "errors":[ {"shape":"InvalidArgsException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns per-domain validation summaries for an ACM certificate. Each summary includes the domain name, the active validation configuration, and the requested validation configuration when a validation method migration is in progress. You can use the results to monitor the progress of an email-to-DNS validation migration and to retrieve the CNAME records required for DNS validation.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "ListCertificates":{ "name":"ListCertificates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCertificatesRequest"}, "output":{"shape":"ListCertificatesResponse"}, "errors":[ {"shape":"InvalidArgsException"}, {"shape":"ValidationException"} ], "documentation":"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.
By default, this action does not return certificates with a CertificateKeyPairOrigin of ACME. To include ACME certificates, specify ACME in the CertificateKeyPairOrigins filter.
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.
This action applies only to the certificate resource type. For all other ACM resource types, use ListTagsForResource instead.
Lists the tags associated with an ACM resource.
Use this action for all ACM resource types except the certificate resource type. For certificate resources, use ListTagsForCertificate instead.
To add one or more tags, use the TagResource action. To remove one or more tags, use the UntagResource action.
", "readonly":true, "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "PutAccountConfiguration":{ "name":"PutAccountConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutAccountConfigurationRequest"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
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.
This action applies only to the certificate resource type. For all other ACM resource types, use UntagResource instead.
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.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "RenewCertificate":{ "name":"RenewCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RenewCertificateRequest"}, "errors":[ {"shape":"InvalidArnException"}, {"shape":"RequestInProgressException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Renews an eligible ACM certificate. 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.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "RequestCertificate":{ "name":"RequestCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestCertificateRequest"}, "output":{"shape":"RequestCertificateResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"TagPolicyException"}, {"shape":"TooManyTagsException"}, {"shape":"InvalidArnException"}, {"shape":"InvalidTagException"}, {"shape":"InvalidDomainValidationOptionsException"}, {"shape":"LimitExceededException"} ], "documentation":"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 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.
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.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "RevokeAcmeAccount":{ "name":"RevokeAcmeAccount", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeAcmeAccountRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Revokes an ACME account, preventing it from requesting or revoking certificates. This operation is irreversible.
", "idempotent":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "RevokeAcmeExternalAccountBinding":{ "name":"RevokeAcmeExternalAccountBinding", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeAcmeExternalAccountBindingRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Revokes an external account binding, preventing new ACME accounts from being registered using this binding. Existing ACME accounts that were previously registered using the binding are not affected and must be revoked separately.
", "idempotent":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "RevokeCertificate":{ "name":"RevokeCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeCertificateRequest"}, "output":{"shape":"RevokeCertificateResponse"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"InvalidArnException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Revokes a public ACM certificate. You can only revoke certificates that have been previously exported.
Once a certificate is revoked, you cannot reuse the certificate. Revoking a certificate is permanent.
Retrieves a list of certificates matching search criteria. You can filter certificates by X.509 attributes and ACM specific properties like certificate status, type and renewal eligibility. This operation provides more flexible filtering than ListCertificates by supporting complex filter statements.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Adds one or more tags to an ACM resource. 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.
Use this action for all ACM resource types except the certificate resource type. For certificate resources, use AddTagsToCertificate instead.
To remove one or more tags, use the UntagResource action. To view all of the tags that have been applied to a resource, use the ListTagsForResource action.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Removes one or more tags from an ACM resource.
Use this action for all ACM resource types except the certificate resource type. For certificate resources, use RemoveTagsFromCertificate instead.
To add one or more tags, use the TagResource action. To view all of the tags that have been applied to a resource, use the ListTagsForResource action.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } }, "UpdateAcmeDomainValidation":{ "name":"UpdateAcmeDomainValidation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAcmeDomainValidationRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates the prevalidation configuration of an existing domain validation.
", "idempotent":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "UpdateAcmeEndpoint":{ "name":"UpdateAcmeEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAcmeEndpointRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates the configuration of an existing ACME endpoint. You can change the authorization behavior, contact requirement, or certificate authority settings.
", "idempotent":true, "staticContextParams":{ "ServiceType":{"value":"ACM-ACME"} } }, "UpdateCertificateOptions":{ "name":"UpdateCertificateOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateCertificateOptionsRequest"}, "errors":[ {"shape":"InvalidArnException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"ValidationException"}, {"shape":"InvalidStateException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Updates certificate options. You can use this operation to change the domain validation method or specify whether to export your certificate. For more information, see Migrate from email to DNS validation and Certificate Manager Exportable Managed Certificates.
", "staticContextParams":{ "ServiceType":{"value":"ACM"} } } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"ServiceErrorMessage"} }, "documentation":"You do not have access required to perform this action.
", "exception":true }, "AcmCertificateMetadata":{ "type":"structure", "members":{ "CreatedAt":{ "shape":"TStamp", "documentation":"The time at which the certificate was requested.
" }, "Exported":{ "shape":"NullableBoolean", "documentation":"Indicates whether the certificate has been exported.
" }, "ImportedAt":{ "shape":"TStamp", "documentation":"The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.
Indicates whether the certificate is currently in use by an Amazon Web Services service.
" }, "IssuedAt":{ "shape":"TStamp", "documentation":"The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
" }, "RevokedAt":{ "shape":"TStamp", "documentation":"The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
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.
" }, "RenewalStatus":{ "shape":"RenewalStatus", "documentation":"The renewal status of the certificate.
" }, "Type":{ "shape":"CertificateType", "documentation":"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.
Indicates whether the certificate can be exported.
" }, "ManagedBy":{ "shape":"CertificateManagedBy", "documentation":"Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" }, "ValidationMethod":{ "shape":"ValidationMethod", "documentation":"Specifies the domain validation method.
" }, "CertificateKeyPairOrigin":{ "shape":"CertificateKeyPairOrigin", "documentation":"The origin of the certificate's key pair.
" }, "AcmeEndpointArn":{ "shape":"Arn", "documentation":"The ARN of the ACME endpoint used to issue the certificate.
" }, "AcmeAccountId":{ "shape":"AcmeAccountId", "documentation":"The ACME account identifier associated with the certificate.
" } }, "documentation":"Contains ACM-specific metadata about a certificate.
" }, "AcmCertificateMetadataFilter":{ "type":"structure", "members":{ "Status":{ "shape":"CertificateStatus", "documentation":"Filter by certificate status.
" }, "RenewalStatus":{ "shape":"RenewalStatus", "documentation":"Filter by certificate renewal status.
" }, "Type":{ "shape":"CertificateType", "documentation":"Filter by certificate type.
" }, "InUse":{ "shape":"NullableBoolean", "documentation":"Filter by whether the certificate is in use.
" }, "Exported":{ "shape":"NullableBoolean", "documentation":"Filter by whether the certificate has been exported.
" }, "ExportOption":{ "shape":"CertificateExport", "documentation":"Filter by certificate export option.
" }, "ManagedBy":{ "shape":"CertificateManagedBy", "documentation":"Filter by the entity that manages the certificate.
" }, "ValidationMethod":{ "shape":"ValidationMethod", "documentation":"Filter by validation method.
" }, "CertificateKeyPairOrigin":{ "shape":"CertificateKeyPairOrigin", "documentation":"Filter by certificate key pair origin.
" }, "AcmeEndpointArn":{ "shape":"Arn", "documentation":"Filter by ACME endpoint ARN.
" }, "AcmeAccountId":{ "shape":"AcmeAccountId", "documentation":"Filter by ACME account identifier.
" } }, "documentation":"Filters certificates by ACM metadata.
", "union":true }, "AcmeAccount":{ "type":"structure", "members":{ "AccountUrl":{ "shape":"String", "documentation":"The URL of the ACME account.
" }, "PublicKeyThumbprint":{ "shape":"String", "documentation":"The thumbprint of the public key associated with the ACME account.
" }, "Status":{ "shape":"AcmeAccountStatus", "documentation":"The status of the ACME account.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"The time at which the ACME account was created.
" }, "AcmeExternalAccountBindingArn":{ "shape":"AcmeExternalAccountBindingArn", "documentation":"The Amazon Resource Name (ARN) of the external account binding associated with this ACME account.
" }, "Contacts":{ "shape":"ContactList", "documentation":"The contact information for the ACME account.
" } }, "documentation":"Contains detailed information about an ACME account.
" }, "AcmeAccountId":{ "type":"string", "max":36, "min":36 }, "AcmeAccountList":{ "type":"list", "member":{"shape":"AcmeAccountSummary"} }, "AcmeAccountStatus":{ "type":"string", "enum":[ "VALID", "DEACTIVATED", "REVOKED" ] }, "AcmeAccountSummary":{ "type":"structure", "members":{ "AccountUrl":{ "shape":"String", "documentation":"The URL of the ACME account.
" }, "PublicKeyThumbprint":{ "shape":"String", "documentation":"The thumbprint of the public key associated with the ACME account.
" }, "Status":{ "shape":"AcmeAccountStatus", "documentation":"The status of the ACME account.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"The time at which the ACME account was created.
" }, "AcmeExternalAccountBindingArn":{ "shape":"AcmeExternalAccountBindingArn", "documentation":"The Amazon Resource Name (ARN) of the external account binding associated with this ACME account.
" }, "Contacts":{ "shape":"ContactList", "documentation":"The contact information for the ACME account.
" } }, "documentation":"Contains summary information about an ACME account.
" }, "AcmeAuthorizationBehavior":{ "type":"string", "enum":["PRE_APPROVED"] }, "AcmeContact":{ "type":"string", "enum":[ "REQUIRED", "NOT_REQUIRED" ] }, "AcmeDomainValidation":{ "type":"structure", "members":{ "AcmeDomainValidationArn":{ "shape":"AcmeDomainValidationArn", "documentation":"The Amazon Resource Name (ARN) of the ACME domain validation.
" }, "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" }, "DomainName":{ "shape":"DomainName", "documentation":"The domain name being validated.
" }, "PrevalidationType":{ "shape":"PrevalidationType", "documentation":"The type of prevalidation used.
" }, "PrevalidationDetails":{ "shape":"PrevalidationDetails", "documentation":"Details about the prevalidation configuration.
" }, "Status":{ "shape":"AcmeDomainValidationStatus", "documentation":"The status of the domain validation.
" }, "FailureDetails":{ "shape":"FailureDetails", "documentation":"Details about the failure, if the validation failed.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"The time at which the domain validation was created.
" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"The time at which the domain validation was last updated.
" } }, "documentation":"Contains detailed information about an ACME domain validation.
" }, "AcmeDomainValidationArn":{ "type":"string", "max":200, "min":1, "pattern":"arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+/acme-domain-validation/[a-zA-Z0-9-]+" }, "AcmeDomainValidationFailureReason":{ "type":"string", "enum":[ "ACCESS_DENIED", "DOMAIN_MISMATCH", "DOMAIN_NOT_ALLOWED", "ENDPOINT_NOT_ACTIVE", "HOSTED_ZONE_NOT_FOUND", "INTERNAL_FAILURE", "INVALID_CHANGE_BATCH", "INVALID_PUBLIC_DOMAIN", "TIMED_OUT" ] }, "AcmeDomainValidationList":{ "type":"list", "member":{"shape":"AcmeDomainValidationSummary"} }, "AcmeDomainValidationStatus":{ "type":"string", "enum":[ "VALIDATING", "VALID", "INVALID", "DELETING" ] }, "AcmeDomainValidationSummary":{ "type":"structure", "members":{ "AcmeDomainValidationArn":{ "shape":"AcmeDomainValidationArn", "documentation":"The Amazon Resource Name (ARN) of the ACME domain validation.
" }, "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" }, "DomainName":{ "shape":"DomainName", "documentation":"The domain name being validated.
" }, "PrevalidationType":{ "shape":"PrevalidationType", "documentation":"The type of prevalidation used.
" }, "PrevalidationDetails":{ "shape":"PrevalidationDetails", "documentation":"Details about the prevalidation configuration.
" }, "Status":{ "shape":"AcmeDomainValidationStatus", "documentation":"The status of the domain validation.
" }, "FailureDetails":{ "shape":"FailureDetails", "documentation":"Details about the failure, if the validation failed.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"The time at which the domain validation was created.
" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"The time at which the domain validation was last updated.
" } }, "documentation":"Contains summary information about an ACME domain validation.
" }, "AcmeEndpoint":{ "type":"structure", "members":{ "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" }, "EndpointUrl":{ "shape":"String", "documentation":"The URL of the ACME endpoint.
" }, "Status":{ "shape":"AcmeEndpointStatus", "documentation":"The status of the ACME endpoint.
" }, "FailureReason":{ "shape":"String", "documentation":"The reason the ACME endpoint failed, if applicable.
" }, "AuthorizationBehavior":{ "shape":"AcmeAuthorizationBehavior", "documentation":"The authorization behavior of the ACME endpoint.
" }, "Contact":{ "shape":"AcmeContact", "documentation":"Whether ACME clients must provide contact information during account registration.
" }, "CertificateAuthority":{ "shape":"CertificateAuthority", "documentation":"The certificate authority configuration for the ACME endpoint.
" }, "CertificateTags":{ "shape":"TagList", "documentation":"Tags applied to certificates issued through this ACME endpoint.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"The time at which the ACME endpoint was created.
" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"The time at which the ACME endpoint was last updated.
" } }, "documentation":"Contains detailed information about an ACME endpoint.
" }, "AcmeEndpointArn":{ "type":"string", "max":200, "min":1, "pattern":"arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+" }, "AcmeEndpointList":{ "type":"list", "member":{"shape":"AcmeEndpointSummary"} }, "AcmeEndpointStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "DELETING", "FAILED" ] }, "AcmeEndpointSummary":{ "type":"structure", "members":{ "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" }, "EndpointUrl":{ "shape":"String", "documentation":"The URL of the ACME endpoint.
" }, "Status":{ "shape":"AcmeEndpointStatus", "documentation":"The status of the ACME endpoint.
" }, "FailureReason":{ "shape":"String", "documentation":"The reason the ACME endpoint failed, if applicable.
" }, "AuthorizationBehavior":{ "shape":"AcmeAuthorizationBehavior", "documentation":"The authorization behavior of the ACME endpoint.
" }, "Contact":{ "shape":"AcmeContact", "documentation":"Whether ACME clients must provide contact information during account registration.
" }, "CertificateAuthority":{ "shape":"CertificateAuthority", "documentation":"The certificate authority configuration for the ACME endpoint.
" }, "CertificateTags":{ "shape":"TagList", "documentation":"Tags applied to certificates issued through this ACME endpoint.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"The time at which the ACME endpoint was created.
" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"The time at which the ACME endpoint was last updated.
" } }, "documentation":"Contains summary information about an ACME endpoint.
" }, "AcmeExternalAccountBinding":{ "type":"structure", "members":{ "AcmeExternalAccountBindingArn":{ "shape":"AcmeExternalAccountBindingArn", "documentation":"The Amazon Resource Name (ARN) of the ACME external account binding.
" }, "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role associated with the external account binding.
" }, "ExpiresAt":{ "shape":"Timestamp", "documentation":"The time at which the external account binding expires.
" }, "RevokedAt":{ "shape":"Timestamp", "documentation":"The time at which the external account binding was revoked.
" }, "LastUsedAt":{ "shape":"Timestamp", "documentation":"The time at which the external account binding was last used.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"The time at which the external account binding was created.
" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"The time at which the external account binding was last updated.
" } }, "documentation":"Contains detailed information about an ACME external account binding.
" }, "AcmeExternalAccountBindingArn":{ "type":"string", "max":200, "min":1, "pattern":"arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+/acme-external-account-binding/[a-zA-Z0-9-]+" }, "AcmeExternalAccountBindingList":{ "type":"list", "member":{"shape":"AcmeExternalAccountBindingSummary"} }, "AcmeExternalAccountBindingSummary":{ "type":"structure", "members":{ "AcmeExternalAccountBindingArn":{ "shape":"AcmeExternalAccountBindingArn", "documentation":"The Amazon Resource Name (ARN) of the ACME external account binding.
" }, "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role associated with the external account binding.
" }, "ExpiresAt":{ "shape":"Timestamp", "documentation":"The time at which the external account binding expires.
" }, "RevokedAt":{ "shape":"Timestamp", "documentation":"The time at which the external account binding was revoked.
" }, "LastUsedAt":{ "shape":"Timestamp", "documentation":"The time at which the external account binding was last used.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"The time at which the external account binding was created.
" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"The time at which the external account binding was last updated.
" } }, "documentation":"Contains summary information about an ACME external account binding.
" }, "AddTagsToCertificateRequest":{ "type":"structure", "required":[ "CertificateArn", "Tags" ], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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":{ "shape":"TagList", "documentation":"The key-value pair that defines the tag. The tag value is optional.
" } } }, "Arn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:[\\w+=/,.@-]+:acm:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*" }, "AvailabilityErrorMessage":{"type":"string"}, "CertificateArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:[\\w+=/,.@-]+:acm:[\\w+=/,.@-]*:[0-9]+:certificate/[\\w+=,.@-]+.*" }, "CertificateAuthority":{ "type":"structure", "members":{ "PublicCertificateAuthority":{ "shape":"PublicCertificateAuthority", "documentation":"Configuration for using a public certificate authority.
" } }, "documentation":"Defines the certificate authority to use for an ACME endpoint.
", "union":true }, "CertificateBody":{ "type":"string", "max":32768, "min":1, "pattern":"-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?" }, "CertificateBodyBlob":{ "type":"blob", "max":32768, "min":1 }, "CertificateChain":{ "type":"string", "max":2097152, "min":1, "pattern":"(-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}\\u000D?\\u000A)*-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?" }, "CertificateChainBlob":{ "type":"blob", "max":2097152, "min":1 }, "CertificateDetail":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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.
" }, "DomainName":{ "shape":"DomainNameString", "documentation":"The fully qualified domain name for the certificate, such as www.example.com or example.com.
" }, "SubjectAlternativeNames":{ "shape":"DomainList", "documentation":"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.
" }, "ManagedBy":{ "shape":"CertificateManagedBy", "documentation":"Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" }, "DomainValidationOptions":{ "shape":"DomainValidationList", "documentation":"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.
The serial number of the certificate.
" }, "Subject":{ "shape":"String", "documentation":"The name of the entity that is associated with the public key contained in the certificate.
" }, "Issuer":{ "shape":"String", "documentation":"The name of the certificate authority that issued and signed the certificate.
" }, "CreatedAt":{ "shape":"TStamp", "documentation":"The time at which the certificate was requested.
" }, "IssuedAt":{ "shape":"TStamp", "documentation":"The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.
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.
" }, "RevokedAt":{ "shape":"TStamp", "documentation":"The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.
The time before which the certificate is not valid.
" }, "NotAfter":{ "shape":"TStamp", "documentation":"The time after which the certificate is not valid.
" }, "KeyAlgorithm":{ "shape":"KeyAlgorithm", "documentation":"The algorithm that was used to generate the public-private key pair.
" }, "SignatureAlgorithm":{ "shape":"String", "documentation":"The algorithm that was used to sign the certificate.
" }, "InUseBy":{ "shape":"InUseList", "documentation":"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.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"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.
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.
Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.
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.
" }, "ExtendedKeyUsages":{ "shape":"ExtendedKeyUsageList", "documentation":"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).
" }, "CertificateAuthorityArn":{ "shape":"Arn", "documentation":"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
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
" }, "Options":{ "shape":"CertificateOptions", "documentation":"Contains the certificate options. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log.
" }, "UpdateSummary":{ "shape":"UpdateSummary", "documentation":"Contains information about the most recent update to the certificate. This field exists only when the certificate type is AMAZON_ISSUED and a certificate update has been requested.
The origin of the certificate's key pair.
" }, "AcmeEndpointArn":{ "shape":"Arn", "documentation":"The ARN of the ACME endpoint used to issue the certificate.
" }, "AcmeAccountId":{ "shape":"AcmeAccountId", "documentation":"The ACME account identifier associated with the certificate.
" } }, "documentation":"Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.
" }, "CertificateExport":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "CertificateFilter":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"Filter by certificate ARN.
" }, "X509AttributeFilter":{ "shape":"X509AttributeFilter", "documentation":"Filter by X.509 certificate attributes.
" }, "AcmCertificateMetadataFilter":{ "shape":"AcmCertificateMetadataFilter", "documentation":"Filter by ACM certificate metadata.
" } }, "documentation":"Defines a filter for searching certificates by ARN, X.509 attributes, or ACM metadata.
", "union":true }, "CertificateFilterStatement":{ "type":"structure", "members":{ "And":{ "shape":"CertificateFilterStatementList", "documentation":"A list of filter statements that must all be true.
" }, "Or":{ "shape":"CertificateFilterStatementList", "documentation":"A list of filter statements where at least one must be true.
" }, "Not":{ "shape":"CertificateFilterStatement", "documentation":"A filter statement that must not be true.
" }, "Filter":{ "shape":"CertificateFilter", "documentation":"A single certificate filter.
" } }, "documentation":"A filter statement used to search for certificates. Can contain AND, OR, NOT logical operators or a single filter.
", "union":true }, "CertificateFilterStatementList":{ "type":"list", "member":{"shape":"CertificateFilterStatement"}, "documentation":"A list of CertificateFilterStatement objects.
The origin of the certificate's key pair.
", "enum":[ "AWS_MANAGED", "ACME", "CUSTOMER_PROVIDED" ] }, "CertificateKeyPairOrigins":{ "type":"list", "member":{"shape":"CertificateKeyPairOrigin"}, "documentation":"A list of CertificateKeyPairOrigin values used to filter certificates.
Metadata for an ACM certificate.
" } }, "documentation":"Contains metadata about a certificate. Currently supports ACM certificate metadata.
", "union":true }, "CertificateOptions":{ "type":"structure", "members":{ "CertificateTransparencyLoggingPreference":{ "shape":"CertificateTransparencyLoggingPreference", "documentation":"This parameter has been deprecated. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log.
", "deprecated":true, "deprecatedMessage":"Certificate transparency logging opt-out is no longer available.", "deprecatedSince":"12th June 2026" }, "Export":{ "shape":"CertificateExport", "documentation":"You can opt in to allow the export of your certificates by specifying ENABLED. You cannot update the value of Export after the the certificate is created.
The domain validation method for the certificate. To migrate from email to DNS validation, specify DNS.
Structure that contains options for your certificate. You can use this structure to change the domain validation method or specify whether to export your certificate.
All public certificates are recorded in a certificate transparency log. For general information, see Certificate Transparency Logging.
You can export public ACM certificates to use with Amazon Web Services services as well as outside Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate.
" }, "CertificateSearchResult":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the certificate.
" }, "X509Attributes":{ "shape":"X509Attributes", "documentation":"X.509 certificate attributes such as subject, issuer, and validity period.
" }, "CertificateMetadata":{ "shape":"CertificateMetadata", "documentation":"ACM-specific metadata about the certificate.
" } }, "documentation":"Contains information about a certificate returned by the SearchCertificates action. This structure includes the certificate ARN, X.509 attributes, and ACM metadata.
" }, "CertificateSearchResultList":{ "type":"list", "member":{"shape":"CertificateSearchResult"}, "documentation":"A list of CertificateSearchResult objects.
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).
" }, "DomainName":{ "shape":"DomainNameString", "documentation":"Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
" }, "SubjectAlternativeNameSummaries":{ "shape":"DomainList", "documentation":"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.
" }, "HasAdditionalSubjectAlternativeNames":{ "shape":"NullableBoolean", "documentation":"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.
" }, "Status":{ "shape":"CertificateStatus", "documentation":"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.
" }, "Type":{ "shape":"CertificateType", "documentation":"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.
The algorithm that was used to generate the public-private key pair.
" }, "KeyUsages":{ "shape":"KeyUsageNames", "documentation":"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.
" }, "ExtendedKeyUsages":{ "shape":"ExtendedKeyUsageNames", "documentation":"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).
" }, "ExportOption":{ "shape":"CertificateExport", "documentation":"Indicates if export is enabled for the certificate.
" }, "InUse":{ "shape":"NullableBoolean", "documentation":"Indicates whether the certificate is currently in use by any Amazon Web Services resources.
" }, "Exported":{ "shape":"NullableBoolean", "documentation":"Indicates whether the certificate has been exported.
" }, "RenewalEligibility":{ "shape":"RenewalEligibility", "documentation":"Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
" }, "NotBefore":{ "shape":"TStamp", "documentation":"The time before which the certificate is not valid.
" }, "NotAfter":{ "shape":"TStamp", "documentation":"The time after which the certificate is not valid.
" }, "CreatedAt":{ "shape":"TStamp", "documentation":"The time at which the certificate was requested.
" }, "IssuedAt":{ "shape":"TStamp", "documentation":"The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.
The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" }, "CertificateKeyPairOrigin":{ "shape":"CertificateKeyPairOrigin", "documentation":"The origin of the certificate's key pair.
" } }, "documentation":"This structure is returned in the response object of ListCertificates action.
" }, "CertificateSummaryList":{ "type":"list", "member":{"shape":"CertificateSummary"} }, "CertificateTransparencyLoggingPreference":{ "type":"string", "deprecated":true, "deprecatedMessage":"Certificate transparency logging opt-out is no longer available.", "deprecatedSince":"12th June 2026", "enum":[ "ENABLED", "DISABLED" ] }, "CertificateType":{ "type":"string", "enum":[ "IMPORTED", "AMAZON_ISSUED", "PRIVATE" ] }, "CommonNameFilter":{ "type":"structure", "required":[ "Value", "ComparisonOperator" ], "members":{ "Value":{ "shape":"FilterString", "documentation":"The value to match against.
" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"The comparison operator to use.
" } }, "documentation":"Filters certificates by common name.
" }, "ComparisonOperator":{ "type":"string", "documentation":"The comparison operator to use for string filters. Valid values are CONTAINS and EQUALS.
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.
", "exception":true }, "ContactList":{ "type":"list", "member":{"shape":"String"}, "sensitive":true }, "CoralAvailabilityThrottledResource":{"type":"string"}, "CoralAvailabilityThrottlingReason":{"type":"string"}, "CreateAcmeDomainValidationRequest":{ "type":"structure", "required":[ "AcmeEndpointArn", "DomainName", "PrevalidationOptions" ], "members":{ "IdempotencyToken":{ "shape":"String", "documentation":"A unique, case-sensitive identifier to ensure idempotency of the request.
", "idempotencyToken":true }, "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" }, "DomainName":{ "shape":"DomainName", "documentation":"The domain name to validate.
" }, "PrevalidationOptions":{ "shape":"PrevalidationOptions", "documentation":"The prevalidation options for the domain.
" }, "Tags":{ "shape":"TagList", "documentation":"One or more tags to associate with the domain validation.
" } } }, "CreateAcmeDomainValidationResponse":{ "type":"structure", "required":["AcmeDomainValidationArn"], "members":{ "AcmeDomainValidationArn":{ "shape":"AcmeDomainValidationArn", "documentation":"The Amazon Resource Name (ARN) of the created domain validation.
" } } }, "CreateAcmeEndpointRequest":{ "type":"structure", "required":[ "AuthorizationBehavior", "CertificateAuthority" ], "members":{ "IdempotencyToken":{ "shape":"String", "documentation":"A unique, case-sensitive identifier to ensure idempotency of the request.
", "idempotencyToken":true }, "AuthorizationBehavior":{ "shape":"AcmeAuthorizationBehavior", "documentation":"The authorization behavior for the ACME endpoint.
" }, "Contact":{ "shape":"AcmeContact", "documentation":"Specifies whether ACME clients must provide contact information during account registration.
" }, "CertificateAuthority":{ "shape":"CertificateAuthority", "documentation":"The type of certificate authority to use for issuing certificates through this ACME endpoint.
" }, "Tags":{ "shape":"TagList", "documentation":"One or more tags to associate with the ACME endpoint.
" }, "CertificateTags":{ "shape":"TagList", "documentation":"Tags to apply to certificates issued through this ACME endpoint.
" } } }, "CreateAcmeEndpointResponse":{ "type":"structure", "members":{ "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the created ACME endpoint.
" } } }, "CreateAcmeExternalAccountBindingRequest":{ "type":"structure", "required":[ "AcmeEndpointArn", "RoleArn" ], "members":{ "IdempotencyToken":{ "shape":"String", "documentation":"A unique, case-sensitive identifier to ensure idempotency of the request.
", "idempotencyToken":true }, "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role to associate with the external account binding.
" }, "Expiration":{ "shape":"Expiration", "documentation":"The expiration configuration for the external account binding.
" }, "Tags":{ "shape":"TagList", "documentation":"One or more tags to associate with the external account binding.
" } } }, "CreateAcmeExternalAccountBindingResponse":{ "type":"structure", "members":{ "ExternalAccountBinding":{ "shape":"AcmeExternalAccountBinding", "documentation":"The created external account binding.
" } } }, "CustomAttribute":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"String", "documentation":"Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).
" }, "Value":{ "shape":"String", "documentation":"Specifies the attribute value of relative distinguished name (RDN).
" } }, "documentation":"Defines the X.500 relative distinguished name (RDN).
" }, "CustomAttributeList":{ "type":"list", "member":{"shape":"CustomAttribute"}, "documentation":"A list of CustomAttribute objects.
The Amazon Resource Name (ARN) of the ACME domain validation to delete.
" } } }, "DeleteAcmeEndpointRequest":{ "type":"structure", "required":["AcmeEndpointArn"], "members":{ "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint to delete.
" } } }, "DeleteAcmeExternalAccountBindingRequest":{ "type":"structure", "required":["AcmeExternalAccountBindingArn"], "members":{ "AcmeExternalAccountBindingArn":{ "shape":"AcmeExternalAccountBindingArn", "documentation":"The Amazon Resource Name (ARN) of the ACME external account binding to delete.
" } } }, "DeleteCertificateRequest":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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).
" } } }, "DescribeAcmeAccountRequest":{ "type":"structure", "required":[ "AcmeEndpointArn", "AccountUrl" ], "members":{ "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" }, "AccountUrl":{ "shape":"String", "documentation":"The URL of the ACME account.
" } } }, "DescribeAcmeAccountResponse":{ "type":"structure", "members":{ "AcmeAccount":{ "shape":"AcmeAccount", "documentation":"The ACME account details.
" } } }, "DescribeAcmeDomainValidationRequest":{ "type":"structure", "required":["AcmeDomainValidationArn"], "members":{ "AcmeDomainValidationArn":{ "shape":"AcmeDomainValidationArn", "documentation":"The Amazon Resource Name (ARN) of the ACME domain validation.
" } } }, "DescribeAcmeDomainValidationResponse":{ "type":"structure", "members":{ "AcmeDomainValidation":{ "shape":"AcmeDomainValidation", "documentation":"The ACME domain validation details.
" } } }, "DescribeAcmeEndpointRequest":{ "type":"structure", "required":["AcmeEndpointArn"], "members":{ "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" } } }, "DescribeAcmeEndpointResponse":{ "type":"structure", "members":{ "AcmeEndpoint":{ "shape":"AcmeEndpoint", "documentation":"The ACME endpoint details.
" } } }, "DescribeAcmeExternalAccountBindingRequest":{ "type":"structure", "required":["AcmeExternalAccountBindingArn"], "members":{ "AcmeExternalAccountBindingArn":{ "shape":"AcmeExternalAccountBindingArn", "documentation":"The Amazon Resource Name (ARN) of the ACME external account binding.
" } } }, "DescribeAcmeExternalAccountBindingResponse":{ "type":"structure", "members":{ "ExternalAccountBinding":{ "shape":"AcmeExternalAccountBinding", "documentation":"The external account binding details.
" } } }, "DescribeCertificateRequest":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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).
" } } }, "DescribeCertificateResponse":{ "type":"structure", "members":{ "Certificate":{ "shape":"CertificateDetail", "documentation":"Metadata about an ACM certificate.
" } } }, "DistinguishedName":{ "type":"structure", "members":{ "CommonName":{ "shape":"String", "documentation":"The common name (CN) attribute.
" }, "DomainComponents":{ "shape":"DomainComponentList", "documentation":"The domain component attributes.
" }, "Country":{ "shape":"String", "documentation":"The country (C) attribute.
" }, "CustomAttributes":{ "shape":"CustomAttributeList", "documentation":"A list of custom attributes in the distinguished name. Each custom attribute contains an object identifier (OID) and its corresponding value.
" }, "DistinguishedNameQualifier":{ "shape":"String", "documentation":"The distinguished name qualifier attribute.
" }, "GenerationQualifier":{ "shape":"String", "documentation":"The generation qualifier attribute.
" }, "GivenName":{ "shape":"String", "documentation":"The given name attribute.
" }, "Initials":{ "shape":"String", "documentation":"The initials attribute.
" }, "Locality":{ "shape":"String", "documentation":"The locality (L) attribute.
" }, "Organization":{ "shape":"String", "documentation":"The organization (O) attribute.
" }, "OrganizationalUnit":{ "shape":"String", "documentation":"The organizational unit (OU) attribute.
" }, "Pseudonym":{ "shape":"String", "documentation":"The pseudonym attribute.
" }, "SerialNumber":{ "shape":"String", "documentation":"The serial number attribute.
" }, "State":{ "shape":"String", "documentation":"The state or province (ST) attribute.
" }, "Surname":{ "shape":"String", "documentation":"The surname attribute.
" }, "Title":{ "shape":"String", "documentation":"The title attribute.
" } }, "documentation":"Contains X.500 distinguished name information.
" }, "DnsNameFilter":{ "type":"structure", "required":[ "Value", "ComparisonOperator" ], "members":{ "Value":{ "shape":"FilterString", "documentation":"The DNS name value to match against.
" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"The comparison operator to use.
" } }, "documentation":"Filters certificates by DNS name.
" }, "DnsPrevalidationDetails":{ "type":"structure", "members":{ "DomainScope":{ "shape":"DomainScope", "documentation":"The scope of domains covered by this prevalidation.
" }, "HostedZoneId":{ "shape":"HostedZoneId", "documentation":"The Route 53 hosted zone ID for DNS validation.
" }, "ResourceRecord":{ "shape":"ResourceRecord", "documentation":"The DNS resource record to create for domain validation.
" } }, "documentation":"DNS prevalidation details including the resource record for validation.
" }, "DnsPrevalidationOptions":{ "type":"structure", "members":{ "DomainScope":{ "shape":"DomainScope", "documentation":"The scope of domains covered by this prevalidation.
" }, "HostedZoneId":{ "shape":"HostedZoneId", "documentation":"The Route 53 hosted zone ID for DNS validation.
" } }, "documentation":"DNS prevalidation options for domain validation.
" }, "DnsValidationChallenge":{ "type":"structure", "members":{ "ResourceRecord":{ "shape":"ResourceRecord", "documentation":"The CNAME record that ACM creates for DNS validation. Add this record to your DNS configuration to prove that you own or control the domain.
" } }, "documentation":"Contains the CNAME record that you must add to your DNS configuration to validate domain ownership using DNS validation.
" }, "DomainComponentList":{ "type":"list", "member":{"shape":"String"}, "documentation":"A list of domain component strings.
" }, "DomainList":{ "type":"list", "member":{"shape":"DomainNameString"}, "max":100, "min":1 }, "DomainName":{ "type":"string", "max":253, "min":1, "pattern":"([a-z0-9]([a-z0-9-]*[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]*[a-z0-9])?" }, "DomainNameString":{ "type":"string", "max":253, "min":1, "pattern":"(\\*\\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])" }, "DomainScope":{ "type":"structure", "members":{ "ExactDomain":{ "shape":"DomainScopeOption", "documentation":"Whether validation applies to the exact domain.
" }, "Subdomains":{ "shape":"DomainScopeOption", "documentation":"Whether validation applies to subdomains.
" }, "Wildcards":{ "shape":"DomainScopeOption", "documentation":"Whether validation applies to wildcard domains.
" } }, "documentation":"Specifies the scope of domain validation.
" }, "DomainScopeOption":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "DomainStatus":{ "type":"string", "enum":[ "PENDING_VALIDATION", "SUCCESS", "FAILED" ] }, "DomainValidation":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainNameString", "documentation":"A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.
A list of email addresses that ACM used to send domain validation emails.
" }, "ValidationDomain":{ "shape":"DomainNameString", "documentation":"The domain name that ACM used to send domain validation emails.
" }, "ValidationStatus":{ "shape":"DomainStatus", "documentation":"The validation status of the domain name. This can be one of the following values:
PENDING_VALIDATION
SUCCESS
FAILED
Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.
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.
Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.
Specifies the domain validation method.
" } }, "documentation":"Contains information about the validation of each domain name in the certificate.
" }, "DomainValidationList":{ "type":"list", "member":{"shape":"DomainValidation"}, "max":1000, "min":1 }, "DomainValidationMethodUpdateSummary":{ "type":"structure", "members":{ "From":{ "shape":"ValidationMethod", "documentation":"The validation method that the certificate was using before the update.
" }, "To":{ "shape":"ValidationMethod", "documentation":"The target validation method for the update.
" } }, "documentation":"Contains information about a domain validation method migration, including the previous validation method and the target validation method.
" }, "DomainValidationOption":{ "type":"structure", "required":[ "DomainName", "ValidationDomain" ], "members":{ "DomainName":{ "shape":"DomainNameString", "documentation":"A fully qualified domain name (FQDN) in the certificate request.
" }, "ValidationDomain":{ "shape":"DomainNameString", "documentation":"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
Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.
" }, "DomainValidationOptionList":{ "type":"list", "member":{"shape":"DomainValidationOption"}, "max":100, "min":1 }, "DomainValidationSummary":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainNameString", "documentation":"The fully qualified domain name (FQDN) in the certificate for which this validation summary applies.
" }, "ActiveValidationConfiguration":{ "shape":"ValidationConfiguration", "documentation":"The validation configuration currently in effect for this domain. This reflects the validation method that ACM is currently using to validate domain ownership (for example, email or DNS).
" }, "RequestedValidationConfiguration":{ "shape":"ValidationConfiguration", "documentation":"The validation configuration for a pending validation method migration. This field is present only when a migration is in progress (for example, from email to DNS validation). It contains the target validation method, the current validation status, and the validation challenge details (such as the CNAME record to add to your DNS configuration).
" } }, "documentation":"Contains per-domain validation information for a certificate. This structure is returned as a member of the ListCertificateDomainValidations response.
" }, "DomainValidationSummaryList":{ "type":"list", "member":{"shape":"DomainValidationSummary"} }, "EmailValidationChallenge":{ "type":"structure", "members":{ "ValidationEmails":{ "shape":"ValidationEmailList", "documentation":"A list of email addresses that ACM uses to send domain validation emails.
" }, "ValidationDomain":{ "shape":"DomainNameString", "documentation":"The domain name that ACM uses to send validation emails.
" } }, "documentation":"Contains the email addresses used for email-based domain validation.
" }, "Expiration":{ "type":"structure", "required":[ "Value", "Type" ], "members":{ "Value":{ "shape":"ExpirationValueLong", "documentation":"The numeric value of the expiration.
" }, "Type":{ "shape":"TimeType", "documentation":"The time unit for the expiration value.
" } }, "documentation":"Specifies an expiration configuration.
" }, "ExpirationValueLong":{ "type":"long", "box":true, "min":1 }, "ExpiryEventsConfiguration":{ "type":"structure", "members":{ "DaysBeforeExpiry":{ "shape":"PositiveInteger", "documentation":"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.
Object containing expiration events options associated with an Amazon Web Services account.
" }, "ExportCertificateRequest":{ "type":"structure", "required":[ "CertificateArn", "Passphrase" ], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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 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
The base64 PEM-encoded certificate.
" }, "CertificateChain":{ "shape":"CertificateChain", "documentation":"The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.
" }, "PrivateKey":{ "shape":"PrivateKey", "documentation":"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.
" } } }, "ExtendedKeyUsage":{ "type":"structure", "members":{ "Name":{ "shape":"ExtendedKeyUsageName", "documentation":"The name of an Extended Key Usage value.
" }, "OID":{ "shape":"String", "documentation":"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)
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.
" }, "ExtendedKeyUsageFilterList":{ "type":"list", "member":{"shape":"ExtendedKeyUsageName"} }, "ExtendedKeyUsageList":{ "type":"list", "member":{"shape":"ExtendedKeyUsage"} }, "ExtendedKeyUsageName":{ "type":"string", "enum":[ "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" ] }, "ExtendedKeyUsageNames":{ "type":"list", "member":{"shape":"ExtendedKeyUsageName"} }, "FailureDetails":{ "type":"structure", "members":{ "Reason":{ "shape":"AcmeDomainValidationFailureReason", "documentation":"The reason for the failure.
" }, "Message":{ "shape":"String", "documentation":"A message describing the failure.
" } }, "documentation":"Contains details about a failure.
" }, "FailureReason":{ "type":"string", "enum":[ "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" ] }, "FilterString":{ "type":"string", "max":256, "min":1 }, "Filters":{ "type":"structure", "members":{ "extendedKeyUsage":{ "shape":"ExtendedKeyUsageFilterList", "documentation":"Specify one or more ExtendedKeyUsage extension values.
" }, "keyUsage":{ "shape":"KeyUsageFilterList", "documentation":"Specify one or more KeyUsage extension values.
" }, "keyTypes":{ "shape":"KeyAlgorithmList", "documentation":"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.
Specify ENABLED or DISABLED to identify certificates that can be exported.
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" } }, "documentation":"This structure can be used in the ListCertificates action to filter the output of the certificate list.
" }, "GeneralName":{ "type":"structure", "members":{ "DirectoryName":{ "shape":"DistinguishedName", "documentation":"Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.
Represents GeneralName as a DNS name.
Represents GeneralName as an IPv4 or IPv6 address.
Represents GeneralName using an OtherName object.
Represents GeneralName as an object identifier (OID).
Represents GeneralName as an RFC 822 email address.
Represents GeneralName as a URI.
Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the following naming options should be provided.
A list of GeneralName objects representing subject alternative names.
Expiration events configuration options associated with the Amazon Web Services account.
" } } }, "GetAcmeExternalAccountBindingCredentialsRequest":{ "type":"structure", "required":["AcmeExternalAccountBindingArn"], "members":{ "AcmeExternalAccountBindingArn":{ "shape":"AcmeExternalAccountBindingArn", "documentation":"The Amazon Resource Name (ARN) of the ACME external account binding.
" } } }, "GetAcmeExternalAccountBindingCredentialsResponse":{ "type":"structure", "members":{ "KeyId":{ "shape":"String", "documentation":"The key identifier for the external account binding credentials.
" }, "MacKey":{ "shape":"MacKey", "documentation":"The MAC key for the external account binding credentials.
" } } }, "GetCertificateRequest":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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).
" } } }, "GetCertificateResponse":{ "type":"structure", "members":{ "Certificate":{ "shape":"CertificateBody", "documentation":"The ACM-issued certificate corresponding to the ARN specified as input.
" }, "CertificateChain":{ "shape":"CertificateChain", "documentation":"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.
" } } }, "HostedZoneId":{ "type":"string", "max":32, "min":1, "pattern":"Z[A-Z0-9]+" }, "HttpRedirect":{ "type":"structure", "members":{ "RedirectFrom":{ "shape":"String", "documentation":"The URL including the domain to be validated. The certificate authority sends GET requests here during validation.
The URL hosting the validation token. RedirectFrom must return this content or redirect here.
Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.
The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.
" }, "Certificate":{ "shape":"CertificateBodyBlob", "documentation":"The certificate to import.
" }, "PrivateKey":{ "shape":"PrivateKeyBlob", "documentation":"The private key that matches the public key in the certificate.
" }, "CertificateChain":{ "shape":"CertificateChainBlob", "documentation":"The PEM encoded certificate chain.
" }, "Tags":{ "shape":"TagList", "documentation":"One or more resource tags to associate with the imported certificate.
Note: You cannot apply tags when reimporting a certificate.
" } } }, "ImportCertificateResponse":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the imported certificate.
" } } }, "InUseList":{ "type":"list", "member":{"shape":"String"} }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The request processing has failed because of an unknown error, exception, or failure.
", "exception":true, "fault":true, "retryable":{"throttling":false} }, "InvalidArgsException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"One or more of request parameters specified is not valid.
", "exception":true }, "InvalidArnException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The requested Amazon Resource Name (ARN) does not refer to an existing resource.
", "exception":true }, "InvalidDomainValidationOptionsException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"One or more values in the DomainValidationOption structure is incorrect.
", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"An input parameter was invalid.
", "exception":true }, "InvalidStateException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"Processing has reached an invalid state.
", "exception":true }, "InvalidTagException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"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:.
A string value that contains a Key Usage extension name.
" } }, "documentation":"The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.
" }, "KeyUsageFilterList":{ "type":"list", "member":{"shape":"KeyUsageName"} }, "KeyUsageList":{ "type":"list", "member":{"shape":"KeyUsage"} }, "KeyUsageName":{ "type":"string", "enum":[ "DIGITAL_SIGNATURE", "NON_REPUDIATION", "KEY_ENCIPHERMENT", "DATA_ENCIPHERMENT", "KEY_AGREEMENT", "CERTIFICATE_SIGNING", "CRL_SIGNING", "ENCIPHER_ONLY", "DECIPHER_ONLY", "ANY", "CUSTOM" ] }, "KeyUsageNames":{ "type":"list", "member":{"shape":"KeyUsageName"} }, "LimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"An ACM quota has been exceeded.
", "exception":true }, "ListAcmeAccountsRequest":{ "type":"structure", "required":["AcmeEndpointArn"], "members":{ "NextToken":{ "shape":"String", "documentation":"A token for pagination.
" }, "MaxResults":{ "shape":"ListAcmeAccountsRequestMaxResultsInteger", "documentation":"The maximum number of results to return.
" }, "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" } } }, "ListAcmeAccountsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListAcmeAccountsResponse":{ "type":"structure", "members":{ "AcmeAccounts":{ "shape":"AcmeAccountList", "documentation":"The list of ACME accounts.
" }, "NextToken":{ "shape":"String", "documentation":"A token for pagination.
" } } }, "ListAcmeDomainValidationsRequest":{ "type":"structure", "required":["AcmeEndpointArn"], "members":{ "NextToken":{ "shape":"String", "documentation":"A token for pagination.
" }, "MaxResults":{ "shape":"ListAcmeDomainValidationsRequestMaxResultsInteger", "documentation":"The maximum number of results to return.
" }, "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" } } }, "ListAcmeDomainValidationsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListAcmeDomainValidationsResponse":{ "type":"structure", "members":{ "AcmeDomainValidations":{ "shape":"AcmeDomainValidationList", "documentation":"The list of domain validations.
" }, "NextToken":{ "shape":"String", "documentation":"A token for pagination.
" } } }, "ListAcmeEndpointsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"A token for pagination.
" }, "MaxResults":{ "shape":"ListAcmeEndpointsRequestMaxResultsInteger", "documentation":"The maximum number of results to return.
" } } }, "ListAcmeEndpointsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListAcmeEndpointsResponse":{ "type":"structure", "members":{ "AcmeEndpoints":{ "shape":"AcmeEndpointList", "documentation":"The list of ACME endpoints.
" }, "NextToken":{ "shape":"String", "documentation":"A token for pagination.
" } } }, "ListAcmeExternalAccountBindingsRequest":{ "type":"structure", "required":["AcmeEndpointArn"], "members":{ "NextToken":{ "shape":"String", "documentation":"A token for pagination.
" }, "MaxResults":{ "shape":"ListAcmeExternalAccountBindingsRequestMaxResultsInteger", "documentation":"The maximum number of results to return.
" }, "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" } } }, "ListAcmeExternalAccountBindingsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListAcmeExternalAccountBindingsResponse":{ "type":"structure", "members":{ "ExternalAccountBindings":{ "shape":"AcmeExternalAccountBindingList", "documentation":"The list of external account bindings.
" }, "NextToken":{ "shape":"String", "documentation":"A token for pagination.
" } } }, "ListCertificateDomainValidationsRequest":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"CertificateArn", "documentation":"The Amazon Resource Name (ARN) of the certificate for which to list domain validation summaries.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token returned by a previous call to ListCertificateDomainValidations. If the number of results exceeds MaxItems, use this token to retrieve the next page of results.
The maximum number of domain validation summaries to return. If you don't specify a value, the default is 1000.
" } } }, "ListCertificateDomainValidationsResponse":{ "type":"structure", "members":{ "DomainValidationSummaryList":{ "shape":"DomainValidationSummaryList", "documentation":"A list of DomainValidationSummary objects, one for each domain on the certificate. Each object contains the domain name and its active and requested validation configurations.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the number of results exceeds MaxItems, this token is included in the response. Use this token in a subsequent ListCertificateDomainValidations request to retrieve the next page of results.
Filter the certificate list by status value.
" }, "CertificateKeyPairOrigins":{ "shape":"CertificateKeyPairOrigins", "documentation":"Filter the certificate list by certificate key pair origin. Specify one or more CertificateKeyPairOrigin values. Default filtering returns only certificates with key pair origin of AWS_MANAGED and CUSTOMER_PROVIDED.
Filter the certificate list. For more information, see the Filters structure.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
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.
Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.
Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.
When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.
A list of ACM certificates.
" } } }, "ListTagsForCertificateRequest":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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).
" } } }, "ListTagsForCertificateResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"The key-value pairs that define the applied tags.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"The ARN of the ACM resource for which to list tags.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"The tags associated with the resource.
" } } }, "MacKey":{ "type":"string", "sensitive":true }, "MaxItems":{ "type":"integer", "box":true, "max":1000, "min":1 }, "NextToken":{ "type":"string", "max":10000, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*" }, "NullableBoolean":{ "type":"boolean", "box":true }, "OtherName":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"String", "documentation":"Specifies an OID.
" }, "Value":{ "shape":"String", "documentation":"Specifies an OID value.
" } }, "documentation":"Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID) and value. For more information, see NIST's definition of Object Identifier (OID).
DNS-based prevalidation details.
" } }, "documentation":"Contains details about the prevalidation configuration.
", "union":true }, "PrevalidationOptions":{ "type":"structure", "members":{ "DnsPrevalidation":{ "shape":"DnsPrevalidationOptions", "documentation":"DNS-based prevalidation options.
" } }, "documentation":"Specifies prevalidation options for domain validation.
", "union":true }, "PrevalidationType":{ "type":"string", "enum":["DNS_PREVALIDATION"] }, "PrivateKey":{ "type":"string", "max":524288, "min":1, "pattern":"-{5}BEGIN PRIVATE KEY-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END PRIVATE KEY-{5}(\\u000D?\\u000A)?", "sensitive":true }, "PrivateKeyBlob":{ "type":"blob", "max":5120, "min":1, "sensitive":true }, "PublicCertificateAuthority":{ "type":"structure", "members":{ "AllowedKeyAlgorithms":{ "shape":"PublicKeyAlgorithmList", "documentation":"The key algorithms allowed for certificates issued by this certificate authority.
" } }, "documentation":"Configuration for a public certificate authority.
" }, "PublicKeyAlgorithm":{ "type":"string", "enum":[ "RSA_2048", "EC_prime256v1", "EC_secp384r1" ] }, "PublicKeyAlgorithmList":{ "type":"list", "member":{"shape":"PublicKeyAlgorithm"} }, "PutAccountConfigurationRequest":{ "type":"structure", "required":["IdempotencyToken"], "members":{ "ExpiryEvents":{ "shape":"ExpiryEventsConfiguration", "documentation":"Specifies expiration events associated with an account.
" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"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.
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":{ "shape":"TagList", "documentation":"The key-value pair that defines the tag to remove.
" } } }, "RenewCertificateRequest":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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).
" } } }, "RenewalEligibility":{ "type":"string", "enum":[ "ELIGIBLE", "INELIGIBLE" ] }, "RenewalStatus":{ "type":"string", "enum":[ "PENDING_AUTO_RENEWAL", "PENDING_VALIDATION", "SUCCESS", "FAILED" ] }, "RenewalSummary":{ "type":"structure", "required":[ "RenewalStatus", "DomainValidationOptions", "UpdatedAt" ], "members":{ "RenewalStatus":{ "shape":"RenewalStatus", "documentation":"The status of ACM's managed renewal of the certificate.
" }, "DomainValidationOptions":{ "shape":"DomainValidationList", "documentation":"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.
The reason that a renewal request was unsuccessful.
" }, "UpdatedAt":{ "shape":"TStamp", "documentation":"The time at which the renewal summary was last updated.
" } }, "documentation":"Contains information about the status of ACM's managed renewal for the certificate. This structure exists only when the certificate type is AMAZON_ISSUED.
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.
" }, "ValidationMethod":{ "shape":"ValidationMethod", "documentation":"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.
" }, "SubjectAlternativeNames":{ "shape":"DomainList", "documentation":"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.
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.
The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
" }, "Options":{ "shape":"CertificateOptions", "documentation":"You can use this parameter to specify whether to export your certificate.
Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log. For more information, see Certificate Transparency Logging.
You can export public ACM certificates to use with Amazon Web Services services as well as outside the Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate.
" }, "CertificateAuthorityArn":{ "shape":"PcaArn", "documentation":"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
One or more resource tags to associate with the certificate.
" }, "KeyAlgorithm":{ "shape":"KeyAlgorithm", "documentation":"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":{ "shape":"CertificateManagedBy", "documentation":"Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" } } }, "RequestCertificateResponse":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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
The certificate request is in process and the certificate in your account has not yet been issued.
", "exception":true }, "ResendValidationEmailRequest":{ "type":"structure", "required":[ "CertificateArn", "Domain", "ValidationDomain" ], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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
The fully qualified domain name (FQDN) of the certificate that needs to be validated.
" }, "ValidationDomain":{ "shape":"DomainNameString", "documentation":"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 the following five addresses:
admin@subdomain.example.com
administrator@subdomain.example.com
hostmaster@subdomain.example.com
postmaster@subdomain.example.com
webmaster@subdomain.example.com
The certificate is in use by another Amazon Web Services service in the caller's account. Remove the association and try again.
", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The specified certificate cannot be found in the caller's account or the caller's account cannot be found.
", "exception":true }, "ResourceRecord":{ "type":"structure", "required":[ "Name", "Type", "Value" ], "members":{ "Name":{ "shape":"String", "documentation":"The name of the DNS record to create in your domain. This is supplied by ACM.
" }, "Type":{ "shape":"RecordType", "documentation":"The type of DNS record. Currently this can be CNAME.
The value of the CNAME record to add to your DNS database. This is supplied by ACM.
" } }, "documentation":"Contains a DNS record value that you can use to validate ownership or control of a domain. This is used by the DescribeCertificate action.
" }, "RevocationReason":{ "type":"string", "enum":[ "UNSPECIFIED", "KEY_COMPROMISE", "CA_COMPROMISE", "AFFILIATION_CHANGED", "SUPERCEDED", "SUPERSEDED", "CESSATION_OF_OPERATION", "CERTIFICATE_HOLD", "REMOVE_FROM_CRL", "PRIVILEGE_WITHDRAWN", "A_A_COMPROMISE" ] }, "RevokeAcmeAccountRequest":{ "type":"structure", "required":[ "AcmeEndpointArn", "AccountUrl" ], "members":{ "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint.
" }, "AccountUrl":{ "shape":"String", "documentation":"The URL of the ACME account to revoke.
" } } }, "RevokeAcmeExternalAccountBindingRequest":{ "type":"structure", "required":["AcmeExternalAccountBindingArn"], "members":{ "AcmeExternalAccountBindingArn":{ "shape":"AcmeExternalAccountBindingArn", "documentation":"The Amazon Resource Name (ARN) of the ACME external account binding to revoke.
" } } }, "RevokeCertificateRequest":{ "type":"structure", "required":[ "CertificateArn", "RevocationReason" ], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the public or private certificate that will be revoked. The ARN must have the following form:
arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012
Specifies why you revoked the certificate.
" } } }, "RevokeCertificateResponse":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the public or private certificate that was revoked.
" } } }, "RoleArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws[a-z-]*:iam::[0-9]{12}:role/.+" }, "SearchCertificatesRequest":{ "type":"structure", "members":{ "FilterStatement":{ "shape":"CertificateFilterStatement", "documentation":"A filter statement that defines the search criteria. You can combine multiple filters using AND, OR, and NOT logical operators to create complex queries.
" }, "MaxResults":{ "shape":"SearchMaxResults", "documentation":"The maximum number of results to return in the response. Default is 100.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
Specifies the field to sort results by. Valid values are CREATED_AT, NOT_AFTER, STATUS, RENEWAL_STATUS, EXPORTED, IN_USE, NOT_BEFORE, KEY_ALGORITHM, TYPE, CERTIFICATE_ARN, COMMON_NAME, REVOKED_AT, RENEWAL_ELIGIBILITY, ISSUED_AT, MANAGED_BY, EXPORT_OPTION, VALIDATION_METHOD, and IMPORTED_AT.
" }, "SortOrder":{ "shape":"SearchCertificatesSortOrder", "documentation":"Specifies the order of sorted results. Valid values are ASCENDING or DESCENDING.
" } } }, "SearchCertificatesResponse":{ "type":"structure", "members":{ "Results":{ "shape":"CertificateSearchResultList", "documentation":"A list of certificate search results containing certificate ARNs, X.509 attributes, and ACM metadata.
" }, "NextToken":{ "shape":"NextToken", "documentation":"When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.
The field to sort search results by.
", "enum":[ "CREATED_AT", "NOT_AFTER", "STATUS", "RENEWAL_STATUS", "EXPORTED", "IN_USE", "NOT_BEFORE", "KEY_ALGORITHM", "TYPE", "CERTIFICATE_ARN", "COMMON_NAME", "REVOKED_AT", "RENEWAL_ELIGIBILITY", "ISSUED_AT", "MANAGED_BY", "EXPORT_OPTION", "VALIDATION_METHOD", "IMPORTED_AT", "ACME_ENDPOINT_ARN", "ACME_ACCOUNT_ID", "CERTIFICATE_KEY_PAIR_ORIGIN" ] }, "SearchCertificatesSortOrder":{ "type":"string", "documentation":"The order to sort search results.
", "enum":[ "ASCENDING", "DESCENDING" ] }, "SearchMaxResults":{ "type":"integer", "box":true, "max":500, "min":1 }, "SerialNumber":{ "type":"string", "max":59, "min":2, "pattern":"[0-9a-f]{2}(:[0-9a-f]{2}){1,19}" }, "ServiceErrorMessage":{"type":"string"}, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"A service quota has been exceeded.
", "exception":true }, "SortBy":{ "type":"string", "enum":["CREATED_AT"] }, "SortOrder":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "String":{"type":"string"}, "SubjectAlternativeNameFilter":{ "type":"structure", "members":{ "DnsName":{ "shape":"DnsNameFilter", "documentation":"Filter by DNS name in subject alternative names.
" } }, "documentation":"Filters certificates by subject alternative name attributes.
", "union":true }, "SubjectFilter":{ "type":"structure", "members":{ "CommonName":{ "shape":"CommonNameFilter", "documentation":"Filter by common name in the subject.
" } }, "documentation":"Filters certificates by subject attributes.
", "union":true }, "TStamp":{"type":"timestamp"}, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"The key of the tag.
" }, "Value":{ "shape":"TagValue", "documentation":"The value of the tag.
" } }, "documentation":"A key-value pair that identifies or specifies metadata about an ACM resource.
" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":1 }, "TagPolicyException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"A specified tag did not comply with an existing tag policy and was rejected.
", "exception":true }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"The ARN of the ACM resource to which the tag is to be applied.
" }, "Tags":{ "shape":"TagList", "documentation":"The key-value pair that defines the tag to apply.
" } } }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"AvailabilityErrorMessage"}, "throttlingReasons":{ "shape":"ThrottlingReasonList", "documentation":"One or more reasons why the request was throttled.
" } }, "documentation":"The request was denied because it exceeded a quota.
", "exception":true }, "ThrottlingReason":{ "type":"structure", "members":{ "reason":{ "shape":"CoralAvailabilityThrottlingReason", "documentation":"A description of why a request was throttled.
" }, "resource":{ "shape":"CoralAvailabilityThrottledResource", "documentation":"The resource that causes the request to be throttled.
" } }, "documentation":"A description of why a request was throttled.
" }, "ThrottlingReasonList":{ "type":"list", "member":{"shape":"ThrottlingReason"} }, "TimeType":{ "type":"string", "enum":[ "MINUTES", "HOURS", "DAYS" ] }, "Timestamp":{"type":"timestamp"}, "TimestampRange":{ "type":"structure", "members":{ "Start":{ "shape":"TStamp", "documentation":"The start of the time range. This value is inclusive.
" }, "End":{ "shape":"TStamp", "documentation":"The end of the time range. This value is inclusive.
" } }, "documentation":"Specifies a time range for filtering certificates.
" }, "TooManyTagsException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The request contains too many tags. Try the request again with fewer tags.
", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"The ARN of the ACM resource from which the tag is to be removed.
" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"The key of each tag to remove.
" } } }, "UpdateAcmeDomainValidationRequest":{ "type":"structure", "required":["AcmeDomainValidationArn"], "members":{ "AcmeDomainValidationArn":{ "shape":"AcmeDomainValidationArn", "documentation":"The Amazon Resource Name (ARN) of the ACME domain validation to update.
" }, "PrevalidationOptions":{ "shape":"PrevalidationOptions", "documentation":"The updated prevalidation options.
" } } }, "UpdateAcmeEndpointRequest":{ "type":"structure", "required":["AcmeEndpointArn"], "members":{ "AcmeEndpointArn":{ "shape":"AcmeEndpointArn", "documentation":"The Amazon Resource Name (ARN) of the ACME endpoint to update.
" }, "AuthorizationBehavior":{ "shape":"AcmeAuthorizationBehavior", "documentation":"The updated authorization behavior.
" }, "Contact":{ "shape":"AcmeContact", "documentation":"The updated contact requirement.
" }, "CertificateAuthority":{ "shape":"CertificateAuthority", "documentation":"The updated certificate authority configuration.
" } } }, "UpdateCertificateOptionsRequest":{ "type":"structure", "required":[ "CertificateArn", "Options" ], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"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
Use to update the options for your certificate. Currently, you can change the domain validation method or specify whether to export your certificate. For more information about migrating from email to DNS validation, see Migrate from email to DNS validation.
" } } }, "UpdateStatus":{ "type":"string", "documentation":"The status of a certificate update. Possible values:
PENDING_DOMAIN_VALIDATION – The update is waiting for domain validation to complete.
SUCCESS – The update completed successfully.
FAILED – The update failed.
The status of the certificate update. The following are valid values:
PENDING_DOMAIN_VALIDATION – The certificate update is waiting for domain ownership validation to complete.
SUCCESS – The certificate was updated successfully.
FAILED – The certificate update failed.
The type of update that was requested for the certificate. The following are valid values:
DOMAIN_VALIDATION_METHOD – The update changes the domain validation method for the certificate.
Contains information about a domain validation method migration, including the previous and target validation methods.
" }, "RequestedAt":{ "shape":"TStamp", "documentation":"The time at which the certificate update was requested.
" }, "UpdatedAt":{ "shape":"TStamp", "documentation":"The time at which the certificate update status was last changed.
" } }, "documentation":"Contains information about the most recent certificate update, such as a domain validation method migration. This structure is returned as part of the CertificateDetail response from DescribeCertificate.
" }, "UpdateType":{ "type":"string", "documentation":"The type of certificate update. Valid values:
DOMAIN_VALIDATION_METHOD – A change to the domain validation method for the certificate.
Contains the challenge details that you use to prove domain ownership. Only one member is set, depending on the validation method.
", "union":true }, "ValidationConfiguration":{ "type":"structure", "members":{ "ValidationMethod":{ "shape":"ValidationMethod", "documentation":"The validation method for this configuration. Valid values:
DNS – Validation using a CNAME record added to your DNS configuration.
EMAIL – Validation using an approval email sent to domain contacts.
HTTP – Validation using an HTTP resource placed on your web server.
The validation challenge details for this configuration. The structure varies by validation method: for DNS validation, contains a DnsValidationChallenge with the CNAME record to add; for email validation, contains an EmailValidationChallenge with the validation email addresses.
The validation status for this domain. Valid values:
PENDING_VALIDATION – The domain is waiting for validation to complete.
SUCCESS – Validation completed successfully.
FAILED – Validation failed.
Contains the validation method, validation status, and validation challenge details for a domain. This structure appears in DomainValidationSummary as both the active and requested validation configuration.
" }, "ValidationEmailList":{ "type":"list", "member":{"shape":"String"} }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"ValidationExceptionMessage"} }, "documentation":"The supplied input failed to satisfy constraints of an Amazon Web Services service.
", "exception":true }, "ValidationExceptionMessage":{"type":"string"}, "ValidationMethod":{ "type":"string", "enum":[ "EMAIL", "DNS", "HTTP" ] }, "X509AttributeFilter":{ "type":"structure", "members":{ "Subject":{ "shape":"SubjectFilter", "documentation":"Filter by certificate subject.
" }, "SubjectAlternativeName":{ "shape":"SubjectAlternativeNameFilter", "documentation":"Filter by subject alternative names.
" }, "ExtendedKeyUsage":{ "shape":"ExtendedKeyUsageName", "documentation":"Filter by extended key usage.
" }, "KeyUsage":{ "shape":"KeyUsageName", "documentation":"Filter by key usage.
" }, "KeyAlgorithm":{ "shape":"KeyAlgorithm", "documentation":"Filter by key algorithm.
" }, "SerialNumber":{ "shape":"SerialNumber", "documentation":"Filter by serial number.
" }, "NotAfter":{ "shape":"TimestampRange", "documentation":"Filter by certificate expiration date. The start date is inclusive.
" }, "NotBefore":{ "shape":"TimestampRange", "documentation":"Filter by certificate validity start date. The start date is inclusive.
" } }, "documentation":"Filters certificates by X.509 attributes.
", "union":true }, "X509Attributes":{ "type":"structure", "members":{ "Issuer":{ "shape":"DistinguishedName", "documentation":"The distinguished name of the certificate issuer.
" }, "Subject":{ "shape":"DistinguishedName", "documentation":"The distinguished name of the certificate subject.
" }, "SubjectAlternativeNames":{ "shape":"GeneralNameList", "documentation":"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.
" }, "ExtendedKeyUsages":{ "shape":"ExtendedKeyUsageNames", "documentation":"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).
" }, "KeyAlgorithm":{ "shape":"KeyAlgorithm", "documentation":"The algorithm that was used to generate the public-private key pair.
" }, "KeyUsages":{ "shape":"KeyUsageNames", "documentation":"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.
" }, "SerialNumber":{ "shape":"SerialNumber", "documentation":"The serial number assigned by the certificate authority.
" }, "NotAfter":{ "shape":"TStamp", "documentation":"The time after which the certificate is not valid.
" }, "NotBefore":{ "shape":"TStamp", "documentation":"The time before which the certificate is not valid.
" } }, "documentation":"Contains X.509 certificate attributes extracted from the certificate.
" } }, "documentation":"You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.
", "clientContextParams":{ "ServiceType":{ "documentation":"The service type: ACM or ACM-ACME. Injected via @staticContextParams.", "type":"string" } } }