@aws-sdk/client-qconnect 3.600.0 → 3.609.0

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

@@ -0,0 +1,90 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetContentAssociationRequest, GetContentAssociationResponse } from "../models/models_0";
+import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetContentAssociationCommand}.
+ */
+export interface GetContentAssociationCommandInput extends GetContentAssociationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetContentAssociationCommand}.
+ */
+export interface GetContentAssociationCommandOutput extends GetContentAssociationResponse, __MetadataBearer {
+}
+declare const GetContentAssociationCommand_base: {
+    new (input: GetContentAssociationCommandInput): import("@smithy/smithy-client").CommandImpl<GetContentAssociationCommandInput, GetContentAssociationCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetContentAssociationCommandInput): import("@smithy/smithy-client").CommandImpl<GetContentAssociationCommandInput, GetContentAssociationCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns the content association.</p>
+ *          <p>For more information about content associations--what they are and when they are used--see
+ *         <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Amazon Connect
+ *         Administrator Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QConnectClient, GetContentAssociationCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
+ * // const { QConnectClient, GetContentAssociationCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
+ * const client = new QConnectClient(config);
+ * const input = { // GetContentAssociationRequest
+ *   knowledgeBaseId: "STRING_VALUE", // required
+ *   contentId: "STRING_VALUE", // required
+ *   contentAssociationId: "STRING_VALUE", // required
+ * };
+ * const command = new GetContentAssociationCommand(input);
+ * const response = await client.send(command);
+ * // { // GetContentAssociationResponse
+ * //   contentAssociation: { // ContentAssociationData
+ * //     knowledgeBaseId: "STRING_VALUE", // required
+ * //     knowledgeBaseArn: "STRING_VALUE", // required
+ * //     contentId: "STRING_VALUE", // required
+ * //     contentArn: "STRING_VALUE", // required
+ * //     contentAssociationId: "STRING_VALUE", // required
+ * //     contentAssociationArn: "STRING_VALUE", // required
+ * //     associationType: "STRING_VALUE", // required
+ * //     associationData: { // ContentAssociationContents Union: only one key present
+ * //       amazonConnectGuideAssociation: { // AmazonConnectGuideAssociationData
+ * //         flowId: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //     tags: { // Tags
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetContentAssociationCommandInput - {@link GetContentAssociationCommandInput}
+ * @returns {@link GetContentAssociationCommandOutput}
+ * @see {@link GetContentAssociationCommandInput} for command's `input` shape.
+ * @see {@link GetContentAssociationCommandOutput} for command's `response` shape.
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by a service.</p>
+ *
+ * @throws {@link QConnectServiceException}
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
+ *
+ * @public
+ */
+export declare class GetContentAssociationCommand extends GetContentAssociationCommand_base {
+}

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

