GetContentAssociationCommand

Suggest an Edit

Returns the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides  in the Amazon Connect Administrator Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

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",
//     },
//   },
// };

GetContentAssociationCommand Input

See GetContentAssociationCommandInput for more details

Parameter
Type
Description
contentAssociationId
Required
string | undefined

The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

contentId
Required
string | undefined

The identifier of the content.

knowledgeBaseId
Required
string | undefined

The identifier of the knowledge base.

GetContentAssociationCommand Output

See GetContentAssociationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
contentAssociation
ContentAssociationData | undefined

The association between Amazon Q in Connect content and another resource.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ResourceNotFoundException
client

The specified resource does not exist.

ValidationException
client

The input fails to satisfy the constraints specified by a service.

QConnectServiceException
Base exception class for all service exceptions from QConnect service.