@aws-sdk/client-appintegrations 3.418.0 → 3.421.0

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

@@ -0,0 +1,144 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { AppIntegrationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppIntegrationsClient";
+import { CreateApplicationRequest, CreateApplicationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateApplicationCommand}.
+ */
+export interface CreateApplicationCommandInput extends CreateApplicationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateApplicationCommand}.
+ */
+export interface CreateApplicationCommandOutput extends CreateApplicationResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>This API is in preview release and subject to change.</p>
+ *          <p>Creates and persists an Application resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppIntegrationsClient, CreateApplicationCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import
+ * // const { AppIntegrationsClient, CreateApplicationCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import
+ * const client = new AppIntegrationsClient(config);
+ * const input = { // CreateApplicationRequest
+ *   Name: "STRING_VALUE", // required
+ *   Namespace: "STRING_VALUE", // required
+ *   Description: "STRING_VALUE",
+ *   ApplicationSourceConfig: { // ApplicationSourceConfig
+ *     ExternalUrlConfig: { // ExternalUrlConfig
+ *       AccessUrl: "STRING_VALUE", // required
+ *       ApprovedOrigins: [ // ApplicationApprovedOrigins
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
+ *   Subscriptions: [ // SubscriptionList
+ *     { // Subscription
+ *       Event: "STRING_VALUE", // required
+ *       Description: "STRING_VALUE",
+ *     },
+ *   ],
+ *   Publications: [ // PublicationList
+ *     { // Publication
+ *       Event: "STRING_VALUE", // required
+ *       Schema: "STRING_VALUE", // required
+ *       Description: "STRING_VALUE",
+ *     },
+ *   ],
+ *   ClientToken: "STRING_VALUE",
+ *   Tags: { // TagMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new CreateApplicationCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateApplicationResponse
+ * //   Arn: "STRING_VALUE",
+ * //   Id: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param CreateApplicationCommandInput - {@link CreateApplicationCommandInput}
+ * @returns {@link CreateApplicationCommandOutput}
+ * @see {@link CreateApplicationCommandInput} for command's `input` shape.
+ * @see {@link CreateApplicationCommandOutput} for command's `response` shape.
+ * @see {@link AppIntegrationsClientResolvedConfig | config} for AppIntegrationsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link DuplicateResourceException} (client fault)
+ *  <p>A resource with the specified name already exists.</p>
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>Request processing failed due to an error or failure with the service.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is not valid. </p>
+ *
+ * @throws {@link ResourceQuotaExceededException} (client fault)
+ *  <p>The allowed quota for the resource has been exceeded.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</p>
+ *
+ * @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;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: CreateApplicationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppIntegrationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateApplicationCommandInput, CreateApplicationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,142 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { AppIntegrationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppIntegrationsClient";
+import { GetApplicationRequest, GetApplicationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetApplicationCommand}.
+ */
+export interface GetApplicationCommandInput extends GetApplicationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetApplicationCommand}.
+ */
+export interface GetApplicationCommandOutput extends GetApplicationResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>This API is in preview release and subject to change.</p>
+ *          <p>Get an Application resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppIntegrationsClient, GetApplicationCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import
+ * // const { AppIntegrationsClient, GetApplicationCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import
+ * const client = new AppIntegrationsClient(config);
+ * const input = { // GetApplicationRequest
+ *   Arn: "STRING_VALUE", // required
+ * };
+ * const command = new GetApplicationCommand(input);
+ * const response = await client.send(command);
+ * // { // GetApplicationResponse
+ * //   Arn: "STRING_VALUE",
+ * //   Id: "STRING_VALUE",
+ * //   Name: "STRING_VALUE",
+ * //   Namespace: "STRING_VALUE",
+ * //   Description: "STRING_VALUE",
+ * //   ApplicationSourceConfig: { // ApplicationSourceConfig
+ * //     ExternalUrlConfig: { // ExternalUrlConfig
+ * //       AccessUrl: "STRING_VALUE", // required
+ * //       ApprovedOrigins: [ // ApplicationApprovedOrigins
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   },
+ * //   Subscriptions: [ // SubscriptionList
+ * //     { // Subscription
+ * //       Event: "STRING_VALUE", // required
+ * //       Description: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   Publications: [ // PublicationList
+ * //     { // Publication
+ * //       Event: "STRING_VALUE", // required
+ * //       Schema: "STRING_VALUE", // required
+ * //       Description: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   CreatedTime: new Date("TIMESTAMP"),
+ * //   LastModifiedTime: new Date("TIMESTAMP"),
+ * //   Tags: { // TagMap
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetApplicationCommandInput - {@link GetApplicationCommandInput}
+ * @returns {@link GetApplicationCommandOutput}
+ * @see {@link GetApplicationCommandInput} for command's `input` shape.
+ * @see {@link GetApplicationCommandOutput} for command's `response` shape.
+ * @see {@link AppIntegrationsClientResolvedConfig | config} for AppIntegrationsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>Request processing failed due to an error or failure with the service.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is not valid. </p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</p>
+ *
+ * @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;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetApplicationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppIntegrationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetApplicationCommandInput, GetApplicationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,121 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { AppIntegrationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppIntegrationsClient";
+import { ListApplicationsRequest, ListApplicationsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListApplicationsCommand}.
+ */
+export interface ListApplicationsCommandInput extends ListApplicationsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListApplicationsCommand}.
+ */
+export interface ListApplicationsCommandOutput extends ListApplicationsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>This API is in preview release and subject to change.</p>
+ *          <p>Lists applications in the account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppIntegrationsClient, ListApplicationsCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import
+ * // const { AppIntegrationsClient, ListApplicationsCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import
+ * const client = new AppIntegrationsClient(config);
+ * const input = { // ListApplicationsRequest
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new ListApplicationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListApplicationsResponse
+ * //   Applications: [ // ApplicationsList
+ * //     { // ApplicationSummary
+ * //       Arn: "STRING_VALUE",
+ * //       Id: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       Namespace: "STRING_VALUE",
+ * //       CreatedTime: new Date("TIMESTAMP"),
+ * //       LastModifiedTime: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListApplicationsCommandInput - {@link ListApplicationsCommandInput}
+ * @returns {@link ListApplicationsCommandOutput}
+ * @see {@link ListApplicationsCommandInput} for command's `input` shape.
+ * @see {@link ListApplicationsCommandOutput} for command's `response` shape.
+ * @see {@link AppIntegrationsClientResolvedConfig | config} for AppIntegrationsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>Request processing failed due to an error or failure with the service.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is not valid. </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</p>
+ *
+ * @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;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListApplicationsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppIntegrationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListApplicationsCommandInput, ListApplicationsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,122 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { AppIntegrationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppIntegrationsClient";
+import { UpdateApplicationRequest, UpdateApplicationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateApplicationCommand}.
+ */
+export interface UpdateApplicationCommandInput extends UpdateApplicationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateApplicationCommand}.
+ */
+export interface UpdateApplicationCommandOutput extends UpdateApplicationResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>This API is in preview release and subject to change.</p>
+ *          <p>Updates and persists an Application resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppIntegrationsClient, UpdateApplicationCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import
+ * // const { AppIntegrationsClient, UpdateApplicationCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import
+ * const client = new AppIntegrationsClient(config);
+ * const input = { // UpdateApplicationRequest
+ *   Arn: "STRING_VALUE", // required
+ *   Name: "STRING_VALUE",
+ *   Description: "STRING_VALUE",
+ *   ApplicationSourceConfig: { // ApplicationSourceConfig
+ *     ExternalUrlConfig: { // ExternalUrlConfig
+ *       AccessUrl: "STRING_VALUE", // required
+ *       ApprovedOrigins: [ // ApplicationApprovedOrigins
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
+ *   Subscriptions: [ // SubscriptionList
+ *     { // Subscription
+ *       Event: "STRING_VALUE", // required
+ *       Description: "STRING_VALUE",
+ *     },
+ *   ],
+ *   Publications: [ // PublicationList
+ *     { // Publication
+ *       Event: "STRING_VALUE", // required
+ *       Schema: "STRING_VALUE", // required
+ *       Description: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
+ * const command = new UpdateApplicationCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateApplicationCommandInput - {@link UpdateApplicationCommandInput}
+ * @returns {@link UpdateApplicationCommandOutput}
+ * @see {@link UpdateApplicationCommandInput} for command's `input` shape.
+ * @see {@link UpdateApplicationCommandOutput} for command's `response` shape.
+ * @see {@link AppIntegrationsClientResolvedConfig | config} for AppIntegrationsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>Request processing failed due to an error or failure with the service.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is not valid. </p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</p>
+ *
+ * @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;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateApplicationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppIntegrationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateApplicationCommandInput, UpdateApplicationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,9 +1,12 @@
+export * from "./CreateApplicationCommand";
 export * from "./CreateDataIntegrationCommand";
 export * from "./CreateEventIntegrationCommand";
 export * from "./DeleteDataIntegrationCommand";
 export * from "./DeleteEventIntegrationCommand";
+export * from "./GetApplicationCommand";
 export * from "./GetDataIntegrationCommand";
 export * from "./GetEventIntegrationCommand";
+export * from "./ListApplicationsCommand";
 export * from "./ListDataIntegrationAssociationsCommand";
 export * from "./ListDataIntegrationsCommand";
 export * from "./ListEventIntegrationAssociationsCommand";
@@ -11,5 +14,6 @@ export * from "./ListEventIntegrationsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateApplicationCommand";
 export * from "./UpdateDataIntegrationCommand";
 export * from "./UpdateEventIntegrationCommand";

package/dist-types/index.d.ts

@@ -13,5 +13,6 @@ export * from "./AppIntegrationsClient";
 export * from "./AppIntegrations";
 export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export * from "./commands";
+export * from "./pagination";
 export * from "./models";
 export { AppIntegrationsServiceException } from "./models/AppIntegrationsServiceException";