Skip to content

Commit

Permalink
docs(client-xray): Updated X-Ray documentation with Resource Policy A…
Browse files Browse the repository at this point in the history 
…PI descriptions.
  • Loading branch information
awstools committed Apr 27, 2023
1 parent 4df226f commit 88a8fb0
Show file tree
Hide file tree
Showing 3 changed files with 6,081 additions and 6,884 deletions.
35 changes: 18 additions & 17 deletions clients/client-xray/src/endpoint/ruleset.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,25 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints";
or see "smithy.rules#endpointRuleSet"
in codegen/sdk-codegen/aws-models/xray.json */

const p="required",
q="fn",
r="argv",
s="ref";
const a="PartitionResult",
const q="required",
r="fn",
s="argv",
t="ref";
const a="isSet",
b="tree",
c="error",
d="endpoint",
e={[p]:false,"type":"String"},
f={[p]:true,"default":false,"type":"Boolean"},
g={[s]:"Endpoint"},
h={[q]:"booleanEquals",[r]:[{[s]:"UseFIPS"},true]},
i={[q]:"booleanEquals",[r]:[{[s]:"UseDualStack"},true]},
j={},
k={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:a},"supportsFIPS"]}]},
l={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:a},"supportsDualStack"]}]},
m=[g],
n=[h],
o=[i];
const _data={version:"1.0",parameters:{Region:e,UseDualStack:f,UseFIPS:f,Endpoint:e},rules:[{conditions:[{[q]:"aws.partition",[r]:[{[s]:"Region"}],assign:a}],type:b,rules:[{conditions:[{[q]:"isSet",[r]:m},{[q]:"parseURL",[r]:m,assign:"url"}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:g,properties:j,headers:j},type:d}]}]},{conditions:[h,i],type:b,rules:[{conditions:[k,l],type:b,rules:[{endpoint:{url:"https://xray-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:j,headers:j},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[k],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://xray-fips.{Region}.{PartitionResult#dnsSuffix}",properties:j,headers:j},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[l],type:b,rules:[{endpoint:{url:"https://xray.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:j,headers:j},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://xray.{Region}.{PartitionResult#dnsSuffix}",properties:j,headers:j},type:d}]}]};
e="PartitionResult",
f={[q]:false,"type":"String"},
g={[q]:true,"default":false,"type":"Boolean"},
h={[t]:"Endpoint"},
i={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]},
j={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]},
k={},
l={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsFIPS"]}]},
m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack"]}]},
n=[i],
o=[j],
p=[{[t]:"Region"}];
const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]}]},{type:b,rules:[{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://xray-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://xray-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://xray.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://xray.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
export const ruleSet: RuleSetObject = _data;
54 changes: 27 additions & 27 deletions clients/client-xray/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -355,16 +355,16 @@ export interface CreateGroupRequest {

/**
* <p>The structure containing configurations related to insights.</p>
* <ul>
* <ul>
* <li>
* <p>The InsightsEnabled boolean can be set to true to enable insights for the
* <p>The InsightsEnabled boolean can be set to true to enable insights for the
* new group or false to disable insights for the new group.</p>
* </li>
* </li>
* <li>
* <p>The NotificationsEnabled boolean can be set to true to enable insights
* <p>The NotificationsEnabled boolean can be set to true to enable insights
* notifications for the new group. Notifications may only be enabled on a group
* with InsightsEnabled set to true.</p>
* </li>
* </li>
* </ul>
*/
InsightsConfiguration?: InsightsConfiguration;
Expand All @@ -373,26 +373,26 @@ export interface CreateGroupRequest {
* <p>A map that contains one or more tag keys and tag values to attach to an X-Ray group.
* For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
* resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
* <p>The following restrictions apply to tags:</p>
* <ul>
* <p>The following restrictions apply to tags:</p>
* <ul>
* <li>
* <p>Maximum number of user-applied tags per resource: 50</p>
* <p>Maximum number of user-applied tags per resource: 50</p>
* </li>
* <li>
* <p>Maximum tag key length: 128 Unicode characters</p>
* <p>Maximum tag key length: 128 Unicode characters</p>
* </li>
* <li>
* <p>Maximum tag value length: 256 Unicode characters</p>
* <p>Maximum tag value length: 256 Unicode characters</p>
* </li>
* <li>
* <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . :
* <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . :
* / = + - and @</p>
* </li>
* <li>
* <p>Tag keys and values are case sensitive.</p>
* <p>Tag keys and values are case sensitive.</p>
* </li>
* <li>
* <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services
* <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services
* use.</p>
* </li>
* </ul>
Expand Down Expand Up @@ -422,13 +422,13 @@ export interface Group {

/**
* <p>The structure containing configurations related to insights.</p>
* <ul>
* <ul>
* <li>
* <p>The InsightsEnabled boolean can be set to true to enable insights for the
* <p>The InsightsEnabled boolean can be set to true to enable insights for the
* group or false to disable insights for the group.</p>
* </li>
* <li>
* <p>The NotificationsEnabled boolean can be set to true to enable insights
* <p>The NotificationsEnabled boolean can be set to true to enable insights
* notifications through Amazon EventBridge for the group.</p>
* </li>
* </ul>
Expand Down Expand Up @@ -829,13 +829,13 @@ export interface GroupSummary {

/**
* <p>The structure containing configurations related to insights.</p>
* <ul>
* <ul>
* <li>
* <p>The InsightsEnabled boolean can be set to true to enable insights for the
* <p>The InsightsEnabled boolean can be set to true to enable insights for the
* group or false to disable insights for the group.</p>
* </li>
* <li>
* <p>The NotificationsEnabled boolean can be set to true to enable insights notifications.
* <p>The NotificationsEnabled boolean can be set to true to enable insights notifications.
* Notifications can only be enabled on a group with InsightsEnabled set to true.</p>
* </li>
* </ul>
Expand Down Expand Up @@ -2811,19 +2811,19 @@ export interface PutResourcePolicyRequest {
/**
* <p>Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id.
* The revision id is unique to each policy in the account.</p>
* <p>If the policy revision id does not match the latest revision id, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception. You can also provide a
* <p>If the policy revision id does not match the latest revision id, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception. You can also provide a
* <code>PolicyRevisionId</code> of 0. In this case, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception if a resource policy with the same name already exists.
* </p>
*/
PolicyRevisionId?: string;

/**
* <p>A flag to indicate whether to bypass the resource policy lockout safety check.</p>
* <important>
* <important>
* <p>Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.</p>
* </important>
* <p>Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent <code>PutResourcePolicy</code> request.</p>
* <p>The default value is false.</p>
* </important>
* <p>Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent <code>PutResourcePolicy</code> request.</p>
* <p>The default value is false.</p>
*/
BypassPolicyLockoutCheck?: boolean;
}
Expand Down Expand Up @@ -3092,13 +3092,13 @@ export interface UpdateGroupRequest {

/**
* <p>The structure containing configurations related to insights.</p>
* <ul>
* <ul>
* <li>
* <p>The InsightsEnabled boolean can be set to true to enable insights for the
* <p>The InsightsEnabled boolean can be set to true to enable insights for the
* group or false to disable insights for the group.</p>
* </li>
* <li>
* <p>The NotificationsEnabled boolean can be set to true to enable insights notifications for the group.
* <p>The NotificationsEnabled boolean can be set to true to enable insights notifications for the group.
* Notifications can only be enabled on a group with InsightsEnabled set to true.</p>
* </li>
* </ul>
Expand Down
Loading

0 comments on commit 88a8fb0

Please sign in to comment.