Skip to content

Commit e4f6fea

Browse files
authored
feat(client-ssm-incidents): rename client-commander package to client-ssm-incidents (#2431)
Rename client-commander package to client-ssm-incidents. AWS Systems Manager Incident Manager enables faster resolution of critical application availability and performance issues, management of contacts and post-incident analysis
1 parent 10db5ac commit e4f6fea

File tree

60 files changed

+1459
-1470
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1459
-1470
lines changed

clients/client-commander/CHANGELOG.md

-11
This file was deleted.

clients/client-commander/pagination/Interfaces.ts

-7
This file was deleted.

clients/client-commander/README.md renamed to clients/client-ssm-incidents/README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# @aws-sdk/client-commander
1+
# @aws-sdk/client-ssm-incidents
22

3-
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-commander/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-commander)
4-
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-commander.svg)](https://www.npmjs.com/package/@aws-sdk/client-commander)
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-ssm-incidents/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-ssm-incidents)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-ssm-incidents.svg)](https://www.npmjs.com/package/@aws-sdk/client-ssm-incidents)
55

66
## Description
77

8-
AWS SDK for JavaScript Commander Client for Node.js, Browser and React Native.
8+
AWS SDK for JavaScript SSMIncidents Client for Node.js, Browser and React Native.
99

1010
<p>AWS Systems Manager Incident Manager is an incident management console designed to help
1111
users mitigate and recover from incidents affecting their AWS-hosted applications. An incident
@@ -18,29 +18,29 @@ escalation. </p>
1818

1919
## Installing
2020

21-
To install the this package, simply type add or install @aws-sdk/client-commander
21+
To install the this package, simply type add or install @aws-sdk/client-ssm-incidents
2222
using your favorite package manager:
2323

24-
- `npm install @aws-sdk/client-commander`
25-
- `yarn add @aws-sdk/client-commander`
26-
- `pnpm add @aws-sdk/client-commander`
24+
- `npm install @aws-sdk/client-ssm-incidents`
25+
- `yarn add @aws-sdk/client-ssm-incidents`
26+
- `pnpm add @aws-sdk/client-ssm-incidents`
2727

2828
## Getting Started
2929

3030
### Import
3131

3232
The AWS SDK is modulized by clients and commands.
33-
To send a request, you only need to import the `CommanderClient` and
33+
To send a request, you only need to import the `SSMIncidentsClient` and
3434
the commands you need, for example `CreateReplicationSetCommand`:
3535

3636
```js
3737
// ES5 example
38-
const { CommanderClient, CreateReplicationSetCommand } = require("@aws-sdk/client-commander");
38+
const { SSMIncidentsClient, CreateReplicationSetCommand } = require("@aws-sdk/client-ssm-incidents");
3939
```
4040

4141
```ts
4242
// ES6+ example
43-
import { CommanderClient, CreateReplicationSetCommand } from "@aws-sdk/client-commander";
43+
import { SSMIncidentsClient, CreateReplicationSetCommand } from "@aws-sdk/client-ssm-incidents";
4444
```
4545

4646
### Usage
@@ -54,7 +54,7 @@ To send a request, you:
5454

5555
```js
5656
// a client can be shared by different commands.
57-
const client = new CommanderClient({ region: "REGION" });
57+
const client = new SSMIncidentsClient({ region: "REGION" });
5858

5959
const params = {
6060
/** input parameters */
@@ -133,8 +133,8 @@ However, it results in a bigger bundle size and may be dropped in next major ver
133133
on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
134134

135135
```ts
136-
import * as AWS from "@aws-sdk/client-commander";
137-
const client = new AWS.Commander({ region: "REGION" });
136+
import * as AWS from "@aws-sdk/client-ssm-incidents";
137+
const client = new AWS.SSMIncidents({ region: "REGION" });
138138

139139
// async/await.
140140
try {
@@ -200,7 +200,7 @@ visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).
200200

201201
## Contributing
202202

203-
This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-commander` package is updated.
203+
This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-ssm-incidents` package is updated.
204204
To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).
205205

206206
## License

