Skip to content

Commit 1681d8f

Browse files
author
awstools
committed
feat(client-ssm-quicksetup): Add methods that retrieve details about deployed configurations: ListConfigurations, GetConfiguration
1 parent fb9ea84 commit 1681d8f

File tree

11 files changed

+1045
-14
lines changed

11 files changed

+1045
-14
lines changed

clients/client-ssm-quicksetup/README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ using your favorite package manager:
2525

2626
The AWS SDK is modulized by clients and commands.
2727
To send a request, you only need to import the `SSMQuickSetupClient` and
28-
the commands you need, for example `ListQuickSetupTypesCommand`:
28+
the commands you need, for example `ListConfigurationsCommand`:
2929

3030
```js
3131
// ES5 example
32-
const { SSMQuickSetupClient, ListQuickSetupTypesCommand } = require("@aws-sdk/client-ssm-quicksetup");
32+
const { SSMQuickSetupClient, ListConfigurationsCommand } = require("@aws-sdk/client-ssm-quicksetup");
3333
```
3434

3535
```ts
3636
// ES6+ example
37-
import { SSMQuickSetupClient, ListQuickSetupTypesCommand } from "@aws-sdk/client-ssm-quicksetup";
37+
import { SSMQuickSetupClient, ListConfigurationsCommand } from "@aws-sdk/client-ssm-quicksetup";
3838
```
3939

4040
### Usage
@@ -53,7 +53,7 @@ const client = new SSMQuickSetupClient({ region: "REGION" });
5353
const params = {
5454
/** input parameters */
5555
};
56-
const command = new ListQuickSetupTypesCommand(params);
56+
const command = new ListConfigurationsCommand(params);
5757
```
5858

5959
#### Async/await
@@ -132,15 +132,15 @@ const client = new AWS.SSMQuickSetup({ region: "REGION" });
132132

133133
// async/await.
134134
try {
135-
const data = await client.listQuickSetupTypes(params);
135+
const data = await client.listConfigurations(params);
136136
// process data.
137137
} catch (error) {
138138
// error handling.
139139
}
140140

141141
// Promises.
142142
client
143-
.listQuickSetupTypes(params)
143+
.listConfigurations(params)
144144
.then((data) => {
145145
// process data.
146146
})
@@ -149,7 +149,7 @@ client
149149
});
150150

151151
// callbacks.
152-
client.listQuickSetupTypes(params, (err, data) => {
152+
client.listConfigurations(params, (err, data) => {
153153
// process err and data.
154154
});
155155
```
@@ -220,6 +220,14 @@ DeleteConfigurationManager
220220

221221
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm-quicksetup/command/DeleteConfigurationManagerCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-quicksetup/Interface/DeleteConfigurationManagerCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-quicksetup/Interface/DeleteConfigurationManagerCommandOutput/)
222222

223+
</details>
224+
<details>
225+
<summary>
226+
GetConfiguration
227+
</summary>
228+
229+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm-quicksetup/command/GetConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-quicksetup/Interface/GetConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-quicksetup/Interface/GetConfigurationCommandOutput/)
230+
223231
</details>
224232
<details>
225233
<summary>
@@ -244,6 +252,14 @@ ListConfigurationManagers
244252

245253
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm-quicksetup/command/ListConfigurationManagersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-quicksetup/Interface/ListConfigurationManagersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-quicksetup/Interface/ListConfigurationManagersCommandOutput/)
246254

255+
</details>
256+
<details>
257+
<summary>
258+
ListConfigurations
259+
</summary>
260+
261+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm-quicksetup/command/ListConfigurationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-quicksetup/Interface/ListConfigurationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-quicksetup/Interface/ListConfigurationsCommandOutput/)
262+
247263
</details>
248264
<details>
249265
<summary>

