Skip to content

Commit 7686582

Browse files
author
awstools
committed
docs(client-route-53): Update that corrects the documents for received feedback.
1 parent b8a9e7d commit 7686582

File tree

10 files changed

+11518
-11636
lines changed

10 files changed

+11518
-11636
lines changed

clients/client-route-53/src/commands/ChangeResourceRecordSetsCommand.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,12 @@ export interface ChangeResourceRecordSetsCommandOutput extends ChangeResourceRec
116116
* <p>
117117
* <b>Change Propagation to Route 53 DNS Servers</b>
118118
* </p>
119-
* <p>When you submit a <code>ChangeResourceRecordSets</code> request, Route 53 propagates
120-
* your changes to all of the Route 53 authoritative DNS servers. While your changes are
121-
* propagating, <code>GetChange</code> returns a status of <code>PENDING</code>. When
122-
* propagation is complete, <code>GetChange</code> returns a status of <code>INSYNC</code>.
123-
* Changes generally propagate to all Route 53 name servers within 60 seconds. For more
124-
* information, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html">GetChange</a>.</p>
119+
* <p>When you submit a <code>ChangeResourceRecordSets</code> request, Route 53 propagates your
120+
* changes to all of the Route 53 authoritative DNS servers managing the hosted zone. While
121+
* your changes are propagating, <code>GetChange</code> returns a status of
122+
* <code>PENDING</code>. When propagation is complete, <code>GetChange</code> returns a
123+
* status of <code>INSYNC</code>. Changes generally propagate to all Route 53 name servers
124+
* managing the hosted zone within 60 seconds. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html">GetChange</a>.</p>
125125
* <p>
126126
* <b>Limits on ChangeResourceRecordSets Requests</b>
127127
* </p>

clients/client-route-53/src/commands/CreateTrafficPolicyInstanceCommand.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,14 @@ export interface CreateTrafficPolicyInstanceCommandOutput
4545
* or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for
4646
* the domain or subdomain name by using the resource record sets that
4747
* <code>CreateTrafficPolicyInstance</code> created.</p>
48+
* <note>
49+
* <p>After you submit an <code>CreateTrafficPolicyInstance</code> request, there's a
50+
* brief delay while Amazon Route 53 creates the resource record sets that are
51+
* specified in the traffic policy definition.
52+
* Use <code>GetTrafficPolicyInstance</code> with the <code>id</code> of new traffic policy instance to confirm that the <code>CreateTrafficPolicyInstance</code>
53+
* request completed successfully. For more information, see the
54+
* <code>State</code> response element.</p>
55+
* </note>
4856
* @example
4957
* Use a bare-bones client and the command you need to make an API call.
5058
* ```javascript

clients/client-route-53/src/commands/GetChangeCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ export interface GetChangeCommandOutput extends GetChangeResponse, __MetadataBea
4343
* <li>
4444
* <p>
4545
* <code>PENDING</code> indicates that the changes in this request have not
46-
* propagated to all Amazon Route 53 DNS servers. This is the initial status of all
46+
* propagated to all Amazon Route 53 DNS servers managing the hosted zone. This is the initial status of all
4747
* change batch requests.</p>
4848
* </li>
4949
* <li>
5050
* <p>
5151
* <code>INSYNC</code> indicates that the changes have propagated to all Route 53
52-
* DNS servers. </p>
52+
* DNS servers managing the hosted zone. </p>
5353
* </li>
5454
* </ul>
5555
* @example

clients/client-route-53/src/commands/GetTrafficPolicyInstanceCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ export interface GetTrafficPolicyInstanceCommandOutput extends GetTrafficPolicyI
3939
* @public
4040
* <p>Gets information about a specified traffic policy instance.</p>
4141
* <note>
42-
* <p>After you submit a <code>CreateTrafficPolicyInstance</code> or an
43-
* <code>UpdateTrafficPolicyInstance</code> request, there's a brief delay while
44-
* Amazon Route 53 creates the resource record sets that are specified in the traffic
45-
* policy definition. For more information, see the <code>State</code> response
42+
* <p>
43+
* Use <code>GetTrafficPolicyInstance</code> with the <code>id</code> of new traffic policy instance to confirm that the
44+
* <code>CreateTrafficPolicyInstance</code> or an <code>UpdateTrafficPolicyInstance</code> request completed successfully.
45+
* For more information, see the <code>State</code> response
4646
* element.</p>
4747
* </note>
4848
* <note>

clients/client-route-53/src/commands/TestDNSAnswerCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ export interface TestDNSAnswerCommandOutput extends TestDNSAnswerResponse, __Met
4141
* specified record name and type. You can optionally specify the IP address of a DNS
4242
* resolver, an EDNS0 client subnet IP address, and a subnet mask. </p>
4343
* <p>This call only supports querying public hosted zones.</p>
44+
* <note>
45+
* <p>The <code>TestDnsAnswer </code> returns information similar to what you would expect from the answer
46+
* section of the <code>dig</code> command. Therefore, if you query for the name
47+
* servers of a subdomain that point to the parent name servers, those will not be
48+
* returned.</p>
49+
* </note>
4450
* @example
4551
* Use a bare-bones client and the command you need to make an API call.
4652
* ```javascript

