767 lines
39 KiB
JSON
767 lines
39 KiB
JSON
{
|
|
"version":"2.0",
|
|
"metadata":{
|
|
"apiVersion":"2015-12-08",
|
|
"endpointPrefix":"acm",
|
|
"jsonVersion":"1.1",
|
|
"protocol":"json",
|
|
"serviceAbbreviation":"ACM",
|
|
"serviceFullName":"AWS Certificate Manager",
|
|
"signatureVersion":"v4",
|
|
"targetPrefix":"CertificateManager"
|
|
},
|
|
"operations":{
|
|
"AddTagsToCertificate":{
|
|
"name":"AddTagsToCertificate",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"AddTagsToCertificateRequest"},
|
|
"errors":[
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"InvalidArnException"},
|
|
{"shape":"InvalidTagException"},
|
|
{"shape":"TooManyTagsException"}
|
|
],
|
|
"documentation":"<p>Adds one or more tags to an ACM Certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a <code>key</code> and an optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.</p> <p>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 <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/tags.html\">Tagging ACM Certificates</a>.</p> <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action.</p>"
|
|
},
|
|
"DeleteCertificate":{
|
|
"name":"DeleteCertificate",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteCertificateRequest"},
|
|
"errors":[
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"ResourceInUseException"},
|
|
{"shape":"InvalidArnException"}
|
|
],
|
|
"documentation":"<p>Deletes an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by other AWS services.</p> <note> <p>You cannot delete an ACM Certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.</p> </note>"
|
|
},
|
|
"DescribeCertificate":{
|
|
"name":"DescribeCertificate",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeCertificateRequest"},
|
|
"output":{"shape":"DescribeCertificateResponse"},
|
|
"errors":[
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"InvalidArnException"}
|
|
],
|
|
"documentation":"<p>Returns a list of the fields contained in the specified ACM Certificate. For example, this action returns the certificate status, a flag that indicates whether the certificate is associated with any other AWS service, and the date at which the certificate request was created. You specify the ACM Certificate on input by its Amazon Resource Name (ARN).</p>"
|
|
},
|
|
"GetCertificate":{
|
|
"name":"GetCertificate",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"GetCertificateRequest"},
|
|
"output":{"shape":"GetCertificateResponse"},
|
|
"errors":[
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"RequestInProgressException"},
|
|
{"shape":"InvalidArnException"}
|
|
],
|
|
"documentation":"<p>Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL.</p> <note> <p>Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.</p> </note>"
|
|
},
|
|
"ImportCertificate":{
|
|
"name":"ImportCertificate",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"ImportCertificateRequest"},
|
|
"output":{"shape":"ImportCertificateResponse"},
|
|
"errors":[
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"LimitExceededException"}
|
|
],
|
|
"documentation":"<p>Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">ACM's integrated AWS services</a>.</p> <note> <p>ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>.</p> <p>To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate.</p> <p>The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html#import-certificate-troubleshooting\">Importing Certificates Troubleshooting</a> in the <i>AWS Certificate Manager User Guide</i>.</p> <p>To import a new certificate, omit the <code>CertificateArn</code> field. Include this field only when you want to replace a previously imported certificate.</p> <p>This operation returns the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>"
|
|
},
|
|
"ListCertificates":{
|
|
"name":"ListCertificates",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"ListCertificatesRequest"},
|
|
"output":{"shape":"ListCertificatesResponse"},
|
|
"documentation":"<p>Retrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.</p>"
|
|
},
|
|
"ListTagsForCertificate":{
|
|
"name":"ListTagsForCertificate",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"ListTagsForCertificateRequest"},
|
|
"output":{"shape":"ListTagsForCertificateResponse"},
|
|
"errors":[
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"InvalidArnException"}
|
|
],
|
|
"documentation":"<p>Lists the tags that have been applied to the ACM Certificate. Use the certificate ARN to specify the certificate. To add a tag to an ACM Certificate, use the <a>AddTagsToCertificate</a> action. To delete a tag, use the <a>RemoveTagsFromCertificate</a> action.</p>"
|
|
},
|
|
"RemoveTagsFromCertificate":{
|
|
"name":"RemoveTagsFromCertificate",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"RemoveTagsFromCertificateRequest"},
|
|
"errors":[
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"InvalidArnException"},
|
|
{"shape":"InvalidTagException"}
|
|
],
|
|
"documentation":"<p>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.</p> <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To view all of the tags that have been applied to a specific ACM Certificate, use the <a>ListTagsForCertificate</a> action.</p>"
|
|
},
|
|
"RequestCertificate":{
|
|
"name":"RequestCertificate",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"RequestCertificateRequest"},
|
|
"output":{"shape":"RequestCertificateResponse"},
|
|
"errors":[
|
|
{"shape":"LimitExceededException"},
|
|
{"shape":"InvalidDomainValidationOptionsException"}
|
|
],
|
|
"documentation":"<p>Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site. You can also specify additional FQDNs if users can reach your site by using other names. For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\">AWS Certificate Manager User Guide</a>.</p>"
|
|
},
|
|
"ResendValidationEmail":{
|
|
"name":"ResendValidationEmail",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"ResendValidationEmailRequest"},
|
|
"errors":[
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"InvalidStateException"},
|
|
{"shape":"InvalidArnException"},
|
|
{"shape":"InvalidDomainValidationOptionsException"}
|
|
],
|
|
"documentation":"<p>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 <b>I Approve</b>. 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.</p>"
|
|
}
|
|
},
|
|
"shapes":{
|
|
"AddTagsToCertificateRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"CertificateArn",
|
|
"Tags"
|
|
],
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>String that contains the ARN of the ACM Certificate to which the tag is to be applied. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
|
},
|
|
"Tags":{
|
|
"shape":"TagList",
|
|
"documentation":"<p>The key-value pair that defines the tag. The tag value is optional.</p>"
|
|
}
|
|
}
|
|
},
|
|
"Arn":{
|
|
"type":"string",
|
|
"max":2048,
|
|
"min":20,
|
|
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*"
|
|
},
|
|
"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":"<p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>"
|
|
},
|
|
"DomainName":{
|
|
"shape":"DomainNameString",
|
|
"documentation":"<p>The fully qualified domain name for the certificate, such as www.example.com or example.com.</p>"
|
|
},
|
|
"SubjectAlternativeNames":{
|
|
"shape":"DomainList",
|
|
"documentation":"<p>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.</p>"
|
|
},
|
|
"DomainValidationOptions":{
|
|
"shape":"DomainValidationList",
|
|
"documentation":"<p>Contains information about the email address or addresses used for domain validation. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
|
|
},
|
|
"Serial":{
|
|
"shape":"String",
|
|
"documentation":"<p>The serial number of the certificate.</p>"
|
|
},
|
|
"Subject":{
|
|
"shape":"String",
|
|
"documentation":"<p>The name of the entity that is associated with the public key contained in the certificate.</p>"
|
|
},
|
|
"Issuer":{
|
|
"shape":"String",
|
|
"documentation":"<p>The name of the certificate authority that issued and signed the certificate.</p>"
|
|
},
|
|
"CreatedAt":{
|
|
"shape":"TStamp",
|
|
"documentation":"<p>The time at which the certificate was requested. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
|
|
},
|
|
"IssuedAt":{
|
|
"shape":"TStamp",
|
|
"documentation":"<p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
|
|
},
|
|
"ImportedAt":{
|
|
"shape":"TStamp",
|
|
"documentation":"<p>The date and time at which the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>.</p>"
|
|
},
|
|
"Status":{
|
|
"shape":"CertificateStatus",
|
|
"documentation":"<p>The status of the certificate.</p>"
|
|
},
|
|
"RevokedAt":{
|
|
"shape":"TStamp",
|
|
"documentation":"<p>The time at which the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>.</p>"
|
|
},
|
|
"RevocationReason":{
|
|
"shape":"RevocationReason",
|
|
"documentation":"<p>The reason the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>.</p>"
|
|
},
|
|
"NotBefore":{
|
|
"shape":"TStamp",
|
|
"documentation":"<p>The time before which the certificate is not valid.</p>"
|
|
},
|
|
"NotAfter":{
|
|
"shape":"TStamp",
|
|
"documentation":"<p>The time after which the certificate is not valid.</p>"
|
|
},
|
|
"KeyAlgorithm":{
|
|
"shape":"KeyAlgorithm",
|
|
"documentation":"<p>The algorithm that was used to generate the key pair (the public and private key).</p>"
|
|
},
|
|
"SignatureAlgorithm":{
|
|
"shape":"String",
|
|
"documentation":"<p>The algorithm that was used to sign the certificate.</p>"
|
|
},
|
|
"InUseBy":{
|
|
"shape":"InUseList",
|
|
"documentation":"<p>A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.</p>"
|
|
},
|
|
"FailureReason":{
|
|
"shape":"FailureReason",
|
|
"documentation":"<p>The reason the certificate request failed. This value exists only when the certificate status is <code>FAILED</code>. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed\">Certificate Request Failed</a> in the <i>AWS Certificate Manager User Guide</i>.</p>"
|
|
},
|
|
"Type":{
|
|
"shape":"CertificateType",
|
|
"documentation":"<p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Contains detailed metadata about an ACM Certificate. This structure is returned in the response to a <a>DescribeCertificate</a> request.</p>"
|
|
},
|
|
"CertificateStatus":{
|
|
"type":"string",
|
|
"enum":[
|
|
"PENDING_VALIDATION",
|
|
"ISSUED",
|
|
"INACTIVE",
|
|
"EXPIRED",
|
|
"VALIDATION_TIMED_OUT",
|
|
"REVOKED",
|
|
"FAILED"
|
|
]
|
|
},
|
|
"CertificateStatuses":{
|
|
"type":"list",
|
|
"member":{"shape":"CertificateStatus"}
|
|
},
|
|
"CertificateSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
|
},
|
|
"DomainName":{
|
|
"shape":"DomainNameString",
|
|
"documentation":"<p>Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>This structure is returned in the response object of <a>ListCertificates</a> action.</p>"
|
|
},
|
|
"CertificateSummaryList":{
|
|
"type":"list",
|
|
"member":{"shape":"CertificateSummary"}
|
|
},
|
|
"CertificateType":{
|
|
"type":"string",
|
|
"enum":[
|
|
"IMPORTED",
|
|
"AMAZON_ISSUED"
|
|
]
|
|
},
|
|
"DeleteCertificateRequest":{
|
|
"type":"structure",
|
|
"required":["CertificateArn"],
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>String that contains the ARN of the ACM Certificate to be deleted. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeCertificateRequest":{
|
|
"type":"structure",
|
|
"required":["CertificateArn"],
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>String that contains an ACM Certificate ARN. The ARN must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeCertificateResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Certificate":{
|
|
"shape":"CertificateDetail",
|
|
"documentation":"<p>Contains a <a>CertificateDetail</a> structure that lists the fields of an ACM Certificate.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DomainList":{
|
|
"type":"list",
|
|
"member":{"shape":"DomainNameString"},
|
|
"max":100,
|
|
"min":1
|
|
},
|
|
"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])$"
|
|
},
|
|
"DomainValidation":{
|
|
"type":"structure",
|
|
"required":["DomainName"],
|
|
"members":{
|
|
"DomainName":{
|
|
"shape":"DomainNameString",
|
|
"documentation":"<p>Fully Qualified Domain Name (FQDN) of the form <code>www.example.com or </code> <code>example.com</code>.</p>"
|
|
},
|
|
"ValidationEmails":{
|
|
"shape":"ValidationEmailList",
|
|
"documentation":"<p>A list of contact address for the domain registrant.</p>"
|
|
},
|
|
"ValidationDomain":{
|
|
"shape":"DomainNameString",
|
|
"documentation":"<p>The base validation domain that acts as the suffix of the email addresses that are used to send the emails.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Structure that contains the domain name, the base validation domain to which validation email is sent, and the email addresses used to validate the domain identity.</p>"
|
|
},
|
|
"DomainValidationList":{
|
|
"type":"list",
|
|
"member":{"shape":"DomainValidation"},
|
|
"max":1000,
|
|
"min":1
|
|
},
|
|
"DomainValidationOption":{
|
|
"type":"structure",
|
|
"required":[
|
|
"DomainName",
|
|
"ValidationDomain"
|
|
],
|
|
"members":{
|
|
"DomainName":{
|
|
"shape":"DomainNameString",
|
|
"documentation":"<p>Fully Qualified Domain Name (FQDN) of the certificate being requested.</p>"
|
|
},
|
|
"ValidationDomain":{
|
|
"shape":"DomainNameString",
|
|
"documentation":"<p>The domain to which validation email is sent. This is the base validation domain that will act as the suffix of the email addresses. This must be the same as the <code>DomainName</code> value or a superdomain of the <code>DomainName</code> value. For example, if you requested a certificate for <code>site.subdomain.example.com</code> and specify a <b>ValidationDomain</b> of <code>subdomain.example.com</code>, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS for the base domain and the following five addresses:</p> <ul> <li> <p>admin@subdomain.example.com</p> </li> <li> <p>administrator@subdomain.example.com</p> </li> <li> <p>hostmaster@subdomain.example.com</p> </li> <li> <p>postmaster@subdomain.example.com</p> </li> <li> <p>webmaster@subdomain.example.com</p> </li> </ul>"
|
|
}
|
|
},
|
|
"documentation":"<p>This structure is used in the request object of the <a>RequestCertificate</a> action.</p>"
|
|
},
|
|
"DomainValidationOptionList":{
|
|
"type":"list",
|
|
"member":{"shape":"DomainValidationOption"},
|
|
"max":100,
|
|
"min":1
|
|
},
|
|
"FailureReason":{
|
|
"type":"string",
|
|
"enum":[
|
|
"NO_AVAILABLE_CONTACTS",
|
|
"ADDITIONAL_VERIFICATION_REQUIRED",
|
|
"DOMAIN_NOT_ALLOWED",
|
|
"INVALID_PUBLIC_DOMAIN",
|
|
"OTHER"
|
|
]
|
|
},
|
|
"GetCertificateRequest":{
|
|
"type":"structure",
|
|
"required":["CertificateArn"],
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>String that contains a certificate ARN in the following format:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetCertificateResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Certificate":{
|
|
"shape":"CertificateBody",
|
|
"documentation":"<p>String that contains the ACM Certificate represented by the ARN specified at input.</p>"
|
|
},
|
|
"CertificateChain":{
|
|
"shape":"CertificateChain",
|
|
"documentation":"<p>The certificate chain that contains the root certificate issued by the certificate authority (CA).</p>"
|
|
}
|
|
}
|
|
},
|
|
"IdempotencyToken":{
|
|
"type":"string",
|
|
"max":32,
|
|
"min":1,
|
|
"pattern":"\\w+"
|
|
},
|
|
"ImportCertificateRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"Certificate",
|
|
"PrivateKey"
|
|
],
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this field.</p>"
|
|
},
|
|
"Certificate":{
|
|
"shape":"CertificateBodyBlob",
|
|
"documentation":"<p>The certificate to import. It must meet the following requirements:</p> <ul> <li> <p>Must be PEM-encoded.</p> </li> <li> <p>Must contain a 1024-bit or 2048-bit RSA public key.</p> </li> <li> <p>Must be valid at the time of import. You cannot import a certificate before its validity period begins (the certificate's <code>NotBefore</code> date) or after it expires (the certificate's <code>NotAfter</code> date).</p> </li> </ul>"
|
|
},
|
|
"PrivateKey":{
|
|
"shape":"PrivateKeyBlob",
|
|
"documentation":"<p>The private key that matches the public key in the certificate. It must meet the following requirements:</p> <ul> <li> <p>Must be PEM-encoded.</p> </li> <li> <p>Must be unencrypted. You cannot import a private key that is protected by a password or passphrase.</p> </li> </ul>"
|
|
},
|
|
"CertificateChain":{
|
|
"shape":"CertificateChainBlob",
|
|
"documentation":"<p>The certificate chain. It must be PEM-encoded.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ImportCertificateResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>"
|
|
}
|
|
}
|
|
},
|
|
"InUseList":{
|
|
"type":"list",
|
|
"member":{"shape":"String"}
|
|
},
|
|
"InvalidArnException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"String"}
|
|
},
|
|
"documentation":"<p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>",
|
|
"exception":true
|
|
},
|
|
"InvalidDomainValidationOptionsException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"String"}
|
|
},
|
|
"documentation":"<p>One or more values in the <a>DomainValidationOption</a> structure is incorrect.</p>",
|
|
"exception":true
|
|
},
|
|
"InvalidStateException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"String"}
|
|
},
|
|
"documentation":"<p>Processing has reached an invalid state. For example, this exception can occur if the specified domain is not using email validation, or the current certificate status does not permit the requested operation. See the exception message returned by ACM to determine which state is not valid.</p>",
|
|
"exception":true
|
|
},
|
|
"InvalidTagException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"String"}
|
|
},
|
|
"documentation":"<p>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 <code>aws:</code>.</p>",
|
|
"exception":true
|
|
},
|
|
"KeyAlgorithm":{
|
|
"type":"string",
|
|
"enum":[
|
|
"RSA_2048",
|
|
"RSA_1024",
|
|
"EC_prime256v1"
|
|
]
|
|
},
|
|
"LimitExceededException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"String"}
|
|
},
|
|
"documentation":"<p>An ACM limit has been exceeded. For example, you may have input more domains than are allowed or you've requested too many certificates for your account. See the exception message returned by ACM to determine which limit you have violated. For more information about ACM limits, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Limits</a> topic.</p>",
|
|
"exception":true
|
|
},
|
|
"ListCertificatesRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"CertificateStatuses":{
|
|
"shape":"CertificateStatuses",
|
|
"documentation":"<p>The status or statuses on which to filter the list of ACM Certificates.</p>"
|
|
},
|
|
"NextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>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 <code>NextToken</code> from the response you just received.</p>"
|
|
},
|
|
"MaxItems":{
|
|
"shape":"MaxItems",
|
|
"documentation":"<p>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 <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListCertificatesResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"NextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>When the list is truncated, this value is present and contains the value to use for the <code>NextToken</code> parameter in a subsequent pagination request.</p>"
|
|
},
|
|
"CertificateSummaryList":{
|
|
"shape":"CertificateSummaryList",
|
|
"documentation":"<p>A list of ACM Certificates.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListTagsForCertificateRequest":{
|
|
"type":"structure",
|
|
"required":["CertificateArn"],
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>String that contains the ARN of the ACM Certificate for which you want to list the tags. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListTagsForCertificateResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Tags":{
|
|
"shape":"TagList",
|
|
"documentation":"<p>The key-value pairs that define the applied tags.</p>"
|
|
}
|
|
}
|
|
},
|
|
"MaxItems":{
|
|
"type":"integer",
|
|
"max":1000,
|
|
"min":1
|
|
},
|
|
"NextToken":{
|
|
"type":"string",
|
|
"max":320,
|
|
"min":1,
|
|
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
|
|
},
|
|
"PrivateKeyBlob":{
|
|
"type":"blob",
|
|
"max":524288,
|
|
"min":1,
|
|
"sensitive":true
|
|
},
|
|
"RemoveTagsFromCertificateRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"CertificateArn",
|
|
"Tags"
|
|
],
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>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:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
|
},
|
|
"Tags":{
|
|
"shape":"TagList",
|
|
"documentation":"<p>The key-value pair that defines the tag to remove.</p>"
|
|
}
|
|
}
|
|
},
|
|
"RequestCertificateRequest":{
|
|
"type":"structure",
|
|
"required":["DomainName"],
|
|
"members":{
|
|
"DomainName":{
|
|
"shape":"DomainNameString",
|
|
"documentation":"<p>Fully qualified domain name (FQDN), such as www.example.com, of the site 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.</p>"
|
|
},
|
|
"SubjectAlternativeNames":{
|
|
"shape":"DomainList",
|
|
"documentation":"<p>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 <code>DomainName</code> field is www.example.com if users can reach your site by using either name.</p>"
|
|
},
|
|
"IdempotencyToken":{
|
|
"shape":"IdempotencyToken",
|
|
"documentation":"<p>Customer chosen string that can be used to distinguish between calls to <code>RequestCertificate</code>. Idempotency tokens time out after one hour. Therefore, if you call <code>RequestCertificate</code> 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.</p>"
|
|
},
|
|
"DomainValidationOptions":{
|
|
"shape":"DomainValidationOptionList",
|
|
"documentation":"<p>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 <code>Domain</code> value or a superdomain of the <code>Domain</code> value. For example, if you requested a certificate for <code>test.example.com</code> and specify <b>DomainValidationOptions</b> of <code>example.com</code>, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:</p> <ul> <li> <p>admin@example.com</p> </li> <li> <p>administrator@example.com</p> </li> <li> <p>hostmaster@example.com</p> </li> <li> <p>postmaster@example.com</p> </li> <li> <p>webmaster@example.com</p> </li> </ul>"
|
|
}
|
|
}
|
|
},
|
|
"RequestCertificateResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>String that contains the ARN of the issued certificate. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>"
|
|
}
|
|
}
|
|
},
|
|
"RequestInProgressException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"String"}
|
|
},
|
|
"documentation":"<p>The certificate request is in process and the certificate in your account has not yet been issued.</p>",
|
|
"exception":true
|
|
},
|
|
"ResendValidationEmailRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"CertificateArn",
|
|
"Domain",
|
|
"ValidationDomain"
|
|
],
|
|
"members":{
|
|
"CertificateArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the <a>RequestCertificate</a> 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.</p> <p>The ARN must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>"
|
|
},
|
|
"Domain":{
|
|
"shape":"DomainNameString",
|
|
"documentation":"<p>The Fully Qualified Domain Name (FQDN) of the certificate that needs to be validated.</p>"
|
|
},
|
|
"ValidationDomain":{
|
|
"shape":"DomainNameString",
|
|
"documentation":"<p>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 <code>Domain</code> value or a superdomain of the <code>Domain</code> value. For example, if you requested a certificate for <code>site.subdomain.example.com</code> and specify a <b>ValidationDomain</b> of <code>subdomain.example.com</code>, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:</p> <ul> <li> <p>admin@subdomain.example.com</p> </li> <li> <p>administrator@subdomain.example.com</p> </li> <li> <p>hostmaster@subdomain.example.com</p> </li> <li> <p>postmaster@subdomain.example.com</p> </li> <li> <p>webmaster@subdomain.example.com</p> </li> </ul>"
|
|
}
|
|
}
|
|
},
|
|
"ResourceInUseException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"String"}
|
|
},
|
|
"documentation":"<p>The certificate is in use by another AWS service in the caller's account. Remove the association and try again.</p>",
|
|
"exception":true
|
|
},
|
|
"ResourceNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"String"}
|
|
},
|
|
"documentation":"<p>The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.</p>",
|
|
"exception":true
|
|
},
|
|
"RevocationReason":{
|
|
"type":"string",
|
|
"enum":[
|
|
"UNSPECIFIED",
|
|
"KEY_COMPROMISE",
|
|
"CA_COMPROMISE",
|
|
"AFFILIATION_CHANGED",
|
|
"SUPERCEDED",
|
|
"CESSATION_OF_OPERATION",
|
|
"CERTIFICATE_HOLD",
|
|
"REMOVE_FROM_CRL",
|
|
"PRIVILEGE_WITHDRAWN",
|
|
"A_A_COMPROMISE"
|
|
]
|
|
},
|
|
"String":{"type":"string"},
|
|
"TStamp":{"type":"timestamp"},
|
|
"Tag":{
|
|
"type":"structure",
|
|
"required":["Key"],
|
|
"members":{
|
|
"Key":{
|
|
"shape":"TagKey",
|
|
"documentation":"<p>The key of the tag.</p>"
|
|
},
|
|
"Value":{
|
|
"shape":"TagValue",
|
|
"documentation":"<p>The value of the tag.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A key-value pair that identifies or specifies metadata about an ACM resource.</p>"
|
|
},
|
|
"TagKey":{
|
|
"type":"string",
|
|
"max":128,
|
|
"min":1,
|
|
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
|
|
},
|
|
"TagList":{
|
|
"type":"list",
|
|
"member":{"shape":"Tag"},
|
|
"max":50,
|
|
"min":1
|
|
},
|
|
"TagValue":{
|
|
"type":"string",
|
|
"max":256,
|
|
"min":0,
|
|
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
|
|
},
|
|
"TooManyTagsException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"String"}
|
|
},
|
|
"documentation":"<p>The request contains too many tags. Try the request again with fewer tags.</p>",
|
|
"exception":true
|
|
},
|
|
"ValidationEmailList":{
|
|
"type":"list",
|
|
"member":{"shape":"String"}
|
|
}
|
|
},
|
|
"documentation":"<fullname>AWS Certificate Manager</fullname> <p>Welcome to the AWS Certificate Manager (ACM) API documentation.</p> <p>You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\"> <i>AWS Certificate Manager User Guide</i> </a>.</p>"
|
|
}
|