clients/client-ssm-quicksetup/src/SSMQuickSetup.ts

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ import {
1212
DeleteConfigurationManagerCommandInput,
1313
DeleteConfigurationManagerCommandOutput,
1414
} from "./commands/DeleteConfigurationManagerCommand";
15+
import {
16+
GetConfigurationCommand,
17+
GetConfigurationCommandInput,
18+
GetConfigurationCommandOutput,
19+
} from "./commands/GetConfigurationCommand";
1520
import {
1621
GetConfigurationManagerCommand,
1722
GetConfigurationManagerCommandInput,
@@ -27,6 +32,11 @@ import {
2732
ListConfigurationManagersCommandInput,
2833
ListConfigurationManagersCommandOutput,
2934
} from "./commands/ListConfigurationManagersCommand";
35+
import {
36+
ListConfigurationsCommand,
37+
ListConfigurationsCommandInput,
38+
ListConfigurationsCommandOutput,
39+
} from "./commands/ListConfigurationsCommand";
3040
import {
3141
ListQuickSetupTypesCommand,
3242
ListQuickSetupTypesCommandInput,
@@ -63,9 +73,11 @@ import { SSMQuickSetupClient, SSMQuickSetupClientConfig } from "./SSMQuickSetupC
6373
const commands = {
6474
CreateConfigurationManagerCommand,
6575
DeleteConfigurationManagerCommand,
76+
GetConfigurationCommand,
6677
GetConfigurationManagerCommand,
6778
GetServiceSettingsCommand,
6879
ListConfigurationManagersCommand,
80+
ListConfigurationsCommand,
6981
ListQuickSetupTypesCommand,
7082
ListTagsForResourceCommand,
7183
TagResourceCommand,
@@ -110,6 +122,23 @@ export interface SSMQuickSetup {
110122
cb: (err: any, data?: DeleteConfigurationManagerCommandOutput) => void
111123
): void;
112124

125+
/**
126+
* @see {@link GetConfigurationCommand}
127+
*/
128+
getConfiguration(
129+
args: GetConfigurationCommandInput,
130+
options?: __HttpHandlerOptions
131+
): Promise<GetConfigurationCommandOutput>;
132+
getConfiguration(
133+
args: GetConfigurationCommandInput,
134+
cb: (err: any, data?: GetConfigurationCommandOutput) => void
135+
): void;
136+
getConfiguration(
137+
args: GetConfigurationCommandInput,
138+
options: __HttpHandlerOptions,
139+
cb: (err: any, data?: GetConfigurationCommandOutput) => void
140+
): void;
141+
113142
/**
114143
* @see {@link GetConfigurationManagerCommand}
115144
*/
@@ -163,6 +192,24 @@ export interface SSMQuickSetup {
163192
cb: (err: any, data?: ListConfigurationManagersCommandOutput) => void
164193
): void;
165194

195+
/**
196+
* @see {@link ListConfigurationsCommand}
197+
*/
198+
listConfigurations(): Promise<ListConfigurationsCommandOutput>;
199+
listConfigurations(
200+
args: ListConfigurationsCommandInput,
201+
options?: __HttpHandlerOptions
202+
): Promise<ListConfigurationsCommandOutput>;
203+
listConfigurations(
204+
args: ListConfigurationsCommandInput,
205+
cb: (err: any, data?: ListConfigurationsCommandOutput) => void
206+
): void;
207+
listConfigurations(
208+
args: ListConfigurationsCommandInput,
209+
options: __HttpHandlerOptions,
210+
cb: (err: any, data?: ListConfigurationsCommandOutput) => void
211+
): void;
212+
166213
/**
167214
* @see {@link ListQuickSetupTypesCommand}
168215
*/

clients/client-ssm-quicksetup/src/SSMQuickSetupClient.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ import {
6161
DeleteConfigurationManagerCommandInput,
6262
DeleteConfigurationManagerCommandOutput,
6363
} from "./commands/DeleteConfigurationManagerCommand";
64+
import { GetConfigurationCommandInput, GetConfigurationCommandOutput } from "./commands/GetConfigurationCommand";
6465
import {
6566
GetConfigurationManagerCommandInput,
6667
GetConfigurationManagerCommandOutput,
@@ -70,6 +71,7 @@ import {
7071
ListConfigurationManagersCommandInput,
7172
ListConfigurationManagersCommandOutput,
7273
} from "./commands/ListConfigurationManagersCommand";
74+
import { ListConfigurationsCommandInput, ListConfigurationsCommandOutput } from "./commands/ListConfigurationsCommand";
7375
import {
7476
ListQuickSetupTypesCommandInput,
7577
ListQuickSetupTypesCommandOutput,
@@ -109,9 +111,11 @@ export { __Client };
109111
export type ServiceInputTypes =
110112
| CreateConfigurationManagerCommandInput
111113
| DeleteConfigurationManagerCommandInput
114+
| GetConfigurationCommandInput
112115
| GetConfigurationManagerCommandInput
113116
| GetServiceSettingsCommandInput
114117
| ListConfigurationManagersCommandInput
118+
| ListConfigurationsCommandInput
115119
| ListQuickSetupTypesCommandInput
116120
| ListTagsForResourceCommandInput
117121
| TagResourceCommandInput
@@ -126,9 +130,11 @@ export type ServiceInputTypes =
126130
export type ServiceOutputTypes =
127131
| CreateConfigurationManagerCommandOutput
128132
| DeleteConfigurationManagerCommandOutput
133+
| GetConfigurationCommandOutput
129134
| GetConfigurationManagerCommandOutput
130135
| GetServiceSettingsCommandOutput
131136
| ListConfigurationManagersCommandOutput
137+
| ListConfigurationsCommandOutput
132138
| ListQuickSetupTypesCommandOutput
133139
| ListTagsForResourceCommandOutput
134140
| TagResourceCommandOutput
Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
// smithy-typescript generated code
2+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
3+
import { getSerdePlugin } from "@smithy/middleware-serde";
4+
import { Command as $Command } from "@smithy/smithy-client";
5+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
6+
7+
import { commonParams } from "../endpoint/EndpointParameters";
8+
import { GetConfigurationInput, GetConfigurationOutput } from "../models/models_0";
9+
import { de_GetConfigurationCommand, se_GetConfigurationCommand } from "../protocols/Aws_restJson1";
10+
import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient";
11+
12+
/**
13+
* @public
14+
*/
15+
export type { __MetadataBearer };
16+
export { $Command };
17+
/**
18+
* @public
19+
*
20+
* The input for {@link GetConfigurationCommand}.
21+
*/
22+
export interface GetConfigurationCommandInput extends GetConfigurationInput {}
23+
/**
24+
* @public
25+
*
26+
* The output of {@link GetConfigurationCommand}.
27+
*/
28+
export interface GetConfigurationCommandOutput extends GetConfigurationOutput, __MetadataBearer {}
29+
30+
/**
31+
* <p>Returns details about the specified configuration.</p>
32+
* @example
33+
* Use a bare-bones client and the command you need to make an API call.
34+
* ```javascript
35+
* import { SSMQuickSetupClient, GetConfigurationCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import
36+
* // const { SSMQuickSetupClient, GetConfigurationCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import
37+
* const client = new SSMQuickSetupClient(config);
38+
* const input = { // GetConfigurationInput
39+
* ConfigurationId: "STRING_VALUE", // required
40+
* };
41+
* const command = new GetConfigurationCommand(input);
42+
* const response = await client.send(command);
43+
* // { // GetConfigurationOutput
44+
* // Id: "STRING_VALUE",
45+
* // ManagerArn: "STRING_VALUE",
46+
* // ConfigurationDefinitionId: "STRING_VALUE",
47+
* // Type: "STRING_VALUE",
48+
* // TypeVersion: "STRING_VALUE",
49+
* // Account: "STRING_VALUE",
50+
* // Region: "STRING_VALUE",
51+
* // CreatedAt: new Date("TIMESTAMP"),
52+
* // LastModifiedAt: new Date("TIMESTAMP"),
53+
* // StatusSummaries: [ // StatusSummariesList
54+
* // { // StatusSummary
55+
* // StatusType: "Deployment" || "AsyncExecutions", // required
56+
* // Status: "INITIALIZING" || "DEPLOYING" || "SUCCEEDED" || "DELETING" || "STOPPING" || "FAILED" || "STOPPED" || "DELETE_FAILED" || "STOP_FAILED" || "NONE",
57+
* // StatusMessage: "STRING_VALUE",
58+
* // LastUpdatedAt: new Date("TIMESTAMP"), // required
59+
* // StatusDetails: { // StatusDetails
60+
* // "<keys>": "STRING_VALUE",
61+
* // },
62+
* // },
63+
* // ],
64+
* // Parameters: { // ConfigurationParametersMap
65+
* // "<keys>": "STRING_VALUE",
66+
* // },
67+
* // };
68+
*
69+
* ```
70+
*
71+
* @param GetConfigurationCommandInput - {@link GetConfigurationCommandInput}
72+
* @returns {@link GetConfigurationCommandOutput}
73+
* @see {@link GetConfigurationCommandInput} for command's `input` shape.
74+
* @see {@link GetConfigurationCommandOutput} for command's `response` shape.
75+
* @see {@link SSMQuickSetupClientResolvedConfig | config} for SSMQuickSetupClient's `config` shape.
76+
*
77+
* @throws {@link AccessDeniedException} (client fault)
78+
* <p>The requester has insufficient permissions to perform the operation.</p>
79+
*
80+
* @throws {@link ConflictException} (client fault)
81+
* <p>Another request is being processed. Wait a few minutes and try again.</p>
82+
*
83+
* @throws {@link InternalServerException} (server fault)
84+
* <p>An error occurred on the server side.</p>
85+
*
86+
* @throws {@link ResourceNotFoundException} (client fault)
87+
* <p>The resource couldn't be found. Check the ID or name and try again.</p>
88+
*
89+
* @throws {@link ThrottlingException} (client fault)
90+
* <p>The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.</p>
91+
*
92+
* @throws {@link ValidationException} (client fault)
93+
* <p>The request is invalid. Verify the values provided for the request parameters are
94+
* accurate.</p>
95+
*
96+
* @throws {@link SSMQuickSetupServiceException}
97+
* <p>Base exception class for all service exceptions from SSMQuickSetup service.</p>
98+
*
99+
* @public
100+
*/
101+
export class GetConfigurationCommand extends $Command
102+
.classBuilder<
103+
GetConfigurationCommandInput,
104+
GetConfigurationCommandOutput,
105+
SSMQuickSetupClientResolvedConfig,
106+
ServiceInputTypes,
107+
ServiceOutputTypes
108+
>()
109+
.ep(commonParams)
110+
.m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) {
111+
return [
112+
getSerdePlugin(config, this.serialize, this.deserialize),
113+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
114+
];
115+
})
116+
.s("QuickSetup", "GetConfiguration", {})
117+
.n("SSMQuickSetupClient", "GetConfigurationCommand")
118+
.f(void 0, void 0)
119+
.ser(se_GetConfigurationCommand)
120+
.de(de_GetConfigurationCommand)
121+
.build() {
122+
/** @internal type navigation helper, not in runtime. */
123+
protected declare static __types: {
124+
api: {
125+
input: GetConfigurationInput;
126+
output: GetConfigurationOutput;
127+
};
128+
sdk: {
129+
input: GetConfigurationCommandInput;
130+
output: GetConfigurationCommandOutput;
131+
};
132+
};
133+
}

0 commit comments

Comments
 (0)