Skip to content

Commit

Permalink
docs(client-route-53): Update that corrects the documents for receive…
Browse files Browse the repository at this point in the history
…d feedback.
  • Loading branch information
awstools committed Jul 26, 2023
1 parent b8a9e7d commit 7686582
Show file tree
Hide file tree
Showing 10 changed files with 11,518 additions and 11,636 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,12 @@ export interface ChangeResourceRecordSetsCommandOutput extends ChangeResourceRec
* <p>
* <b>Change Propagation to Route 53 DNS Servers</b>
* </p>
* <p>When you submit a <code>ChangeResourceRecordSets</code> request, Route 53 propagates
* your changes to all of the Route 53 authoritative DNS servers. While your changes are
* propagating, <code>GetChange</code> returns a status of <code>PENDING</code>. When
* propagation is complete, <code>GetChange</code> returns a status of <code>INSYNC</code>.
* Changes generally propagate to all Route 53 name servers within 60 seconds. For more
* information, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html">GetChange</a>.</p>
* <p>When you submit a <code>ChangeResourceRecordSets</code> request, Route 53 propagates your
* changes to all of the Route 53 authoritative DNS servers managing the hosted zone. While
* your changes are propagating, <code>GetChange</code> returns a status of
* <code>PENDING</code>. When propagation is complete, <code>GetChange</code> returns a
* status of <code>INSYNC</code>. Changes generally propagate to all Route 53 name servers
* 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>
* <p>
* <b>Limits on ChangeResourceRecordSets Requests</b>
* </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,14 @@ export interface CreateTrafficPolicyInstanceCommandOutput
* or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for
* the domain or subdomain name by using the resource record sets that
* <code>CreateTrafficPolicyInstance</code> created.</p>
* <note>
* <p>After you submit an <code>CreateTrafficPolicyInstance</code> request, there's a
* brief delay while Amazon Route 53 creates the resource record sets that are
* specified in the traffic policy definition.
* Use <code>GetTrafficPolicyInstance</code> with the <code>id</code> of new traffic policy instance to confirm that the <code>CreateTrafficPolicyInstance</code>
* request completed successfully. For more information, see the
* <code>State</code> response element.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
4 changes: 2 additions & 2 deletions clients/client-route-53/src/commands/GetChangeCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ export interface GetChangeCommandOutput extends GetChangeResponse, __MetadataBea
* <li>
* <p>
* <code>PENDING</code> indicates that the changes in this request have not
* propagated to all Amazon Route 53 DNS servers. This is the initial status of all
* propagated to all Amazon Route 53 DNS servers managing the hosted zone. This is the initial status of all
* change batch requests.</p>
* </li>
* <li>
* <p>
* <code>INSYNC</code> indicates that the changes have propagated to all Route 53
* DNS servers. </p>
* DNS servers managing the hosted zone. </p>
* </li>
* </ul>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ export interface GetTrafficPolicyInstanceCommandOutput extends GetTrafficPolicyI
* @public
* <p>Gets information about a specified traffic policy instance.</p>
* <note>
* <p>After you submit a <code>CreateTrafficPolicyInstance</code> or an
* <code>UpdateTrafficPolicyInstance</code> request, there's a brief delay while
* Amazon Route 53 creates the resource record sets that are specified in the traffic
* policy definition. For more information, see the <code>State</code> response
* <p>
* Use <code>GetTrafficPolicyInstance</code> with the <code>id</code> of new traffic policy instance to confirm that the
* <code>CreateTrafficPolicyInstance</code> or an <code>UpdateTrafficPolicyInstance</code> request completed successfully.
* For more information, see the <code>State</code> response
* element.</p>
* </note>
* <note>
Expand Down
6 changes: 6 additions & 0 deletions clients/client-route-53/src/commands/TestDNSAnswerCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ export interface TestDNSAnswerCommandOutput extends TestDNSAnswerResponse, __Met
* specified record name and type. You can optionally specify the IP address of a DNS
* resolver, an EDNS0 client subnet IP address, and a subnet mask. </p>
* <p>This call only supports querying public hosted zones.</p>
* <note>
* <p>The <code>TestDnsAnswer </code> returns information similar to what you would expect from the answer
* section of the <code>dig</code> command. Therefore, if you query for the name
* servers of a subdomain that point to the parent name servers, those will not be
* returned.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,13 @@ export interface UpdateTrafficPolicyInstanceCommandOutput

