Skip to content

Commit

Permalink
docs(client-workspaces): Documentation updates for WorkSpaces
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Oct 19, 2023
1 parent 4466174 commit f21fd7a
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 43 deletions.
3 changes: 2 additions & 1 deletion clients/client-workspaces/src/commands/CreateWorkspacesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ export interface CreateWorkspacesCommandOutput extends CreateWorkspacesResult, _
* Core</a>.</p>
* </li>
* <li>
* <p>PCoIP is only available for Windows bundles.</p>
* <p>You don't need to specify the <code>PCOIP</code> protocol for Linux bundles
* because <code>WSP</code> is the default protocol for those bundles.</p>
* </li>
* </ul>
* </note>
Expand Down
44 changes: 23 additions & 21 deletions clients/client-workspaces/src/endpoint/ruleset.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,27 @@ import { RuleSetObject } from "@smithy/types";
or see "smithy.rules#endpointRuleSet"
in codegen/sdk-codegen/aws-models/workspaces.json */

const q="required",
r="fn",
s="argv",
t="ref";
const a="isSet",
b="tree",
c="error",
d="endpoint",
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},{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]},{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:[{endpoint:{url:"https://workspaces-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:[{endpoint:{url:"https://workspaces-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:[{endpoint:{url:"https://workspaces.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://workspaces.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]};
const s="required",
t="fn",
u="argv",
v="ref";
const a=true,
b="isSet",
c="booleanEquals",
d="error",
e="endpoint",
f="tree",
g="PartitionResult",
h={[s]:false,"type":"String"},
i={[s]:true,"default":false,"type":"Boolean"},
j={[v]:"Endpoint"},
k={[t]:c,[u]:[{[v]:"UseFIPS"},true]},
l={[t]:c,[u]:[{[v]:"UseDualStack"},true]},
m={},
n={[t]:"getAttr",[u]:[{[v]:g},"supportsFIPS"]},
o={[t]:c,[u]:[true,{[t]:"getAttr",[u]:[{[v]:g},"supportsDualStack"]}]},
p=[k],
q=[l],
r=[{[v]:"Region"}];
const _data={version:"1.0",parameters:{Region:h,UseDualStack:i,UseFIPS:i,Endpoint:h},rules:[{conditions:[{[t]:b,[u]:[j]}],rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:j,properties:m,headers:m},type:e}],type:f},{conditions:[{[t]:b,[u]:r}],rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:g}],rules:[{conditions:[k,l],rules:[{conditions:[{[t]:c,[u]:[a,n]},o],rules:[{endpoint:{url:"https://workspaces-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:p,rules:[{conditions:[{[t]:c,[u]:[n,a]}],rules:[{endpoint:{url:"https://workspaces-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:q,rules:[{conditions:[o],rules:[{endpoint:{url:"https://workspaces.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{url:"https://workspaces.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}]};
export const ruleSet: RuleSetObject = _data;
42 changes: 21 additions & 21 deletions codegen/sdk-codegen/aws-models/workspaces.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2089,7 +2089,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates one or more WorkSpaces.</p>\n <p>This operation is asynchronous and returns before the WorkSpaces are created.</p>\n <note>\n <ul>\n <li>\n <p>The <code>MANUAL</code> running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see <a href=\"http://aws.amazon.com/workspaces/core/\">Amazon WorkSpaces\n Core</a>.</p>\n </li>\n <li>\n <p>PCoIP is only available for Windows bundles.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Creates one or more WorkSpaces.</p>\n <p>This operation is asynchronous and returns before the WorkSpaces are created.</p>\n <note>\n <ul>\n <li>\n <p>The <code>MANUAL</code> running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see <a href=\"http://aws.amazon.com/workspaces/core/\">Amazon WorkSpaces\n Core</a>.</p>\n </li>\n <li>\n <p>You don't need to specify the <code>PCOIP</code> protocol for Linux bundles\n because <code>WSP</code> is the default protocol for those bundles.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.workspaces#CreateWorkspacesRequest": {
Expand Down Expand Up @@ -9351,7 +9351,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [
Expand Down Expand Up @@ -9394,7 +9393,8 @@
},
"type": "endpoint"
}
]
],
"type": "tree"
},
{
"conditions": [
Expand All @@ -9407,7 +9407,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [
Expand All @@ -9421,7 +9420,6 @@
"assign": "PartitionResult"
}
],
"type": "tree",
"rules": [
{
"conditions": [
Expand All @@ -9444,7 +9442,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [
Expand Down Expand Up @@ -9479,7 +9476,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [],
Expand All @@ -9490,14 +9486,16 @@
},
"type": "endpoint"
}
]
],
"type": "tree"
},
{
"conditions": [],
"error": "FIPS and DualStack are enabled, but this partition does not support one or both",
"type": "error"
}
]
],
"type": "tree"
},
{
"conditions": [
Expand All @@ -9511,14 +9509,12 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
true,
{
"fn": "getAttr",
"argv": [
Expand All @@ -9527,11 +9523,11 @@
},
"supportsFIPS"
]
}
},
true
]
}
],
"type": "tree",
"rules": [
{
"conditions": [],
Expand All @@ -9542,14 +9538,16 @@
},
"type": "endpoint"
}
]
],
"type": "tree"
},
{
"conditions": [],
"error": "FIPS is enabled but this partition does not support FIPS",
"type": "error"
}
]
],
"type": "tree"
},
{
"conditions": [
Expand All @@ -9563,7 +9561,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [
Expand All @@ -9583,7 +9580,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [],
Expand All @@ -9594,14 +9590,16 @@
},
"type": "endpoint"
}
]
],
"type": "tree"
},
{
"conditions": [],
"error": "DualStack is enabled but this partition does not support DualStack",
"type": "error"
}
]
],
"type": "tree"
},
{
"conditions": [],
Expand All @@ -9612,9 +9610,11 @@
},
"type": "endpoint"
}
]
],
"type": "tree"
}
]
],
"type": "tree"
},
{
"conditions": [],
Expand Down

0 comments on commit f21fd7a

Please sign in to comment.