@aws-sdk/client-qapps 3.702.0 → 3.705.0

package/dist-types/models/models_0.d.ts

@@ -135,13 +135,11 @@ export interface FormInputCard {
      */
     metadata: FormInputCardMetadata | undefined;
     /**
-     * <p>The compute mode of the form input card.
-     *       This property determines whether individual participants of a
-     *       data collection session can submit multiple response or one response.
-     *       A compute mode of <code>append</code> shall allow participants
-     *       to submit the same form multiple times with different values.
-     *       A compute mode of <code>replace</code>code&gt; shall overwrite
-     *       the current value for each participant.</p>
+     * <p>The compute mode of the form input card. This property determines whether individual
+     *       participants of a data collection session can submit multiple response or one response. A
+     *       compute mode of <code>append</code> shall allow participants to submit the same form multiple
+     *       times with different values. A compute mode of <code>replace</code>code&gt; shall overwrite the
+     *       current value for each participant.</p>
      * @public
      */
     computeMode?: InputCardComputeMode | undefined;
@@ -151,11 +149,22 @@ export interface FormInputCard {
  * @enum
  */
 export declare const PluginType: {
+    readonly ASANA: "ASANA";
+    readonly ATLASSIAN_CONFLUENCE: "ATLASSIAN_CONFLUENCE";
     readonly CUSTOM: "CUSTOM";
+    readonly GOOGLE_CALENDAR: "GOOGLE_CALENDAR";
     readonly JIRA: "JIRA";
+    readonly JIRA_CLOUD: "JIRA_CLOUD";
+    readonly MICROSOFT_EXCHANGE: "MICROSOFT_EXCHANGE";
+    readonly MICROSOFT_TEAMS: "MICROSOFT_TEAMS";
+    readonly PAGERDUTY_ADVANCE: "PAGERDUTY_ADVANCE";
     readonly SALESFORCE: "SALESFORCE";
+    readonly SALESFORCE_CRM: "SALESFORCE_CRM";
+    readonly SERVICENOW_NOW_PLATFORM: "SERVICENOW_NOW_PLATFORM";
     readonly SERVICE_NOW: "SERVICE_NOW";
+    readonly SMARTSHEET: "SMARTSHEET";
     readonly ZENDESK: "ZENDESK";
+    readonly ZENDESK_SUITE: "ZENDESK_SUITE";
 };
 /**
  * @public
@@ -201,6 +210,11 @@ export interface QPluginCard {
      * @public
      */
     pluginId: string | undefined;
+    /**
+     * <p>The action identifier of the action to be performed by the plugin card.</p>
+     * @public
+     */
+    actionIdentifier?: string | undefined;
 }
 /**
  * <p>The value of a document attribute. You can only provide one value for a document
@@ -247,9 +261,10 @@ export declare namespace DocumentAttributeValue {
     }
     /**
      * <p>A date expressed as an ISO 8601 string.</p>
-     *          <p>It's important for the time zone to be included in the <i>ISO 8601 date-time</i> format. For
-     *       example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012
-     *       at 12:30PM (plus 10 seconds) in Central European Time. </p>
+     *          <p>It's important for the time zone to be included in the <i>ISO 8601
+     *         date-time</i> format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601
+     *       date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
+     *     </p>
      * @public
      */
     interface DateValueMember {
@@ -343,9 +358,8 @@ export interface TextInputCard {
     defaultValue?: string | undefined;
 }
 /**
- * <p>Represents a file upload card. It can optionally
- *       receive a <code>filename</code> and <code>fileId</code> to set a
- *       default file.  If not received, the user must provide the file
+ * <p>Represents a file upload card. It can optionally receive a <code>filename</code> and
+ *         <code>fileId</code> to set a default file. If not received, the user must provide the file
  *       when the Q App runs.</p>
  * @public
  */
@@ -407,13 +421,11 @@ export interface FormInputCardInput {
      */
     metadata: FormInputCardMetadata | undefined;
     /**
-     * <p>The compute mode of the form input card.
-     *       This property determines whether individual participants of a
-     *       data collection session can submit multiple response or one response.
-     *       A compute mode of <code>append</code> shall allow participants
-     *       to submit the same form multiple times with different values.
-     *       A compute mode of <code>replace</code>code&gt; shall overwrite
-     *       the current value for each participant.</p>
+     * <p>The compute mode of the form input card. This property determines whether individual
+     *       participants of a data collection session can submit multiple response or one response. A
+     *       compute mode of <code>append</code> shall allow participants to submit the same form multiple
+     *       times with different values. A compute mode of <code>replace</code>code&gt; shall overwrite the
+     *       current value for each participant.</p>
      * @public
      */
     computeMode?: InputCardComputeMode | undefined;
@@ -448,6 +460,11 @@ export interface QPluginCardInput {
      * @public
      */
     pluginId: string | undefined;
+    /**
+     * <p>The action identifier of the action to be performed by the plugin card.</p>
+     * @public
+     */
+    actionIdentifier?: string | undefined;
 }
 /**
  * <p>The input shape for defining a text input card in an Amazon Q App.</p>
@@ -523,8 +540,8 @@ export interface AssociateLibraryItemReviewInput {
     libraryItemId: string | undefined;
 }
 /**
- * <p>The requested operation could not be completed due to a
- *       conflict with the current state of the resource.</p>
+ * <p>The requested operation could not be completed due to a conflict with the current state of
+ *       the resource.</p>
  * @public
  */
 export declare class ConflictException extends __BaseException {
@@ -586,8 +603,8 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
- * <p>The requested operation could not be completed because
- *       it would exceed the service's quota or limit.</p>
+ * <p>The requested operation could not be completed because it would exceed the service's quota
+ *       or limit.</p>
  * @public
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -619,8 +636,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
- * <p>The requested operation could not be completed because too many
- *       requests were sent at once. Wait a bit and try again later.</p>
+ * <p>The requested operation could not be completed because too many requests were sent at
+ *       once. Wait a bit and try again later.</p>
  * @public
  */
 export declare class ThrottlingException extends __BaseException {
@@ -694,7 +711,8 @@ export interface AssociateQAppWithUserInput {
  */
 export interface BatchCreateCategoryInputCategory {
     /**
-     * <p>The unique identifier to be associated with a category. If you don't include a value, the category is automatically assigned a unique identifier.</p>
+     * <p>The unique identifier to be associated with a category. If you don't include a value, the
+     *       category is automatically assigned a unique identifier.</p>
      * @public
      */
     id?: string | undefined;
@@ -704,7 +722,8 @@ export interface BatchCreateCategoryInputCategory {
      */
     title: string | undefined;
     /**
-     * <p>The color to be associated with a category. The color must be a hexadecimal value of either 3 or 6 digits.</p>
+     * <p>The color to be associated with a category. The color must be a hexadecimal value of
+     *       either 3 or 6 digits.</p>
      * @public
      */
     color?: string | undefined;
@@ -740,7 +759,8 @@ export interface BatchDeleteCategoryInput {
     categories: string[] | undefined;
 }
 /**
- * <p>A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.</p>
+ * <p>A label that web experience users associate with a library item. Web experience users use
+ *       Categories to tag and filter library items.</p>
  * @public
  */
 export interface CategoryInput {
@@ -755,7 +775,8 @@ export interface CategoryInput {
      */
     title: string | undefined;
     /**
-     * <p>The color of the category, represented as a hexadecimal value of either 3 or 6 digits.</p>
+     * <p>The color of the category, represented as a hexadecimal value of either 3 or 6
+     *       digits.</p>
      * @public
      */
     color?: string | undefined;
@@ -876,8 +897,8 @@ export interface CardValue {
      */
     value: string | undefined;
     /**
-     * <p>The structure that describes how the current form card value is mutated.
-     *       Only applies for form cards when multiple responses are allowed.</p>
+     * <p>The structure that describes how the current form card value is mutated. Only applies for
+     *       form cards when multiple responses are allowed.</p>
      * @public
      */
     submissionMutation?: SubmissionMutation | undefined;
@@ -909,8 +930,8 @@ export interface Category {
     appCount?: number | undefined;
 }
 /**
- * <p>The requested operation could not be completed because
- *       the content exceeds the maximum allowed size.</p>
+ * <p>The requested operation could not be completed because the content exceeds the maximum
+ *       allowed size.</p>
  * @public
  */
 export declare class ContentTooLargeException extends __BaseException {
@@ -1071,12 +1092,14 @@ export interface CreatePresignedUrlInput {
      */
     fileName: string | undefined;
     /**
-     * <p>Whether the file is associated with a Q App definition or a specific Q App session.</p>
+     * <p>Whether the file is associated with a Q App definition or a specific Q App
+     *       session.</p>
      * @public
      */
     scope: DocumentScope | undefined;
     /**
-     * <p>The unique identifier of the Q App session the file is associated with, if applicable.</p>
+     * <p>The unique identifier of the Q App session the file is associated with, if
+     *       applicable.</p>
      * @public
      */
     sessionId?: string | undefined;
@@ -1096,7 +1119,8 @@ export interface CreatePresignedUrlOutput {
      */
     presignedUrl: string | undefined;
     /**
-     * <p>The form fields to include in the presigned S3 POST operation used to upload a file.</p>
+     * <p>The form fields to include in the presigned S3 POST operation used to upload a
+     *       file.</p>
      * @public
      */
     presignedUrlFields: Record<string, string> | undefined;
@@ -1166,7 +1190,8 @@ export interface CreateQAppOutput {
      */
     updatedBy: string | undefined;
     /**
-     * <p>The capabilities required to run the Q App, such as file upload or third-party integrations.</p>
+     * <p>The capabilities required to run the Q App, such as file upload or third-party
+     *       integrations.</p>
      * @public
      */
     requiredCapabilities?: AppRequiredCapability[] | undefined;
@@ -1270,7 +1295,8 @@ export interface PermissionOutput {
  */
 export interface DescribeQAppPermissionsOutput {
     /**
-     * <p>The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned.</p>
+     * <p>The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are
+     *       returned.</p>
      * @public
      */
     resourceArn?: string | undefined;
@@ -1515,7 +1541,8 @@ export interface GetQAppSessionOutput {
      */
     cardStatus: Record<string, CardStatus> | undefined;
     /**
-     * <p>Indicates whether the current user is the owner of the Q App data collection session.</p>
+     * <p>Indicates whether the current user is the owner of the Q App data collection
+     *       session.</p>
      * @public
      */
     userIsHost?: boolean | undefined;
@@ -1551,7 +1578,8 @@ export interface SessionSharingConfiguration {
      */
     acceptResponses?: boolean | undefined;
     /**
-     * <p>Indicates whether collected responses for an Q App session are revealed for all users.</p>
+     * <p>Indicates whether collected responses for an Q App session are revealed for all
+     *       users.</p>
      * @public
      */
     revealCards?: boolean | undefined;
@@ -1616,12 +1644,14 @@ export interface ImportDocumentInput {
      */
     fileName: string | undefined;
     /**
-     * <p>Whether the file is associated with a Q App definition or a specific Q App session.</p>
+     * <p>Whether the file is associated with a Q App definition or a specific Q App
+     *       session.</p>
      * @public
      */
     scope: DocumentScope | undefined;
     /**
-     * <p>The unique identifier of the Q App session the file is associated with, if applicable.</p>
+     * <p>The unique identifier of the Q App session the file is associated with, if
+     *       applicable.</p>
      * @public
      */
     sessionId?: string | undefined;
@@ -1637,9 +1667,8 @@ export interface ImportDocumentOutput {
     fileId?: string | undefined;
 }
 /**
- * <p>A library item is a snapshot of an Amazon Q App
- *       that can be published so the users in their Amazon Q Apps library
- *       can discover it, clone it, and run it.</p>
+ * <p>A library item is a snapshot of an Amazon Q App that can be published so the users in their
+ *       Amazon Q Apps library can discover it, clone it, and run it.</p>
  * @public
  */
 export interface LibraryItemMember {
@@ -1889,8 +1918,8 @@ export interface User {
     userId?: string | undefined;
 }
 /**
- * <p>The response collected for a Amazon Q App session.
- *       This container represents a single response to a Q App session.</p>
+ * <p>The response collected for a Amazon Q App session. This container represents a single
+ *       response to a Q App session.</p>
  * @public
  */
 export interface QAppSessionData {
@@ -2033,7 +2062,8 @@ export interface PredictQAppInput {
      */
     instanceId: string | undefined;
     /**
-     * <p>The input to generate the Q App definition from, either a conversation or problem statement.</p>
+     * <p>The input to generate the Q App definition from, either a conversation or problem
+     *       statement.</p>
      * @public
      */
     options?: PredictQAppInputOptions | undefined;
@@ -2353,7 +2383,8 @@ export interface UpdateQAppPermissionsInput {
  */
 export interface UpdateQAppPermissionsOutput {
     /**
-     * <p>The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated.</p>
+     * <p>The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were
+     *       updated.</p>
      * @public
      */
     resourceArn?: string | undefined;
@@ -2454,7 +2485,8 @@ export interface UpdateQAppSessionMetadataOutput {
     sharingConfiguration: SessionSharingConfiguration | undefined;
 }
 /**
- * <p>The filter criteria used on responses based on document attributes or metadata fields.</p>
+ * <p>The filter criteria used on responses based on document attributes or metadata
+ *       fields.</p>
  * @public
  */
 export interface AttributeFilter {
@@ -2474,59 +2506,55 @@ export interface AttributeFilter {
      */
     notFilter?: AttributeFilter | undefined;
     /**
-     * <p>Performs an <i>equals</i> operation on two document attributes or metadata fields. Supported
-     *       for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>,
-     *       <code>longValue</code>, <code>stringListValue</code> and
-     *       <code>stringValue</code>.</p>
+     * <p>Performs an <i>equals</i> operation on two document attributes or metadata
+     *       fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>, <code>longValue</code>,
+     *         <code>stringListValue</code> and <code>stringValue</code>.</p>
      * @public
      */
     equalsTo?: DocumentAttribute | undefined;
     /**
-     * <p>Returns <code>true</code> when a document contains all the specified document
-     *       attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
-     *       <code>stringListValue</code>.</p>
+     * <p>Returns <code>true</code> when a document contains all the specified document attributes
+     *       or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>stringListValue</code>.</p>
      * @public
      */
     containsAll?: DocumentAttribute | undefined;
     /**
      * <p>Returns <code>true</code> when a document contains any of the specified document
-     *       attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
-     *       <code>stringListValue</code>.</p>
+     *       attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>stringListValue</code>.</p>
      * @public
      */
     containsAny?: DocumentAttribute | undefined;
     /**
-     * <p>Performs a <i>greater than</i> operation on two document attributes or metadata fields.
-     *       Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
-     *       and <code>longValue</code>.</p>
+     * <p>Performs a <i>greater than</i> operation on two document attributes or
+     *       metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code> and
+     *       <code>longValue</code>.</p>
      * @public
      */
     greaterThan?: DocumentAttribute | undefined;
     /**
-     * <p>Performs a <i>greater than or equals</i> operation on two document attributes or metadata
-     *       fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
-     *       and <code>longValue</code>. </p>
+     * <p>Performs a <i>greater than or equals</i> operation on two document
+     *       attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code> and <code>longValue</code>.
+     *     </p>
      * @public
      */
     greaterThanOrEquals?: DocumentAttribute | undefined;
     /**
-     * <p>Performs a <i>less than</i> operation on two document attributes or metadata fields.
-     *       Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
-     *       and <code>longValue</code>.</p>
+     * <p>Performs a <i>less than</i> operation on two document attributes or metadata
+     *       fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code> and
+     *       <code>longValue</code>.</p>
      * @public
      */
     lessThan?: DocumentAttribute | undefined;
     /**
-     * <p>Performs a <i>less than or equals</i> operation on two document attributes or metadata
-     *       fields.Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value type</a>: <code>dateValue</code>
-     *       and <code>longValue</code>. </p>
+     * <p>Performs a <i>less than or equals</i> operation on two document attributes
+     *       or metadata fields.Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value type</a>: <code>dateValue</code> and <code>longValue</code>.
+     *     </p>
      * @public
      */
     lessThanOrEquals?: DocumentAttribute | undefined;
 }
 /**
- * <p>A card in a Amazon Q App that generates a response
- *       based on the Amazon Q Business service.</p>
+ * <p>A card in a Amazon Q App that generates a response based on the Amazon Q Business service.</p>
  * @public
  */
 export interface QQueryCard {
@@ -2566,7 +2594,8 @@ export interface QQueryCard {
      */
     attributeFilter?: AttributeFilter | undefined;
     /**
-     * <p>Any dependencies for the query card, where the dependencies are references to the collected responses.</p>
+     * <p>Any dependencies for the query card, where the dependencies are references to the
+     *       collected responses.</p>
      * @public
      */
     memoryReferences?: string[] | undefined;
@@ -2914,7 +2943,8 @@ export interface GetQAppOutput {
      */
     updatedBy: string | undefined;
     /**
-     * <p>The capabilities required to run the Q App, such as file upload or third-party integrations.</p>
+     * <p>The capabilities required to run the Q App, such as file upload or third-party
+     *       integrations.</p>
      * @public
      */
     requiredCapabilities?: AppRequiredCapability[] | undefined;
@@ -2925,8 +2955,8 @@ export interface GetQAppOutput {
     appDefinition: AppDefinition | undefined;
 }
 /**
- * <p>The definition of an Amazon Q App generated based on input such as a conversation
- *       or problem statement.</p>
+ * <p>The definition of an Amazon Q App generated based on input such as a conversation or problem
+ *       statement.</p>
  * @public
  */
 export interface PredictAppDefinition {

package/dist-types/ts3.4/models/models_0.d.ts

@@ -48,11 +48,22 @@ export interface FormInputCard {
   computeMode?: InputCardComputeMode | undefined;
 }
 export declare const PluginType: {
+  readonly ASANA: "ASANA";
+  readonly ATLASSIAN_CONFLUENCE: "ATLASSIAN_CONFLUENCE";
   readonly CUSTOM: "CUSTOM";
+  readonly GOOGLE_CALENDAR: "GOOGLE_CALENDAR";
   readonly JIRA: "JIRA";
+  readonly JIRA_CLOUD: "JIRA_CLOUD";
+  readonly MICROSOFT_EXCHANGE: "MICROSOFT_EXCHANGE";
+  readonly MICROSOFT_TEAMS: "MICROSOFT_TEAMS";
+  readonly PAGERDUTY_ADVANCE: "PAGERDUTY_ADVANCE";
   readonly SALESFORCE: "SALESFORCE";
+  readonly SALESFORCE_CRM: "SALESFORCE_CRM";
+  readonly SERVICENOW_NOW_PLATFORM: "SERVICENOW_NOW_PLATFORM";
   readonly SERVICE_NOW: "SERVICE_NOW";
+  readonly SMARTSHEET: "SMARTSHEET";
   readonly ZENDESK: "ZENDESK";
+  readonly ZENDESK_SUITE: "ZENDESK_SUITE";
 };
 export type PluginType = (typeof PluginType)[keyof typeof PluginType];
 export interface QPluginCard {
@@ -63,6 +74,7 @@ export interface QPluginCard {
   prompt: string | undefined;
   pluginType: PluginType | undefined;
   pluginId: string | undefined;
+  actionIdentifier?: string | undefined;
 }
 export type DocumentAttributeValue =
   | DocumentAttributeValue.DateValueMember
@@ -154,6 +166,7 @@ export interface QPluginCardInput {
   type: CardType | undefined;
   prompt: string | undefined;
   pluginId: string | undefined;
+  actionIdentifier?: string | undefined;
 }
 export interface TextInputCardInput {
   title: string | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-qapps",
   "description": "AWS SDK for JavaScript Qapps Client for Node.js, Browser and React Native",
-  "version": "3.702.0",
+  "version": "3.705.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",