You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tools/code-generation/smithy/api-descriptions/acm.json
+84-36
Original file line number
Diff line number
Diff line change
@@ -1,33 +1,5 @@
1
1
{
2
2
"smithy": "2.0",
3
-
"metadata": {
4
-
"suppressions": [
5
-
{
6
-
"id": "HttpMethodSemantics",
7
-
"namespace": "*"
8
-
},
9
-
{
10
-
"id": "HttpResponseCodeSemantics",
11
-
"namespace": "*"
12
-
},
13
-
{
14
-
"id": "PaginatedTrait",
15
-
"namespace": "*"
16
-
},
17
-
{
18
-
"id": "HttpHeaderTrait",
19
-
"namespace": "*"
20
-
},
21
-
{
22
-
"id": "HttpUriConflict",
23
-
"namespace": "*"
24
-
},
25
-
{
26
-
"id": "Service",
27
-
"namespace": "*"
28
-
}
29
-
]
30
-
},
31
3
"shapes": {
32
4
"com.amazonaws.acm#AccessDeniedException": {
33
5
"type": "structure",
@@ -175,6 +147,12 @@
175
147
"smithy.api#documentation": "<p>One or more domain names (subject alternative names) \n included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website. </p>"
"smithy.api#documentation": "<p>Contains metadata about an ACM certificate. This structure is returned in the response\n to a <a>DescribeCertificate</a> request. </p>"
319
297
}
320
298
},
299
+
"com.amazonaws.acm#CertificateManagedBy": {
300
+
"type": "enum",
301
+
"members": {
302
+
"CLOUDFRONT": {
303
+
"target": "smithy.api#Unit",
304
+
"traits": {
305
+
"smithy.api#enumValue": "CLOUDFRONT"
306
+
}
307
+
}
308
+
}
309
+
},
321
310
"com.amazonaws.acm#CertificateManager": {
322
311
"type": "service",
323
312
"version": "2015-12-08",
@@ -371,10 +360,10 @@
371
360
"traits": {
372
361
"aws.api#service": {
373
362
"sdkId": "ACM",
363
+
"endpointPrefix": "acm",
374
364
"arnNamespace": "acm",
375
-
"cloudFormationName": "CertificateManager",
376
365
"cloudTrailEventSource": "acm.amazonaws.com",
377
-
"endpointPrefix": "acm"
366
+
"cloudFormationName": "CertificateManager"
378
367
},
379
368
"aws.auth#sigv4": {
380
369
"name": "acm"
@@ -1473,13 +1462,13 @@
1473
1462
"SubjectAlternativeNameSummaries": {
1474
1463
"target": "com.amazonaws.acm#DomainList",
1475
1464
"traits": {
1476
-
"smithy.api#documentation": "<p>One or more domain names (subject alternative names) \n included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website. </p>\n <p>When called by <a>ListCertificates</a>, this parameter will only return the first 100 subject alternative\n names included in the certificate. To display the full list of subject alternative names, use\n<a>DescribeCertificate</a>.</p>"
1465
+
"smithy.api#documentation": "<p>One or more domain names (subject alternative names) \n included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website. </p>\n <p>When called by <a href=\"https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html\">ListCertificates</a>, this parameter will only return the first 100 subject alternative\n names included in the certificate. To display the full list of subject alternative names, use\n <a href=\"https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html\">DescribeCertificate</a>.</p>"
1477
1466
}
1478
1467
},
1479
1468
"HasAdditionalSubjectAlternativeNames": {
1480
1469
"target": "com.amazonaws.acm#NullableBoolean",
1481
1470
"traits": {
1482
-
"smithy.api#documentation": "<p>When called by <a>ListCertificates</a>, indicates whether the full list of subject alternative names has\n been included in the response. If false, the response includes all of the subject alternative\n names included in the certificate. If true, the response only includes the first 100 subject\n alternative names included in the certificate. To display the full list of subject alternative\n names, use <a>DescribeCertificate</a>.</p>"
1471
+
"smithy.api#documentation": "<p>When called by <a href=\"https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html\">ListCertificates</a>, indicates whether the full list of subject alternative names has\n been included in the response. If false, the response includes all of the subject alternative\n names included in the certificate. If true, the response only includes the first 100 subject\n alternative names included in the certificate. To display the full list of subject alternative\n names, use <a href=\"https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html\">DescribeCertificate</a>.</p>"
1483
1472
}
1484
1473
},
1485
1474
"Status": {
@@ -1565,6 +1554,12 @@
1565
1554
"traits": {
1566
1555
"smithy.api#documentation": "<p>The time at which the certificate was revoked. This value exists only when the certificate\n status is <code>REVOKED</code>. </p>"
"smithy.api#documentation": "<p>Identifies the Amazon Web Services service that manages the certificate issued by ACM.</p>"
1562
+
}
1568
1563
}
1569
1564
},
1570
1565
"traits": {
@@ -1838,13 +1833,19 @@
1838
1833
"ValidationStatus": {
1839
1834
"target": "com.amazonaws.acm#DomainStatus",
1840
1835
"traits": {
1841
-
"smithy.api#documentation": "<p>The validation status of the domain name. This can be one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>PENDING_VALIDATION</code>\n </p>\n </li>\n <li>\n <p>\n <code>SUCCESS</code>\n </p>\n </li>\n <li>\n <p>\n <code>FAILED</code>\n</p>\n </li>\n </ul>"
1836
+
"smithy.api#documentation": "<p>The validation status of the domain name. This can be one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>PENDING_VALIDATION</code>\n </p>\n </li>\n <li>\n <p>\n <code/>SUCCESS</p>\n </li>\n <li>\n <p>\n <code/>FAILED</p>\n </li>\n </ul>"
1842
1837
}
1843
1838
},
1844
1839
"ResourceRecord": {
1845
1840
"target": "com.amazonaws.acm#ResourceRecord",
1846
1841
"traits": {
1847
-
"smithy.api#documentation": "<p>Contains the CNAME record that you add to your DNS database for domain validation. For\n more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html\">Use DNS to Validate Domain Ownership</a>.</p>\n <p>Note: The CNAME information that you need does not include the name of your domain. If you\n include\u2028 your domain name in the DNS database CNAME record, validation fails.\u2028 For example, if\n the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only\n\"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.</p>"
1842
+
"smithy.api#documentation": "<p>Contains the CNAME record that you add to your DNS database for domain validation. For\n more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html\">Use DNS to Validate Domain Ownership</a>.</p>\n <p>Note: The CNAME information that you need does not include the name of your domain. If you\n include your domain name in the DNS database CNAME record, validation fails. For example, if\n the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only\n\"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.</p>"
1843
+
}
1844
+
},
1845
+
"HttpRedirect": {
1846
+
"target": "com.amazonaws.acm#HttpRedirect",
1847
+
"traits": {
1848
+
"smithy.api#documentation": "<p>Contains information for HTTP-based domain validation of certificates requested through CloudFront and issued by ACM.\n This field exists only when the certificate type is <code>AMAZON_ISSUED</code> and the validation method is <code>HTTP</code>.</p>"
1848
1849
}
1849
1850
},
1850
1851
"ValidationMethod": {
@@ -2231,6 +2232,12 @@
2231
2232
"traits": {
2232
2233
"smithy.api#documentation": "<p>Specify one or more algorithms that can be used to generate key pairs.</p>\n <p>Default filtering returns only <code>RSA_1024</code> and <code>RSA_2048</code>\n certificates that have at least one domain. To return other certificate types, provide the\n desired type signatures in a comma-separated list. For example, <code>\"keyTypes\":\n [\"RSA_2048\",\"RSA_4096\"]</code> returns both <code>RSA_2048</code> and <code>RSA_4096</code>\n certificates.</p>"
"smithy.api#documentation": "<p>Identifies the Amazon Web Services service that manages the certificate issued by ACM.</p>"
2240
+
}
2234
2241
}
2235
2242
},
2236
2243
"traits": {
@@ -2344,6 +2351,26 @@
2344
2351
"smithy.api#output": {}
2345
2352
}
2346
2353
},
2354
+
"com.amazonaws.acm#HttpRedirect": {
2355
+
"type": "structure",
2356
+
"members": {
2357
+
"RedirectFrom": {
2358
+
"target": "com.amazonaws.acm#String",
2359
+
"traits": {
2360
+
"smithy.api#documentation": "<p>The URL including the domain to be validated. The certificate authority sends <code>GET</code> requests here during validation.</p>"
2361
+
}
2362
+
},
2363
+
"RedirectTo": {
2364
+
"target": "com.amazonaws.acm#String",
2365
+
"traits": {
2366
+
"smithy.api#documentation": "<p>The URL hosting the validation token. <code>RedirectFrom</code> must return this content or redirect here.</p>"
2367
+
}
2368
+
}
2369
+
},
2370
+
"traits": {
2371
+
"smithy.api#documentation": "<p>Contains information for HTTP-based domain validation of certificates requested through CloudFront and issued by ACM.\n This field exists only when the certificate type is <code>AMAZON_ISSUED</code> and the validation method is <code>HTTP</code>.</p>"
2372
+
}
2373
+
},
2347
2374
"com.amazonaws.acm#IdempotencyToken": {
2348
2375
"type": "string",
2349
2376
"traits": {
@@ -2706,7 +2733,7 @@
2706
2733
}
2707
2734
],
2708
2735
"traits": {
2709
-
"smithy.api#documentation": "<p>Retrieves a list of certificate ARNs and domain names. By default, the API returns RSA_2048 certificates. To return all certificates in the account, include the <code>keyType</code> filter with the values <code>[RSA_1024, RSA_2048, RSA_3072, RSA_4096, EC_prime256v1, EC_secp384r1, EC_secp521r1]</code>.</p>\n <p>In addition to <code>keyType</code>, you can also filter by the <code>CertificateStatuses</code>, <code>keyUsage</code>, and <code>extendedKeyUsage</code> attributes on the certificate. For more information, see <a>Filters</a>.</p>",
2736
+
"smithy.api#documentation": "<p>Retrieves a list of certificate ARNs and domain names. You can request that only\n certificates that match a specific status be listed. You can also filter by specific\nattributes of the certificate. Default filtering returns only <code>RSA_2048</code>\n certificates. For more information, see <a>Filters</a>.</p>",
"smithy.api#documentation": "<p>Specifies the algorithm of the public and private key pair that your certificate uses to\n encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital\n Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but\n with greater computing efficiency. However, ECDSA is not supported by all network clients.\n Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size,\n while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not\n broken. Check the requirements for the Amazon Web Services service where you plan to deploy your\n certificate. For more information about selecting an algorithm, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms\">Key\n algorithms</a>.</p>\n <note>\n <p>Algorithms supported for an ACM certificate request include: </p>\n <ul>\n <li>\n <p>\n <code>RSA_2048</code>\n </p>\n </li>\n <li>\n <p>\n <code>EC_prime256v1</code>\n </p>\n </li>\n <li>\n <p>\n <code>EC_secp384r1</code>\n </p>\n </li>\n </ul>\n <p>Other listed algorithms are for imported certificates only. </p>\n </note>\n <note>\n <p>When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the\n specified signing algorithm family (RSA or ECDSA) must match the algorithm family of\n the CA's secret key.</p>\n </note>\n <p>Default: RSA_2048</p>"
0 commit comments