/**
* @public
* <p>Updates the resource record sets in a specified hosted zone that were created based on
* <note>
* <p>After you submit a <code>UpdateTrafficPolicyInstance</code> request, there's a brief delay while Route 53 creates the resource record sets
* that are specified in the traffic policy definition. Use <code>GetTrafficPolicyInstance</code> with the <code>id</code> of updated traffic policy instance confirm
* that the
* <code>UpdateTrafficPolicyInstance</code> request completed successfully. For more information, see the <code>State</code> response element.</p>
* </note>
* <p>Updates the resource record sets in a specified hosted zone that were created based on
* the settings in a specified traffic policy version.</p>
* <p>When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS
* queries for the root resource record set name (such as example.com) while it replaces
Expand Down
2 changes: 1 addition & 1 deletion clients/client-route-53/src/endpoint/EndpointParameters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
};

export interface EndpointParameters extends __EndpointParameters {
Region: string;
Region?: string;
UseDualStack?: boolean;
UseFIPS?: boolean;
Endpoint?: string;
Expand Down
81 changes: 33 additions & 48 deletions clients/client-route-53/src/endpoint/ruleset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,53 +6,38 @@ import { RuleSetObject } from "@smithy/types";
or see "smithy.rules#endpointRuleSet"
in codegen/sdk-codegen/aws-models/route-53.json */