clients/client-route-53/src/commands/UpdateTrafficPolicyInstanceCommand.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,13 @@ export interface UpdateTrafficPolicyInstanceCommandOutput
3939

4040
/**
4141
* @public
42-
* <p>Updates the resource record sets in a specified hosted zone that were created based on
42+
* <note>
43+
* <p>After you submit a <code>UpdateTrafficPolicyInstance</code> request, there's a brief delay while Route 53 creates the resource record sets
44+
* that are specified in the traffic policy definition. Use <code>GetTrafficPolicyInstance</code> with the <code>id</code> of updated traffic policy instance confirm
45+
* that the
46+
* <code>UpdateTrafficPolicyInstance</code> request completed successfully. For more information, see the <code>State</code> response element.</p>
47+
* </note>
48+
* <p>Updates the resource record sets in a specified hosted zone that were created based on
4349
* the settings in a specified traffic policy version.</p>
4450
* <p>When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS
4551
* queries for the root resource record set name (such as example.com) while it replaces

clients/client-route-53/src/endpoint/EndpointParameters.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
2424
};
2525

2626
export interface EndpointParameters extends __EndpointParameters {
27-
Region: string;
27+
Region?: string;
2828
UseDualStack?: boolean;
2929
UseFIPS?: boolean;
3030
Endpoint?: string;

clients/client-route-53/src/endpoint/ruleset.ts

Lines changed: 33 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -6,53 +6,38 @@ import { RuleSetObject } from "@smithy/types";
66
or see "smithy.rules#endpointRuleSet"
77
in codegen/sdk-codegen/aws-models/route-53.json */
88