clients/client-commander/Commander.ts renamed to clients/client-ssm-incidents/SSMIncidents.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { CommanderClient } from "./CommanderClient";
1+
import { SSMIncidentsClient } from "./SSMIncidentsClient";
22
import {
33
CreateReplicationSetCommand,
44
CreateReplicationSetCommandInput,
@@ -152,7 +152,7 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
152152
* critical incidents, Incident Manager automates response plans and enables responder team
153153
* escalation. </p>
154154
*/
155-
export class Commander extends CommanderClient {
155+
export class SSMIncidents extends SSMIncidentsClient {
156156
/**
157157
* <p>A replication set replicates and encrypts your data to the provided Regions with the
158158
* provided KMS key. </p>

clients/client-commander/CommanderClient.ts renamed to clients/client-ssm-incidents/SSMIncidentsClient.ts

+11-11
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
289289
defaultUserAgentProvider?: Provider<__UserAgent>;
290290
}
291291

292-
type CommanderClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
292+
type SSMIncidentsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
293293
ClientDefaults &
294294
RegionInputConfig &
295295
EndpointsInputConfig &
@@ -298,11 +298,11 @@ type CommanderClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOpti
298298
AwsAuthInputConfig &
299299
UserAgentInputConfig;
300300
/**
301-
* The configuration interface of CommanderClient class constructor that set the region, credentials and other options.
301+
* The configuration interface of SSMIncidentsClient class constructor that set the region, credentials and other options.
302302
*/
303-
export interface CommanderClientConfig extends CommanderClientConfigType {}
303+
export interface SSMIncidentsClientConfig extends SSMIncidentsClientConfigType {}
304304

305-
type CommanderClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
305+
type SSMIncidentsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
306306
Required<ClientDefaults> &
307307
RegionResolvedConfig &
308308
EndpointsResolvedConfig &
@@ -311,9 +311,9 @@ type CommanderClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHan
311311
AwsAuthResolvedConfig &
312312
UserAgentResolvedConfig;
313313
/**
314-
* The resolved configuration interface of CommanderClient class. This is resolved and normalized from the {@link CommanderClientConfig | constructor configuration interface}.
314+
* The resolved configuration interface of SSMIncidentsClient class. This is resolved and normalized from the {@link SSMIncidentsClientConfig | constructor configuration interface}.
315315
*/
316-
export interface CommanderClientResolvedConfig extends CommanderClientResolvedConfigType {}
316+
export interface SSMIncidentsClientResolvedConfig extends SSMIncidentsClientResolvedConfigType {}
317317

318318
/**
319319
* <p>AWS Systems Manager Incident Manager is an incident management console designed to help
@@ -325,18 +325,18 @@ export interface CommanderClientResolvedConfig extends CommanderClientResolvedCo
325325
* critical incidents, Incident Manager automates response plans and enables responder team
326326
* escalation. </p>
327327
*/
328-
export class CommanderClient extends __Client<
328+
export class SSMIncidentsClient extends __Client<
329329
__HttpHandlerOptions,
330330
ServiceInputTypes,
331331
ServiceOutputTypes,
332-
CommanderClientResolvedConfig
332+
SSMIncidentsClientResolvedConfig
333333
> {
334334
/**
335-
* The resolved configuration of CommanderClient class. This is resolved and normalized from the {@link CommanderClientConfig | constructor configuration interface}.
335+
* The resolved configuration of SSMIncidentsClient class. This is resolved and normalized from the {@link SSMIncidentsClientConfig | constructor configuration interface}.
336336
*/
337-
readonly config: CommanderClientResolvedConfig;
337+
readonly config: SSMIncidentsClientResolvedConfig;
338338

339-
constructor(configuration: CommanderClientConfig) {
339+
constructor(configuration: SSMIncidentsClientConfig) {
340340
let _config_0 = {
341341
...__ClientDefaultValues,
342342
...configuration,

clients/client-commander/commands/CreateReplicationSetCommand.ts renamed to clients/client-ssm-incidents/commands/CreateReplicationSetCommand.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { CommanderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CommanderClient";
1+
import { SSMIncidentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SSMIncidentsClient";
22
import { CreateReplicationSetInput, CreateReplicationSetOutput } from "../models/models_0";
33
import {
44
deserializeAws_restJson1CreateReplicationSetCommand,
@@ -26,22 +26,22 @@ export interface CreateReplicationSetCommandOutput extends CreateReplicationSetO
2626
* @example
2727
* Use a bare-bones client and the command you need to make an API call.
2828
* ```javascript
29-
* import { CommanderClient, CreateReplicationSetCommand } from "@aws-sdk/client-commander"; // ES Modules import
30-
* // const { CommanderClient, CreateReplicationSetCommand } = require("@aws-sdk/client-commander"); // CommonJS import
31-
* const client = new CommanderClient(config);
29+
* import { SSMIncidentsClient, CreateReplicationSetCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
30+
* // const { SSMIncidentsClient, CreateReplicationSetCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
31+
* const client = new SSMIncidentsClient(config);
3232
* const command = new CreateReplicationSetCommand(input);
3333
* const response = await client.send(command);
3434
* ```
3535
*
3636
* @see {@link CreateReplicationSetCommandInput} for command's `input` shape.
3737
* @see {@link CreateReplicationSetCommandOutput} for command's `response` shape.
38-
* @see {@link CommanderClientResolvedConfig | config} for command's `input` shape.
38+
* @see {@link SSMIncidentsClientResolvedConfig | config} for command's `input` shape.
3939
*
4040
*/
4141
export class CreateReplicationSetCommand extends $Command<
4242
CreateReplicationSetCommandInput,
4343
CreateReplicationSetCommandOutput,
44-
CommanderClientResolvedConfig
44+
SSMIncidentsClientResolvedConfig
4545
> {
4646
// Start section: command_properties
4747
// End section: command_properties
@@ -57,15 +57,15 @@ export class CreateReplicationSetCommand extends $Command<
5757
*/
5858
resolveMiddleware(
5959
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
60-
configuration: CommanderClientResolvedConfig,
60+
configuration: SSMIncidentsClientResolvedConfig,
6161
options?: __HttpHandlerOptions
6262
): Handler<CreateReplicationSetCommandInput, CreateReplicationSetCommandOutput> {
6363
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
6464

6565
const stack = clientStack.concat(this.middlewareStack);
6666

6767
const { logger } = configuration;
68-
const clientName = "CommanderClient";
68+
const clientName = "SSMIncidentsClient";
6969
const commandName = "CreateReplicationSetCommand";
7070
const handlerExecutionContext: HandlerExecutionContext = {
7171
logger,

clients/client-commander/commands/CreateResponsePlanCommand.ts renamed to clients/client-ssm-incidents/commands/CreateResponsePlanCommand.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { CommanderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CommanderClient";
1+
import { SSMIncidentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SSMIncidentsClient";
22
import { CreateResponsePlanInput, CreateResponsePlanOutput } from "../models/models_0";
33
import {
44
deserializeAws_restJson1CreateResponsePlanCommand,
@@ -28,22 +28,22 @@ export interface CreateResponsePlanCommandOutput extends CreateResponsePlanOutpu
2828
* @example
2929
* Use a bare-bones client and the command you need to make an API call.
3030
* ```javascript
31-
* import { CommanderClient, CreateResponsePlanCommand } from "@aws-sdk/client-commander"; // ES Modules import
32-
* // const { CommanderClient, CreateResponsePlanCommand } = require("@aws-sdk/client-commander"); // CommonJS import
33-
* const client = new CommanderClient(config);
31+
* import { SSMIncidentsClient, CreateResponsePlanCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
32+
* // const { SSMIncidentsClient, CreateResponsePlanCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
33+
* const client = new SSMIncidentsClient(config);
3434
* const command = new CreateResponsePlanCommand(input);
3535
* const response = await client.send(command);
3636
* ```
3737
*
3838
* @see {@link CreateResponsePlanCommandInput} for command's `input` shape.
3939
* @see {@link CreateResponsePlanCommandOutput} for command's `response` shape.
40-
* @see {@link CommanderClientResolvedConfig | config} for command's `input` shape.
40+
* @see {@link SSMIncidentsClientResolvedConfig | config} for command's `input` shape.
4141
*
4242
*/
4343
export class CreateResponsePlanCommand extends $Command<
4444
CreateResponsePlanCommandInput,
4545
CreateResponsePlanCommandOutput,
46-
CommanderClientResolvedConfig
46+
SSMIncidentsClientResolvedConfig
4747
> {
4848
// Start section: command_properties
4949
// End section: command_properties
@@ -59,15 +59,15 @@ export class CreateResponsePlanCommand extends $Command<
5959
*/
6060
resolveMiddleware(
6161
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
62-
configuration: CommanderClientResolvedConfig,
62+
configuration: SSMIncidentsClientResolvedConfig,
6363
options?: __HttpHandlerOptions
6464
): Handler<CreateResponsePlanCommandInput, CreateResponsePlanCommandOutput> {
6565
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
6666

6767
const stack = clientStack.concat(this.middlewareStack);
6868

6969
const { logger } = configuration;
70-
const clientName = "CommanderClient";
70+
const clientName = "SSMIncidentsClient";
7171
const commandName = "CreateResponsePlanCommand";
7272
const handlerExecutionContext: HandlerExecutionContext = {
7373
logger,

clients/client-commander/commands/CreateTimelineEventCommand.ts renamed to clients/client-ssm-incidents/commands/CreateTimelineEventCommand.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { CommanderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CommanderClient";
1+
import { SSMIncidentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SSMIncidentsClient";
22
import { CreateTimelineEventInput, CreateTimelineEventOutput } from "../models/models_0";
33
import {
44
deserializeAws_restJson1CreateTimelineEventCommand,
@@ -28,22 +28,22 @@ export interface CreateTimelineEventCommandOutput extends CreateTimelineEventOut
2828
* @example
2929
* Use a bare-bones client and the command you need to make an API call.
3030
* ```javascript
31-
* import { CommanderClient, CreateTimelineEventCommand } from "@aws-sdk/client-commander"; // ES Modules import
32-
* // const { CommanderClient, CreateTimelineEventCommand } = require("@aws-sdk/client-commander"); // CommonJS import
33-
* const client = new CommanderClient(config);
31+
* import { SSMIncidentsClient, CreateTimelineEventCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
32+
* // const { SSMIncidentsClient, CreateTimelineEventCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
33+
* const client = new SSMIncidentsClient(config);
3434
* const command = new CreateTimelineEventCommand(input);
3535
* const response = await client.send(command);
3636
* ```
3737
*
3838
* @see {@link CreateTimelineEventCommandInput} for command's `input` shape.
3939
* @see {@link CreateTimelineEventCommandOutput} for command's `response` shape.
40-
* @see {@link CommanderClientResolvedConfig | config} for command's `input` shape.
40+
* @see {@link SSMIncidentsClientResolvedConfig | config} for command's `input` shape.
4141
*
4242
*/
4343
export class CreateTimelineEventCommand extends $Command<
4444
CreateTimelineEventCommandInput,
4545
CreateTimelineEventCommandOutput,
46-
CommanderClientResolvedConfig
46+
SSMIncidentsClientResolvedConfig
4747
> {
4848
// Start section: command_properties
4949
// End section: command_properties
@@ -59,15 +59,15 @@ export class CreateTimelineEventCommand extends $Command<
5959
*/
6060
resolveMiddleware(
6161
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
62-
configuration: CommanderClientResolvedConfig,
62+
configuration: SSMIncidentsClientResolvedConfig,
6363
options?: __HttpHandlerOptions
6464
): Handler<CreateTimelineEventCommandInput, CreateTimelineEventCommandOutput> {
6565
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
6666

6767
const stack = clientStack.concat(this.middlewareStack);
6868

6969
const { logger } = configuration;
70-
const clientName = "CommanderClient";
70+
const clientName = "SSMIncidentsClient";
7171
const commandName = "CreateTimelineEventCommand";
7272
const handlerExecutionContext: HandlerExecutionContext = {
7373
logger,

clients/client-commander/commands/DeleteIncidentRecordCommand.ts renamed to clients/client-ssm-incidents/commands/DeleteIncidentRecordCommand.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { CommanderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CommanderClient";
1+
import { SSMIncidentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SSMIncidentsClient";
22
import { DeleteIncidentRecordInput, DeleteIncidentRecordOutput } from "../models/models_0";
33
import {
44
deserializeAws_restJson1DeleteIncidentRecordCommand,
@@ -25,22 +25,22 @@ export interface DeleteIncidentRecordCommandOutput extends DeleteIncidentRecordO
2525
* @example
2626
* Use a bare-bones client and the command you need to make an API call.
2727
* ```javascript
28-
* import { CommanderClient, DeleteIncidentRecordCommand } from "@aws-sdk/client-commander"; // ES Modules import
29-
* // const { CommanderClient, DeleteIncidentRecordCommand } = require("@aws-sdk/client-commander"); // CommonJS import
30-
* const client = new CommanderClient(config);
28+
* import { SSMIncidentsClient, DeleteIncidentRecordCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
29+
* // const { SSMIncidentsClient, DeleteIncidentRecordCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
30+
* const client = new SSMIncidentsClient(config);
3131
* const command = new DeleteIncidentRecordCommand(input);
3232
* const response = await client.send(command);
3333
* ```
3434
*
3535
* @see {@link DeleteIncidentRecordCommandInput} for command's `input` shape.
3636
* @see {@link DeleteIncidentRecordCommandOutput} for command's `response` shape.
37-
* @see {@link CommanderClientResolvedConfig | config} for command's `input` shape.
37+
* @see {@link SSMIncidentsClientResolvedConfig | config} for command's `input` shape.
3838
*
3939
*/
4040
export class DeleteIncidentRecordCommand extends $Command<
4141
DeleteIncidentRecordCommandInput,
4242
DeleteIncidentRecordCommandOutput,
43-
CommanderClientResolvedConfig
43+
SSMIncidentsClientResolvedConfig
4444
> {
4545
// Start section: command_properties
4646
// End section: command_properties
@@ -56,15 +56,15 @@ export class DeleteIncidentRecordCommand extends $Command<
5656
*/
5757
resolveMiddleware(
5858
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
59-
configuration: CommanderClientResolvedConfig,
59+
configuration: SSMIncidentsClientResolvedConfig,
6060
options?: __HttpHandlerOptions
6161
): Handler<DeleteIncidentRecordCommandInput, DeleteIncidentRecordCommandOutput> {
6262
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
6363

6464
const stack = clientStack.concat(this.middlewareStack);
6565

6666
const { logger } = configuration;
67-
const clientName = "CommanderClient";
67+
const clientName = "SSMIncidentsClient";
6868
const commandName = "DeleteIncidentRecordCommand";
6969
const handlerExecutionContext: HandlerExecutionContext = {
7070
logger,

0 commit comments

Comments
 (0)