Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(client-ssm-incidents): rename client-commander package to client-ssm-incidents #2431

Merged
merged 3 commits into from
May 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions clients/client-commander/CHANGELOG.md

This file was deleted.

7 changes: 0 additions & 7 deletions clients/client-commander/pagination/Interfaces.ts

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# @aws-sdk/client-commander
# @aws-sdk/client-ssm-incidents

[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-commander/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-commander)
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-commander.svg)](https://www.npmjs.com/package/@aws-sdk/client-commander)
[![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)
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-ssm-incidents.svg)](https://www.npmjs.com/package/@aws-sdk/client-ssm-incidents)

## Description

AWS SDK for JavaScript Commander Client for Node.js, Browser and React Native.
AWS SDK for JavaScript SSMIncidents Client for Node.js, Browser and React Native.

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

## Installing

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

- `npm install @aws-sdk/client-commander`
- `yarn add @aws-sdk/client-commander`
- `pnpm add @aws-sdk/client-commander`
- `npm install @aws-sdk/client-ssm-incidents`
- `yarn add @aws-sdk/client-ssm-incidents`
- `pnpm add @aws-sdk/client-ssm-incidents`

## Getting Started

### Import

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

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

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

### Usage
Expand All @@ -54,7 +54,7 @@ To send a request, you:

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

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

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

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

## Contributing

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

## License
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { CommanderClient } from "./CommanderClient";
import { SSMIncidentsClient } from "./SSMIncidentsClient";
import {
CreateReplicationSetCommand,
CreateReplicationSetCommandInput,
Expand Down Expand Up @@ -152,7 +152,7 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
* critical incidents, Incident Manager automates response plans and enables responder team
* escalation. </p>
*/
export class Commander extends CommanderClient {
export class SSMIncidents extends SSMIncidentsClient {
/**
* <p>A replication set replicates and encrypts your data to the provided Regions with the
* provided KMS key. </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
defaultUserAgentProvider?: Provider<__UserAgent>;
}

type CommanderClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
type SSMIncidentsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointsInputConfig &
Expand All @@ -298,11 +298,11 @@ type CommanderClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOpti
AwsAuthInputConfig &
UserAgentInputConfig;
/**
* The configuration interface of CommanderClient class constructor that set the region, credentials and other options.
* The configuration interface of SSMIncidentsClient class constructor that set the region, credentials and other options.
*/
export interface CommanderClientConfig extends CommanderClientConfigType {}
export interface SSMIncidentsClientConfig extends SSMIncidentsClientConfigType {}

type CommanderClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
type SSMIncidentsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointsResolvedConfig &
Expand All @@ -311,9 +311,9 @@ type CommanderClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHan
AwsAuthResolvedConfig &
UserAgentResolvedConfig;
/**
* The resolved configuration interface of CommanderClient class. This is resolved and normalized from the {@link CommanderClientConfig | constructor configuration interface}.
* The resolved configuration interface of SSMIncidentsClient class. This is resolved and normalized from the {@link SSMIncidentsClientConfig | constructor configuration interface}.
*/
export interface CommanderClientResolvedConfig extends CommanderClientResolvedConfigType {}
export interface SSMIncidentsClientResolvedConfig extends SSMIncidentsClientResolvedConfigType {}

/**
* <p>AWS Systems Manager Incident Manager is an incident management console designed to help
Expand All @@ -325,18 +325,18 @@ export interface CommanderClientResolvedConfig extends CommanderClientResolvedCo
* critical incidents, Incident Manager automates response plans and enables responder team
* escalation. </p>
*/
export class CommanderClient extends __Client<
export class SSMIncidentsClient extends __Client<
__HttpHandlerOptions,
ServiceInputTypes,
ServiceOutputTypes,
CommanderClientResolvedConfig
SSMIncidentsClientResolvedConfig
> {
/**
* The resolved configuration of CommanderClient class. This is resolved and normalized from the {@link CommanderClientConfig | constructor configuration interface}.
* The resolved configuration of SSMIncidentsClient class. This is resolved and normalized from the {@link SSMIncidentsClientConfig | constructor configuration interface}.
*/
readonly config: CommanderClientResolvedConfig;
readonly config: SSMIncidentsClientResolvedConfig;

constructor(configuration: CommanderClientConfig) {
constructor(configuration: SSMIncidentsClientConfig) {
let _config_0 = {
...__ClientDefaultValues,
...configuration,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { CommanderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CommanderClient";
import { SSMIncidentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SSMIncidentsClient";
import { CreateReplicationSetInput, CreateReplicationSetOutput } from "../models/models_0";
import {
deserializeAws_restJson1CreateReplicationSetCommand,
Expand Down Expand Up @@ -26,22 +26,22 @@ export interface CreateReplicationSetCommandOutput extends CreateReplicationSetO
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { CommanderClient, CreateReplicationSetCommand } from "@aws-sdk/client-commander"; // ES Modules import
* // const { CommanderClient, CreateReplicationSetCommand } = require("@aws-sdk/client-commander"); // CommonJS import
* const client = new CommanderClient(config);
* import { SSMIncidentsClient, CreateReplicationSetCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
* // const { SSMIncidentsClient, CreateReplicationSetCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
* const client = new SSMIncidentsClient(config);
* const command = new CreateReplicationSetCommand(input);
* const response = await client.send(command);
* ```
*
* @see {@link CreateReplicationSetCommandInput} for command's `input` shape.
* @see {@link CreateReplicationSetCommandOutput} for command's `response` shape.
* @see {@link CommanderClientResolvedConfig | config} for command's `input` shape.
* @see {@link SSMIncidentsClientResolvedConfig | config} for command's `input` shape.
*
*/
export class CreateReplicationSetCommand extends $Command<
CreateReplicationSetCommandInput,
CreateReplicationSetCommandOutput,
CommanderClientResolvedConfig
SSMIncidentsClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
Expand All @@ -57,15 +57,15 @@ export class CreateReplicationSetCommand extends $Command<
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: CommanderClientResolvedConfig,
configuration: SSMIncidentsClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<CreateReplicationSetCommandInput, CreateReplicationSetCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));

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

const { logger } = configuration;
const clientName = "CommanderClient";
const clientName = "SSMIncidentsClient";
const commandName = "CreateReplicationSetCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { CommanderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CommanderClient";
import { SSMIncidentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SSMIncidentsClient";
import { CreateResponsePlanInput, CreateResponsePlanOutput } from "../models/models_0";
import {
deserializeAws_restJson1CreateResponsePlanCommand,
Expand Down Expand Up @@ -28,22 +28,22 @@ export interface CreateResponsePlanCommandOutput extends CreateResponsePlanOutpu
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { CommanderClient, CreateResponsePlanCommand } from "@aws-sdk/client-commander"; // ES Modules import
* // const { CommanderClient, CreateResponsePlanCommand } = require("@aws-sdk/client-commander"); // CommonJS import
* const client = new CommanderClient(config);
* import { SSMIncidentsClient, CreateResponsePlanCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
* // const { SSMIncidentsClient, CreateResponsePlanCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
* const client = new SSMIncidentsClient(config);
* const command = new CreateResponsePlanCommand(input);
* const response = await client.send(command);
* ```
*
* @see {@link CreateResponsePlanCommandInput} for command's `input` shape.
* @see {@link CreateResponsePlanCommandOutput} for command's `response` shape.
* @see {@link CommanderClientResolvedConfig | config} for command's `input` shape.
* @see {@link SSMIncidentsClientResolvedConfig | config} for command's `input` shape.
*
*/
export class CreateResponsePlanCommand extends $Command<
CreateResponsePlanCommandInput,
CreateResponsePlanCommandOutput,
CommanderClientResolvedConfig
SSMIncidentsClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
Expand All @@ -59,15 +59,15 @@ export class CreateResponsePlanCommand extends $Command<
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: CommanderClientResolvedConfig,
configuration: SSMIncidentsClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<CreateResponsePlanCommandInput, CreateResponsePlanCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));

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

const { logger } = configuration;
const clientName = "CommanderClient";
const clientName = "SSMIncidentsClient";
const commandName = "CreateResponsePlanCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { CommanderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CommanderClient";
import { SSMIncidentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SSMIncidentsClient";
import { CreateTimelineEventInput, CreateTimelineEventOutput } from "../models/models_0";
import {
deserializeAws_restJson1CreateTimelineEventCommand,
Expand Down Expand Up @@ -28,22 +28,22 @@ export interface CreateTimelineEventCommandOutput extends CreateTimelineEventOut
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { CommanderClient, CreateTimelineEventCommand } from "@aws-sdk/client-commander"; // ES Modules import
* // const { CommanderClient, CreateTimelineEventCommand } = require("@aws-sdk/client-commander"); // CommonJS import
* const client = new CommanderClient(config);
* import { SSMIncidentsClient, CreateTimelineEventCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
* // const { SSMIncidentsClient, CreateTimelineEventCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
* const client = new SSMIncidentsClient(config);
* const command = new CreateTimelineEventCommand(input);
* const response = await client.send(command);
* ```
*
* @see {@link CreateTimelineEventCommandInput} for command's `input` shape.
* @see {@link CreateTimelineEventCommandOutput} for command's `response` shape.
* @see {@link CommanderClientResolvedConfig | config} for command's `input` shape.
* @see {@link SSMIncidentsClientResolvedConfig | config} for command's `input` shape.
*
*/
export class CreateTimelineEventCommand extends $Command<
CreateTimelineEventCommandInput,
CreateTimelineEventCommandOutput,
CommanderClientResolvedConfig
SSMIncidentsClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
Expand All @@ -59,15 +59,15 @@ export class CreateTimelineEventCommand extends $Command<
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: CommanderClientResolvedConfig,
configuration: SSMIncidentsClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<CreateTimelineEventCommandInput, CreateTimelineEventCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));

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

const { logger } = configuration;
const clientName = "CommanderClient";
const clientName = "SSMIncidentsClient";
const commandName = "CreateTimelineEventCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { CommanderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CommanderClient";
import { SSMIncidentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SSMIncidentsClient";
import { DeleteIncidentRecordInput, DeleteIncidentRecordOutput } from "../models/models_0";
import {
deserializeAws_restJson1DeleteIncidentRecordCommand,
Expand All @@ -25,22 +25,22 @@ export interface DeleteIncidentRecordCommandOutput extends DeleteIncidentRecordO
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { CommanderClient, DeleteIncidentRecordCommand } from "@aws-sdk/client-commander"; // ES Modules import
* // const { CommanderClient, DeleteIncidentRecordCommand } = require("@aws-sdk/client-commander"); // CommonJS import
* const client = new CommanderClient(config);
* import { SSMIncidentsClient, DeleteIncidentRecordCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
* // const { SSMIncidentsClient, DeleteIncidentRecordCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
* const client = new SSMIncidentsClient(config);
* const command = new DeleteIncidentRecordCommand(input);
* const response = await client.send(command);
* ```
*
* @see {@link DeleteIncidentRecordCommandInput} for command's `input` shape.
* @see {@link DeleteIncidentRecordCommandOutput} for command's `response` shape.
* @see {@link CommanderClientResolvedConfig | config} for command's `input` shape.
* @see {@link SSMIncidentsClientResolvedConfig | config} for command's `input` shape.
*
*/
export class DeleteIncidentRecordCommand extends $Command<
DeleteIncidentRecordCommandInput,
DeleteIncidentRecordCommandOutput,
CommanderClientResolvedConfig
SSMIncidentsClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
Expand All @@ -56,15 +56,15 @@ export class DeleteIncidentRecordCommand extends $Command<
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: CommanderClientResolvedConfig,
configuration: SSMIncidentsClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<DeleteIncidentRecordCommandInput, DeleteIncidentRecordCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));

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

const { logger } = configuration;
const clientName = "CommanderClient";
const clientName = "SSMIncidentsClient";
const commandName = "DeleteIncidentRecordCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
Expand Down
Loading