const L="type",
M="fn",
N="argv",
O="ref",
P="url",
Q="properties",
R="headers",
S="authSchemes",
T="name",
U="signingRegion",
V="signingName";
const a=true,
b=false,
c="String",
d="PartitionResult",
e="tree",
f="error",
g="endpoint",
h="stringEquals",
i="https://route-53-fips.{Region}.api.aws",
j="https://route-53.{Region}.api.aws",
k={"required":true,"default":false,[L]:"Boolean"},
l={[O]:"Region"},
m={[O]:"Endpoint"},
const A="required",
B="fn",
C="argv",
D="ref",
E="authSchemes",
F="signingName",
G="signingRegion";
const a="isSet",
b="tree",
c="error",
d="endpoint",
e="PartitionResult",
f="stringEquals",
g="sigv4",
h="route53",
i={[A]:false,"type":"String"},
j={[A]:true,"default":false,"type":"Boolean"},
k={[D]:"Endpoint"},
l={[B]:"booleanEquals",[C]:[{[D]:"UseFIPS"},true]},
m={[B]:"booleanEquals",[C]:[{[D]:"UseDualStack"},true]},
n={},
o={[M]:"getAttr",[N]:[{[O]:d},"name"]},
p={[S]:[{[T]:"sigv4",[U]:"us-east-1",[V]:"route53"}]},
q={[f]:"FIPS and DualStack are enabled, but this partition does not support one or both",[L]:f},
r={[P]:"https://route53-fips.amazonaws.com",[Q]:p,[R]:{}},
s={[f]:"FIPS is enabled but this partition does not support FIPS",[L]:f},
t={[f]:"DualStack is enabled but this partition does not support DualStack",[L]:f},
u={[P]:"https://route53.amazonaws.com",[Q]:p,[R]:{}},
v={[S]:[{[T]:"sigv4",[U]:"cn-northwest-1",[V]:"route53"}]},
w={[P]:"https://route53.amazonaws.com.cn",[Q]:v,[R]:{}},
x={[S]:[{[T]:"sigv4",[U]:"us-gov-west-1",[V]:"route53"}]},
y={[g]:{[P]:"https://route53.us-gov.amazonaws.com",[Q]:x,[R]:{}},[L]:g},
z={[S]:[{[T]:"sigv4",[U]:"us-iso-east-1",[V]:"route53"}]},
A={[P]:"https://route53.c2s.ic.gov",[Q]:z,[R]:{}},
B={[S]:[{[T]:"sigv4",[U]:"us-isob-east-1",[V]:"route53"}]},
C={[P]:"https://route53.sc2s.sgov.gov",[Q]:B,[R]:{}},
D={"conditions":[{[M]:h,[N]:[l,"aws-us-gov-global"]}],[g]:{[P]:"https://route53.us-gov.amazonaws.com",[Q]:x,[R]:{}},[L]:g},
E=[{[M]:"booleanEquals",[N]:[{[O]:"UseFIPS"},true]}],
F=[{[M]:"booleanEquals",[N]:[{[O]:"UseDualStack"},true]}],
G=[{[M]:"booleanEquals",[N]:[{[O]:"UseFIPS"},true]},{[M]:"booleanEquals",[N]:[{[O]:"UseDualStack"},true]}],
H=[{[M]:"booleanEquals",[N]:[true,{[M]:"getAttr",[N]:[{[O]:d},"supportsFIPS"]}]},{[M]:"booleanEquals",[N]:[true,{[M]:"getAttr",[N]:[{[O]:d},"supportsDualStack"]}]}],
I=[{[M]:"booleanEquals",[N]:[true,{[M]:"getAttr",[N]:[{[O]:d},"supportsFIPS"]}]}],
J=[{[M]:"booleanEquals",[N]:[true,{[M]:"getAttr",[N]:[{[O]:d},"supportsDualStack"]}]}],
K=[{[M]:h,[N]:[l,"aws-global"]}];
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}]}]}]};
o={[B]:f,[C]:[{[B]:"getAttr",[C]:[{[D]:e},"name"]},"aws"]},
p={[B]:"getAttr",[C]:[{[D]:e},"name"]},
q={[B]:"booleanEquals",[C]:[{[D]:"UseFIPS"},false]},
r={[B]:"booleanEquals",[C]:[{[D]:"UseDualStack"},false]},
s={[E]:[{"name":g,[F]:h,[G]:"us-east-1"}]},
t={[B]:f,[C]:[p,"aws-us-gov"]},
u={"url":"https://route53.us-gov.amazonaws.com","properties":{[E]:[{"name":g,[F]:h,[G]:"us-gov-west-1"}]},"headers":{}},
v={[B]:"booleanEquals",[C]:[true,{[B]:"getAttr",[C]:[{[D]:e},"supportsFIPS"]}]},
w={[B]:"booleanEquals",[C]:[true,{[B]:"getAttr",[C]:[{[D]:e},"supportsDualStack"]}]},
x=[l],
y=[m],
z=[{[D]:"Region"}];
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}]}]};
export const ruleSet: RuleSetObject = _data;
4 changes: 4 additions & 0 deletions clients/client-route-53/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3210,6 +3210,10 @@ export interface CreateHostedZoneRequest {
* <p>If you want to associate a reusable delegation set with this hosted zone, the ID that
* Amazon Route 53 assigned to the reusable delegation set when you created it.
* For more information about reusable delegation sets, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html">CreateReusableDelegationSet</a>.</p>
* <p>If you are using a reusable delegation set to create a public hosted zone for a subdomain,
* make sure that the parent hosted zone doesn't use one or more of the same name servers.
* If you have overlapping nameservers, the operation will cause a
* <code>ConflictingDomainsExist</code> error.</p>
*/
DelegationSetId?: string;
}
Expand Down
Loading

0 comments on commit 7686582

Please sign in to comment.