@@ -0,0 +1,94 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListContentAssociationsRequest, ListContentAssociationsResponse } from "../models/models_0";
+import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListContentAssociationsCommand}.
+ */
+export interface ListContentAssociationsCommandInput extends ListContentAssociationsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListContentAssociationsCommand}.
+ */
+export interface ListContentAssociationsCommandOutput extends ListContentAssociationsResponse, __MetadataBearer {
+}
+declare const ListContentAssociationsCommand_base: {
+    new (input: ListContentAssociationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListContentAssociationsCommandInput, ListContentAssociationsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListContentAssociationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListContentAssociationsCommandInput, ListContentAssociationsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists the content associations.</p>
+ *          <p>For more information about content associations--what they are and when they are used--see
+ *         <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Amazon Connect
+ *         Administrator Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QConnectClient, ListContentAssociationsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
+ * // const { QConnectClient, ListContentAssociationsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
+ * const client = new QConnectClient(config);
+ * const input = { // ListContentAssociationsRequest
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   knowledgeBaseId: "STRING_VALUE", // required
+ *   contentId: "STRING_VALUE", // required
+ * };
+ * const command = new ListContentAssociationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListContentAssociationsResponse
+ * //   contentAssociationSummaries: [ // ContentAssociationSummaryList // required
+ * //     { // ContentAssociationSummary
+ * //       knowledgeBaseId: "STRING_VALUE", // required
+ * //       knowledgeBaseArn: "STRING_VALUE", // required
+ * //       contentId: "STRING_VALUE", // required
+ * //       contentArn: "STRING_VALUE", // required
+ * //       contentAssociationId: "STRING_VALUE", // required
+ * //       contentAssociationArn: "STRING_VALUE", // required
+ * //       associationType: "STRING_VALUE", // required
+ * //       associationData: { // ContentAssociationContents Union: only one key present
+ * //         amazonConnectGuideAssociation: { // AmazonConnectGuideAssociationData
+ * //           flowId: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       tags: { // Tags
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListContentAssociationsCommandInput - {@link ListContentAssociationsCommandInput}
+ * @returns {@link ListContentAssociationsCommandOutput}
+ * @see {@link ListContentAssociationsCommandInput} for command's `input` shape.
+ * @see {@link ListContentAssociationsCommandOutput} for command's `response` shape.
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by a service.</p>
+ *
+ * @throws {@link QConnectServiceException}
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
+ *
+ * @public
+ */
+export declare class ListContentAssociationsCommand extends ListContentAssociationsCommand_base {
+}

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

@@ -27,9 +27,9 @@ declare const UpdateSessionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates a session. A session is a contextual container used for generating recommendations.
- *         Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect
- *       is enabled.</p>
+ * <p>Updates a session. A session is a contextual container used for generating
+ *       recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on
+ *       which Amazon Q in Connect is enabled.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -1,17 +1,20 @@
 export * from "./CreateAssistantAssociationCommand";
 export * from "./CreateAssistantCommand";
+export * from "./CreateContentAssociationCommand";
 export * from "./CreateContentCommand";
 export * from "./CreateKnowledgeBaseCommand";
 export * from "./CreateQuickResponseCommand";
 export * from "./CreateSessionCommand";
 export * from "./DeleteAssistantAssociationCommand";
 export * from "./DeleteAssistantCommand";
+export * from "./DeleteContentAssociationCommand";
 export * from "./DeleteContentCommand";
 export * from "./DeleteImportJobCommand";
 export * from "./DeleteKnowledgeBaseCommand";
 export * from "./DeleteQuickResponseCommand";
 export * from "./GetAssistantAssociationCommand";
 export * from "./GetAssistantCommand";
+export * from "./GetContentAssociationCommand";
 export * from "./GetContentCommand";
 export * from "./GetContentSummaryCommand";
 export * from "./GetImportJobCommand";
@@ -21,6 +24,7 @@ export * from "./GetRecommendationsCommand";
 export * from "./GetSessionCommand";
 export * from "./ListAssistantAssociationsCommand";
 export * from "./ListAssistantsCommand";
+export * from "./ListContentAssociationsCommand";
 export * from "./ListContentsCommand";
 export * from "./ListImportJobsCommand";
 export * from "./ListKnowledgeBasesCommand";

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

@@ -13,8 +13,19 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
- * <p>A leaf node condition which can be used to specify a tag condition.
- *   </p>
+ * <p>Content association data for a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html">step-by-step
+ *         guide</a>.</p>
+ * @public
+ */
+export interface AmazonConnectGuideAssociationData {
+    /**
+     * <p> The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.</p>
+     * @public
+     */
+    flowId?: string;
+}
+/**
+ * <p>A leaf node condition which can be used to specify a tag condition. </p>
  * @public
  */
 export interface TagCondition {
@@ -1596,7 +1607,8 @@ export interface SearchSessionsResponse {
     nextToken?: string;
 }
 /**
- * <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
+ * <p>A list of conditions which would be applied together with an <code>OR</code>
+ *       condition.</p>
  * @public
  */
 export type OrCondition = OrCondition.AndConditionsMember | OrCondition.TagConditionMember | OrCondition.$UnknownMember;
@@ -1605,7 +1617,8 @@ export type OrCondition = OrCondition.AndConditionsMember | OrCondition.TagCondi
  */
 export declare namespace OrCondition {
     /**
-     * <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
+     * <p>A list of conditions which would be applied together with an <code>AND</code>
+     *       condition.</p>
      * @public
      */
     interface AndConditionsMember {
@@ -1657,7 +1670,8 @@ export declare namespace TagFilter {
         $unknown?: never;
     }
     /**
-     * <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
+     * <p>A list of conditions which would be applied together with an <code>AND</code>
+     *       condition.</p>
      * @public
      */
     interface AndConditionsMember {
@@ -1667,7 +1681,8 @@ export declare namespace TagFilter {
         $unknown?: never;
     }
     /**
-     * <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
+     * <p>A list of conditions which would be applied together with an <code>OR</code>
+     *       condition.</p>
      * @public
      */
     interface OrConditionsMember {
@@ -1894,6 +1909,306 @@ export declare namespace Configuration {
     }
     const visit: <T>(value: Configuration, visitor: Visitor<T>) => T;
 }
+/**
+ * <p>The contents of a content association.</p>
+ * @public
+ */
+export type ContentAssociationContents = ContentAssociationContents.AmazonConnectGuideAssociationMember | ContentAssociationContents.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ContentAssociationContents {
+    /**
+     * <p>The data of the step-by-step guide association.</p>
+     * @public
+     */
+    interface AmazonConnectGuideAssociationMember {
+        amazonConnectGuideAssociation: AmazonConnectGuideAssociationData;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        amazonConnectGuideAssociation?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        amazonConnectGuideAssociation: (value: AmazonConnectGuideAssociationData) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ContentAssociationContents, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ContentAssociationType: {
+    readonly AMAZON_CONNECT_GUIDE: "AMAZON_CONNECT_GUIDE";
+};
+/**
+ * @public
+ */
+export type ContentAssociationType = (typeof ContentAssociationType)[keyof typeof ContentAssociationType];
+/**
+ * @public
+ */
+export interface CreateContentAssociationRequest {
+    /**
+     * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
+     *             request. If not provided, the Amazon Web Services
+     *             SDK populates this field. For more information about idempotency, see
+     *             <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
+     * @public
+     */
+    clientToken?: string;
+    /**
+     * <p>The identifier of the knowledge base.</p>
+     * @public
+     */
+    knowledgeBaseId: string | undefined;
+    /**
+     * <p>The identifier of the content.</p>
+     * @public
+     */
+    contentId: string | undefined;
+    /**
+     * <p>The type of association.</p>
+     * @public
+     */
+    associationType: ContentAssociationType | undefined;
+    /**
+     * <p>The identifier of the associated resource.</p>
+     * @public
+     */
+    association: ContentAssociationContents | undefined;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * @public
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * <p>Information about the content association.</p>
+ * @public
+ */
+export interface ContentAssociationData {
+    /**
+     * <p>The identifier of the knowledge base.</p>
+     * @public
+     */
+    knowledgeBaseId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
+     * @public
+     */
+    knowledgeBaseArn: string | undefined;
+    /**
+     * <p>The identifier of the content.</p>
+     * @public
+     */
+    contentId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the content.</p>
+     * @public
+     */
+    contentArn: string | undefined;
+    /**
+     * <p>The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
+     * @public
+     */
+    contentAssociationId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the content association.</p>
+     * @public
+     */
+    contentAssociationArn: string | undefined;
+    /**
+     * <p>The type of association.</p>
+     * @public
+     */
+    associationType: ContentAssociationType | undefined;
+    /**
+     * <p>The content association.</p>
+     * @public
+     */
+    associationData: ContentAssociationContents | undefined;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * @public
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * @public
+ */
+export interface CreateContentAssociationResponse {
+    /**
+     * <p>The association between Amazon Q in Connect content and another resource.</p>
+     * @public
+     */
+    contentAssociation?: ContentAssociationData;
+}
+/**
+ * <p>The throttling limit has been exceeded.</p>
+ * @public
+ */
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    $retryable: {};
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface DeleteContentAssociationRequest {
+    /**
+     * <p>The identifier of the knowledge base.</p>
+     * @public
+     */
+    knowledgeBaseId: string | undefined;
+    /**
+     * <p>The identifier of the content.</p>
+     * @public
+     */
+    contentId: string | undefined;
+    /**
+     * <p>The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
+     * @public
+     */
+    contentAssociationId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteContentAssociationResponse {
+}
+/**
+ * @public
+ */
+export interface GetContentAssociationRequest {
+    /**
+     * <p>The identifier of the knowledge base.</p>
+     * @public
+     */
+    knowledgeBaseId: string | undefined;
+    /**
+     * <p>The identifier of the content.</p>
+     * @public
+     */
+    contentId: string | undefined;
+    /**
+     * <p>The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
+     * @public
+     */
+    contentAssociationId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetContentAssociationResponse {
+    /**
+     * <p>The association between Amazon Q in Connect content and another resource.</p>
+     * @public
+     */
+    contentAssociation?: ContentAssociationData;
+}
+/**
+ * @public
+ */
+export interface ListContentAssociationsRequest {
+    /**
+     * <p>The token for the next set of results. Use the value returned in the previous
+     * response in the next request to retrieve the next set of results.</p>
+     * @public
+     */
+    nextToken?: string;
+    /**
+     * <p>The maximum number of results to return per page.</p>
+     * @public
+     */
+    maxResults?: number;
+    /**
+     * <p>The identifier of the knowledge base.</p>
+     * @public
+     */
+    knowledgeBaseId: string | undefined;
+    /**
+     * <p>The identifier of the content.</p>
+     * @public
+     */
+    contentId: string | undefined;
+}
+/**
+ * <p>Summary information about a content association.</p>
+ * @public
+ */
+export interface ContentAssociationSummary {
+    /**
+     * <p>The identifier of the knowledge base.</p>
+     * @public
+     */
+    knowledgeBaseId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
+     * @public
+     */
+    knowledgeBaseArn: string | undefined;
+    /**
+     * <p>The identifier of the content.</p>
+     * @public
+     */
+    contentId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the content.</p>
+     * @public
+     */
+    contentArn: string | undefined;
+    /**
+     * <p>The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
+     * @public
+     */
+    contentAssociationId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the content association.</p>
+     * @public
+     */
+    contentAssociationArn: string | undefined;
+    /**
+     * <p>The type of association.</p>
+     * @public
+     */
+    associationType: ContentAssociationType | undefined;
+    /**
+     * <p>The content association.</p>
+     * @public
+     */
+    associationData: ContentAssociationContents | undefined;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * @public
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * @public
+ */
+export interface ListContentAssociationsResponse {
+    /**
+     * <p>Summary information about content associations.</p>
+     * @public
+     */
+    contentAssociationSummaries: ContentAssociationSummary[] | undefined;
+    /**
+     * <p>If there are additional results, this is the token for the next set of results.</p>
+     * @public
+     */
+    nextToken?: string;
+}
 /**
  * @public
  */
@@ -3013,7 +3328,7 @@ export interface ImportJobData {
      */
     url: string | undefined;
     /**
-     * <p>The link to donwload the information of resource data that failed to be imported.</p>
+     * <p>The link to download the information of resource data that failed to be imported.</p>
      * @public
      */
     failedRecordReport?: string;

package/dist-types/pagination/ListContentAssociationsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListContentAssociationsCommandInput, ListContentAssociationsCommandOutput } from "../commands/ListContentAssociationsCommand";
+import { QConnectPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListContentAssociations: (config: QConnectPaginationConfiguration, input: ListContentAssociationsCommandInput, ...rest: any[]) => Paginator<ListContentAssociationsCommandOutput>;

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

@@ -1,6 +1,7 @@
 export * from "./Interfaces";
 export * from "./ListAssistantAssociationsPaginator";
 export * from "./ListAssistantsPaginator";
+export * from "./ListContentAssociationsPaginator";
 export * from "./ListContentsPaginator";
 export * from "./ListImportJobsPaginator";
 export * from "./ListKnowledgeBasesPaginator";