View a markdown version of this page

AWS::Wisdom::ContentAssociation - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Wisdom::ContentAssociation

Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.

After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.

Note the following limitations:

  • You can create only one content association for each content resource in a knowledge base.

  • You can associate a step-by-step guide with multiple content resources.

For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Connect Customer Administrator Guide.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Wisdom::ContentAssociation",
  "Properties" : {
      "Association" : ContentAssociationContents,
      "AssociationType" : String,
      "ContentId" : String,
      "KnowledgeBaseId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Wisdom::ContentAssociation
Properties:
  Association: 
    ContentAssociationContents
  AssociationType: String
  ContentId: String
  KnowledgeBaseId: String
  Tags: 
    - Tag

Properties

Association

Property description not available.

Required: Yes

Type: ContentAssociationContents

Update requires: Replacement

AssociationType

The type of association.

Required: Yes

Type: String

Allowed values: AMAZON_CONNECT_GUIDE

Update requires: Replacement

ContentId

The identifier of the content.

Required: Yes

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Update requires: Replacement

KnowledgeBaseId

The identifier of the knowledge base.

Required: Yes

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Update requires: Replacement

Tags

The tags used to organize, track, or control access for this resource.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

Fn::GetAtt

ContentArn

The Amazon Resource Name (ARN) of the content.

ContentAssociationArn

The Amazon Resource Name (ARN) of the content association.

ContentAssociationId

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

KnowledgeBaseArn

The Amazon Resource Name (ARN) of the knowledge base.