@aws-sdk/client-appintegrations 3.420.0 → 3.423.0

package/README.md

@@ -29,16 +29,16 @@ using your favorite package manager:
 
 The AWS SDK is modulized by clients and commands.
 To send a request, you only need to import the `AppIntegrationsClient` and
-the commands you need, for example `CreateApplicationCommand`:
+the commands you need, for example `ListApplicationsCommand`:
 
 ```js
 // ES5 example
-const { AppIntegrationsClient, CreateApplicationCommand } = require("@aws-sdk/client-appintegrations");
+const { AppIntegrationsClient, ListApplicationsCommand } = require("@aws-sdk/client-appintegrations");
 ```
 
 ```ts
 // ES6+ example
-import { AppIntegrationsClient, CreateApplicationCommand } from "@aws-sdk/client-appintegrations";
+import { AppIntegrationsClient, ListApplicationsCommand } from "@aws-sdk/client-appintegrations";
 ```
 
 ### Usage
@@ -57,7 +57,7 @@ const client = new AppIntegrationsClient({ region: "REGION" });
 const params = {
   /** input parameters */
 };
-const command = new CreateApplicationCommand(params);
+const command = new ListApplicationsCommand(params);
 ```
 
 #### Async/await
@@ -136,7 +136,7 @@ const client = new AWS.AppIntegrations({ region: "REGION" });
 
 // async/await.
 try {
-  const data = await client.createApplication(params);
+  const data = await client.listApplications(params);
   // process data.
 } catch (error) {
   // error handling.
@@ -144,7 +144,7 @@ try {
 
 // Promises.
 client
-  .createApplication(params)
+  .listApplications(params)
   .then((data) => {
     // process data.
   })
@@ -153,7 +153,7 @@ client
   });
 
 // callbacks.
-client.createApplication(params, (err, data) => {
+client.listApplications(params, (err, data) => {
   // process err and data.
 });
 ```

package/dist-types/commands/CreateApplicationCommand.d.ts

@@ -97,6 +97,30 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
  * @throws {@link AppIntegrationsServiceException}
  * <p>Base exception class for all service exceptions from AppIntegrations service.</p>
  *
+ * @example To create an application
+ * ```javascript
+ * // The following creates an application named My Application with access url https://example.com.
+ * const input = {
+ *   "ApplicationSourceConfig": {
+ *     "ExternalUrlConfig": {
+ *       "AccessUrl": "https://example.com"
+ *     }
+ *   },
+ *   "Description": "My first application.",
+ *   "Name": "My Application",
+ *   "Namespace": "myapplication"
+ * };
+ * const command = new CreateApplicationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Arn": "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e",
+ *   "Id": "98542c53-e8ac-4570-9c85-c6552c8d9c5e"
+ * }
+ * *\/
+ * // example id: create-an-application
+ * ```
+ *
  */
 export declare class CreateApplicationCommand extends $Command<CreateApplicationCommandInput, CreateApplicationCommandOutput, AppIntegrationsClientResolvedConfig> {
     readonly input: CreateApplicationCommandInput;

package/dist-types/commands/GetApplicationCommand.d.ts

@@ -96,6 +96,29 @@ export interface GetApplicationCommandOutput extends GetApplicationResponse, __M
  * @throws {@link AppIntegrationsServiceException}
  * <p>Base exception class for all service exceptions from AppIntegrations service.</p>
  *
+ * @example To get an application
+ * ```javascript
+ * // The following retrives an application.
+ * const input = {
+ *   "Arn": "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e"
+ * };
+ * const command = new GetApplicationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationSourceConfig": {
+ *     "ExternalUrlConfig": {
+ *       "AccessUrl": "https://example.com"
+ *     }
+ *   },
+ *   "Description": "My first application.",
+ *   "Name": "My Application",
+ *   "Namespace": "myapplication"
+ * }
+ * *\/
+ * // example id: get-an-application
+ * ```
+ *
  */
 export declare class GetApplicationCommand extends $Command<GetApplicationCommandInput, GetApplicationCommandOutput, AppIntegrationsClientResolvedConfig> {
     readonly input: GetApplicationCommandInput;

package/dist-types/commands/ListApplicationsCommand.d.ts

@@ -74,6 +74,30 @@ export interface ListApplicationsCommandOutput extends ListApplicationsResponse,
  * @throws {@link AppIntegrationsServiceException}
  * <p>Base exception class for all service exceptions from AppIntegrations service.</p>
  *
+ * @example To list applications in the account
+ * ```javascript
+ * // The following lists application summary in the account.
+ * const input = {
+ *   "MaxResults": 1
+ * };
+ * const command = new ListApplicationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Applications": [
+ *     {
+ *       "Arn": "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e",
+ *       "Id": "98542c53-e8ac-4570-9c85-c6552c8d9c5e",
+ *       "Name": "My Application",
+ *       "Namespace": "myapplication"
+ *     }
+ *   ],
+ *   "NextToken": "abc"
+ * }
+ * *\/
+ * // example id: list-applications
+ * ```
+ *
  */
 export declare class ListApplicationsCommand extends $Command<ListApplicationsCommandInput, ListApplicationsCommandOutput, AppIntegrationsClientResolvedConfig> {
     readonly input: ListApplicationsCommandInput;

package/dist-types/commands/UpdateApplicationCommand.d.ts

@@ -87,6 +87,18 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons
  * @throws {@link AppIntegrationsServiceException}
  * <p>Base exception class for all service exceptions from AppIntegrations service.</p>
  *
+ * @example To update an application
+ * ```javascript
+ * // The following updates an existing application named with a new name.
+ * const input = {
+ *   "Arn": "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e",
+ *   "Name": "My New Application Name"
+ * };
+ * const command = new UpdateApplicationCommand(input);
+ * await client.send(command);
+ * // example id: update-an-application
+ * ```
+ *
  */
 export declare class UpdateApplicationCommand extends $Command<UpdateApplicationCommandInput, UpdateApplicationCommandOutput, AppIntegrationsClientResolvedConfig> {
     readonly input: UpdateApplicationCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-appintegrations",
   "description": "AWS SDK for JavaScript Appintegrations Client for Node.js, Browser and React Native",
-  "version": "3.420.0",
+  "version": "3.423.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,8 +21,8 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.418.0",
-    "@aws-sdk/credential-provider-node": "3.418.0",
+    "@aws-sdk/client-sts": "3.423.0",
+    "@aws-sdk/credential-provider-node": "3.423.0",
     "@aws-sdk/middleware-host-header": "3.418.0",
     "@aws-sdk/middleware-logger": "3.418.0",
     "@aws-sdk/middleware-recursion-detection": "3.418.0",