9-
const L="type",
10-
M="fn",
11-
N="argv",
12-
O="ref",
13-
P="url",
14-
Q="properties",
15-
R="headers",
16-
S="authSchemes",
17-
T="name",
18-
U="signingRegion",
19-
V="signingName";
20-
const a=true,
21-
b=false,
22-
c="String",
23-
d="PartitionResult",
24-
e="tree",
25-
f="error",
26-
g="endpoint",
27-
h="stringEquals",
28-
i="https://route-53-fips.{Region}.api.aws",
29-
j="https://route-53.{Region}.api.aws",
30-
k={"required":true,"default":false,[L]:"Boolean"},
31-
l={[O]:"Region"},
32-
m={[O]:"Endpoint"},
9+
const A="required",
10+
B="fn",
11+
C="argv",
12+
D="ref",
13+
E="authSchemes",
14+
F="signingName",
15+
G="signingRegion";
16+
const a="isSet",
17+
b="tree",
18+
c="error",
19+
d="endpoint",
20+
e="PartitionResult",
21+
f="stringEquals",
22+
g="sigv4",
23+
h="route53",
24+
i={[A]:false,"type":"String"},
25+
j={[A]:true,"default":false,"type":"Boolean"},
26+
k={[D]:"Endpoint"},
27+
l={[B]:"booleanEquals",[C]:[{[D]:"UseFIPS"},true]},
28+
m={[B]:"booleanEquals",[C]:[{[D]:"UseDualStack"},true]},
3329
n={},
34-
o={[M]:"getAttr",[N]:[{[O]:d},"name"]},
35-
p={[S]:[{[T]:"sigv4",[U]:"us-east-1",[V]:"route53"}]},
36-
q={[f]:"FIPS and DualStack are enabled, but this partition does not support one or both",[L]:f},
37-
r={[P]:"https://route53-fips.amazonaws.com",[Q]:p,[R]:{}},
38-
s={[f]:"FIPS is enabled but this partition does not support FIPS",[L]:f},
39-
t={[f]:"DualStack is enabled but this partition does not support DualStack",[L]:f},
40-
u={[P]:"https://route53.amazonaws.com",[Q]:p,[R]:{}},
41-
v={[S]:[{[T]:"sigv4",[U]:"cn-northwest-1",[V]:"route53"}]},
42-
w={[P]:"https://route53.amazonaws.com.cn",[Q]:v,[R]:{}},
43-
x={[S]:[{[T]:"sigv4",[U]:"us-gov-west-1",[V]:"route53"}]},
44-
y={[g]:{[P]:"https://route53.us-gov.amazonaws.com",[Q]:x,[R]:{}},[L]:g},
45-
z={[S]:[{[T]:"sigv4",[U]:"us-iso-east-1",[V]:"route53"}]},
46-
A={[P]:"https://route53.c2s.ic.gov",[Q]:z,[R]:{}},
47-
B={[S]:[{[T]:"sigv4",[U]:"us-isob-east-1",[V]:"route53"}]},
48-
C={[P]:"https://route53.sc2s.sgov.gov",[Q]:B,[R]:{}},
49-
D={"conditions":[{[M]:h,[N]:[l,"aws-us-gov-global"]}],[g]:{[P]:"https://route53.us-gov.amazonaws.com",[Q]:x,[R]:{}},[L]:g},
50-
E=[{[M]:"booleanEquals",[N]:[{[O]:"UseFIPS"},true]}],
51-
F=[{[M]:"booleanEquals",[N]:[{[O]:"UseDualStack"},true]}],
52-
G=[{[M]:"booleanEquals",[N]:[{[O]:"UseFIPS"},true]},{[M]:"booleanEquals",[N]:[{[O]:"UseDualStack"},true]}],
53-
H=[{[M]:"booleanEquals",[N]:[true,{[M]:"getAttr",[N]:[{[O]:d},"supportsFIPS"]}]},{[M]:"booleanEquals",[N]:[true,{[M]:"getAttr",[N]:[{[O]:d},"supportsDualStack"]}]}],
54-
I=[{[M]:"booleanEquals",[N]:[true,{[M]:"getAttr",[N]:[{[O]:d},"supportsFIPS"]}]}],
55-
J=[{[M]:"booleanEquals",[N]:[true,{[M]:"getAttr",[N]:[{[O]:d},"supportsDualStack"]}]}],
56-
K=[{[M]:h,[N]:[l,"aws-global"]}];
57-
const _data={version:"1.0",parameters:{Region:{required:a,[L]:c},UseDualStack:k,UseFIPS:k,Endpoint:{required:b,[L]:c}},rules:[{conditions:[{[M]:"aws.partition",[N]:[l],assign:d}],[L]:e,rules:[{conditions:[{[M]:"isSet",[N]:[m]}],[L]:e,rules:[{conditions:E,error:"Invalid Configuration: FIPS and custom endpoint are not supported",[L]:f},{[L]:e,rules:[{conditions:F,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",[L]:f},{endpoint:{[P]:m,[Q]:n,[R]:n},[L]:g}]}]},{conditions:[{[M]:h,[N]:[o,"aws"]}],[L]:e,rules:[{conditions:G,[L]:e,rules:[{conditions:H,[L]:e,rules:[{endpoint:{[P]:i,[Q]:p,[R]:n},[L]:g}]},q]},{conditions:E,[L]:e,rules:[{conditions:I,[L]:e,rules:[{endpoint:r,[L]:g}]},s]},{conditions:F,[L]:e,rules:[{conditions:J,[L]:e,rules:[{endpoint:{[P]:j,[Q]:p,[R]:n},[L]:g}]},t]},{endpoint:u,[L]:g}]},{conditions:[{[M]:h,[N]:[o,"aws-cn"]}],[L]:e,rules:[{conditions:G,[L]:e,rules:[{conditions:H,[L]:e,rules:[{endpoint:{[P]:"https://route-53-fips.{Region}.api.amazonwebservices.com.cn",[Q]:v,[R]:n},[L]:g}]},q]},{conditions:E,[L]:e,rules:[{conditions:I,[L]:e,rules:[{endpoint:{[P]:"https://route-53-fips.{Region}.amazonaws.com.cn",[Q]:v,[R]:n},[L]:g}]},s]},{conditions:F,[L]:e,rules:[{conditions:J,[L]:e,rules:[{endpoint:{[P]:"https://route-53.{Region}.api.amazonwebservices.com.cn",[Q]:v,[R]:n},[L]:g}]},t]},{endpoint:w,[L]:g}]},{conditions:[{[M]:h,[N]:[o,"aws-us-gov"]}],[L]:e,rules:[{conditions:G,[L]:e,rules:[{conditions:H,[L]:e,rules:[{endpoint:{[P]:i,[Q]:x,[R]:n},[L]:g}]},q]},{conditions:E,[L]:e,rules:[{conditions:I,[L]:e,rules:[y]},s]},{conditions:F,[L]:e,rules:[{conditions:J,[L]:e,rules:[{endpoint:{[P]:j,[Q]:x,[R]:n},[L]:g}]},t]},y]},{conditions:[{[M]:h,[N]:[o,"aws-iso"]}],[L]:e,rules:[{conditions:E,[L]:e,rules:[{conditions:I,[L]:e,rules:[{endpoint:{[P]:"https://route-53-fips.{Region}.c2s.ic.gov",[Q]:z,[R]:n},[L]:g}]},s]},{endpoint:A,[L]:g}]},{conditions:[{[M]:h,[N]:[o,"aws-iso-b"]}],[L]:e,rules:[{conditions:E,[L]:e,rules:[{conditions:I,[L]:e,rules:[{endpoint:{[P]:"https://route-53-fips.{Region}.sc2s.sgov.gov",[Q]:B,[R]:n},[L]:g}]},s]},{endpoint:C,[L]:g}]},{conditions:G,[L]:e,rules:[{conditions:H,[L]:e,rules:[{endpoint:{[P]:"https://route53-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",[Q]:n,[R]:n},[L]:g}]},q]},{conditions:E,[L]:e,rules:[{conditions:I,[L]:e,rules:[{[L]:e,rules:[{conditions:K,endpoint:r,[L]:g},D,{endpoint:{[P]:"https://route53-fips.{Region}.{PartitionResult#dnsSuffix}",[Q]:n,[R]:n},[L]:g}]}]},s]},{conditions:F,[L]:e,rules:[{conditions:J,[L]:e,rules:[{endpoint:{[P]:"https://route53.{Region}.{PartitionResult#dualStackDnsSuffix}",[Q]:n,[R]:n},[L]:g}]},t]},{[L]:e,rules:[{conditions:K,endpoint:u,[L]:g},{conditions:[{[M]:h,[N]:[l,"aws-cn-global"]}],endpoint:w,[L]:g},D,{conditions:[{[M]:h,[N]:[l,"aws-iso-global"]}],endpoint:A,[L]:g},{conditions:[{[M]:h,[N]:[l,"aws-iso-b-global"]}],endpoint:C,[L]:g},{endpoint:{[P]:"https://route53.{Region}.{PartitionResult#dnsSuffix}",[Q]:n,[R]:n},[L]:g}]}]}]};
30+
o={[B]:f,[C]:[{[B]:"getAttr",[C]:[{[D]:e},"name"]},"aws"]},
31+
p={[B]:"getAttr",[C]:[{[D]:e},"name"]},
32+
q={[B]:"booleanEquals",[C]:[{[D]:"UseFIPS"},false]},
33+
r={[B]:"booleanEquals",[C]:[{[D]:"UseDualStack"},false]},
34+
s={[E]:[{"name":g,[F]:h,[G]:"us-east-1"}]},
35+
t={[B]:f,[C]:[p,"aws-us-gov"]},
36+
u={"url":"https://route53.us-gov.amazonaws.com","properties":{[E]:[{"name":g,[F]:h,[G]:"us-gov-west-1"}]},"headers":{}},
37+
v={[B]:"booleanEquals",[C]:[true,{[B]:"getAttr",[C]:[{[D]:e},"supportsFIPS"]}]},
38+
w={[B]:"booleanEquals",[C]:[true,{[B]:"getAttr",[C]:[{[D]:e},"supportsDualStack"]}]},
39+
x=[l],
40+
y=[m],
41+
z=[{[D]:"Region"}];
42+
const _data={version:"1.0",parameters:{Region:i,UseDualStack:j,UseFIPS:j,Endpoint:i},rules:[{conditions:[{[B]:a,[C]:[k]}],type:b,rules:[{conditions:x,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:y,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:k,properties:n,headers:n},type:d}]}]},{type:b,rules:[{conditions:[{[B]:a,[C]:z}],type:b,rules:[{conditions:[{[B]:"aws.partition",[C]:z,assign:e}],type:b,rules:[{conditions:[o,q,r],endpoint:{url:"https://route53.amazonaws.com",properties:s,headers:n},type:d},{conditions:[o,l,r],endpoint:{url:"https://route53-fips.amazonaws.com",properties:s,headers:n},type:d},{conditions:[{[B]:f,[C]:[p,"aws-cn"]},q,r],endpoint:{url:"https://route53.amazonaws.com.cn",properties:{[E]:[{name:g,[F]:h,[G]:"cn-northwest-1"}]},headers:n},type:d},{conditions:[t,q,r],endpoint:u,type:d},{conditions:[t,l,r],endpoint:u,type:d},{conditions:[{[B]:f,[C]:[p,"aws-iso"]},q,r],endpoint:{url:"https://route53.c2s.ic.gov",properties:{[E]:[{name:g,[F]:h,[G]:"us-iso-east-1"}]},headers:n},type:d},{conditions:[{[B]:f,[C]:[p,"aws-iso-b"]},q,r],endpoint:{url:"https://route53.sc2s.sgov.gov",properties:{[E]:[{name:g,[F]:h,[G]:"us-isob-east-1"}]},headers:n},type:d},{conditions:[l,m],type:b,rules:[{conditions:[v,w],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://route53-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:n,headers:n},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:x,type:b,rules:[{conditions:[v],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://route53-fips.{Region}.{PartitionResult#dnsSuffix}",properties:n,headers:n},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:y,type:b,rules:[{conditions:[w],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://route53.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:n,headers:n},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://route53.{Region}.{PartitionResult#dnsSuffix}",properties:n,headers:n},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
5843
export const ruleSet: RuleSetObject = _data;

clients/client-route-53/src/models/models_0.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3210,6 +3210,10 @@ export interface CreateHostedZoneRequest {
32103210
* <p>If you want to associate a reusable delegation set with this hosted zone, the ID that
32113211
* Amazon Route 53 assigned to the reusable delegation set when you created it.
32123212
* For more information about reusable delegation sets, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html">CreateReusableDelegationSet</a>.</p>
3213+
* <p>If you are using a reusable delegation set to create a public hosted zone for a subdomain,
3214+
* make sure that the parent hosted zone doesn't use one or more of the same name servers.
3215+
* If you have overlapping nameservers, the operation will cause a
3216+
* <code>ConflictingDomainsExist</code> error.</p>
32133217
*/
32143218
DelegationSetId?: string;
32153219
}

0 commit comments

Comments
 (0)