awswisdom

package
v2.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 13, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnAssistantAssociation_CFN_RESOURCE_TYPE_NAME 

func CfnAssistantAssociation_CFN_RESOURCE_TYPE_NAME() *string

func CfnAssistantAssociation_IsCfnElement 

func CfnAssistantAssociation_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAssistantAssociation_IsCfnResource 

func CfnAssistantAssociation_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAssistantAssociation_IsConstruct 

func CfnAssistantAssociation_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnAssistant_CFN_RESOURCE_TYPE_NAME 

func CfnAssistant_CFN_RESOURCE_TYPE_NAME() *string

func CfnAssistant_IsCfnElement 

func CfnAssistant_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAssistant_IsCfnResource 

func CfnAssistant_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAssistant_IsConstruct 

func CfnAssistant_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnKnowledgeBase_CFN_RESOURCE_TYPE_NAME 

func CfnKnowledgeBase_CFN_RESOURCE_TYPE_NAME() *string

func CfnKnowledgeBase_IsCfnElement 

func CfnKnowledgeBase_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnKnowledgeBase_IsCfnResource 

func CfnKnowledgeBase_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnKnowledgeBase_IsConstruct 

func CfnKnowledgeBase_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnAssistantAssociation_Override 

func NewCfnAssistantAssociation_Override(c CfnAssistantAssociation, scope constructs.Construct, id *string, props *CfnAssistantAssociationProps)

Create a new `AWS::Wisdom::AssistantAssociation`.

func NewCfnAssistant_Override 

func NewCfnAssistant_Override(c CfnAssistant, scope constructs.Construct, id *string, props *CfnAssistantProps)

Create a new `AWS::Wisdom::Assistant`.

func NewCfnKnowledgeBase_Override 

func NewCfnKnowledgeBase_Override(c CfnKnowledgeBase, scope constructs.Construct, id *string, props *CfnKnowledgeBaseProps)

Create a new `AWS::Wisdom::KnowledgeBase`.

Types

type CfnAssistant 

type CfnAssistant interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrAssistantArn() *string
	AttrAssistantId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	ServerSideEncryptionConfiguration() interface{}
	SetServerSideEncryptionConfiguration(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Type() *string
	SetType(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Wisdom::Assistant`.

Specifies an Amazon Connect Wisdom assistant.

TODO: EXAMPLE

func NewCfnAssistant 

func NewCfnAssistant(scope constructs.Construct, id *string, props *CfnAssistantProps) CfnAssistant

Create a new `AWS::Wisdom::Assistant`.

type CfnAssistantAssociation 

type CfnAssistantAssociation interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AssistantId() *string
	SetAssistantId(val *string)
	Association() interface{}
	SetAssociation(val interface{})
	AssociationType() *string
	SetAssociationType(val *string)
	AttrAssistantArn() *string
	AttrAssistantAssociationArn() *string
	AttrAssistantAssociationId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Wisdom::AssistantAssociation`.

Specifies an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

TODO: EXAMPLE

func NewCfnAssistantAssociation 

func NewCfnAssistantAssociation(scope constructs.Construct, id *string, props *CfnAssistantAssociationProps) CfnAssistantAssociation

Create a new `AWS::Wisdom::AssistantAssociation`.

type CfnAssistantAssociationProps 

type CfnAssistantAssociationProps struct {
	// The identifier of the Wisdom assistant.
	AssistantId *string `json:"assistantId" yaml:"assistantId"`
	// The identifier of the associated resource.
	Association interface{} `json:"association" yaml:"association"`
	// The type of association.
	AssociationType *string `json:"associationType" yaml:"associationType"`
	// The tags used to organize, track, or control access for this resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnAssistantAssociation`.

TODO: EXAMPLE

type CfnAssistantAssociation_AssociationDataProperty 

type CfnAssistantAssociation_AssociationDataProperty struct {
	// The identifier of the knowledge base.
	KnowledgeBaseId *string `json:"knowledgeBaseId" yaml:"knowledgeBaseId"`
}

A union type that currently has a single argument, which is the knowledge base ID.

TODO: EXAMPLE

type CfnAssistantProps 

type CfnAssistantProps struct {
	// The name of the assistant.
	Name *string `json:"name" yaml:"name"`
	// The type of assistant.
	Type *string `json:"type" yaml:"type"`
	// The description of the assistant.
	Description *string `json:"description" yaml:"description"`
	// The KMS key used for encryption.
	ServerSideEncryptionConfiguration interface{} `json:"serverSideEncryptionConfiguration" yaml:"serverSideEncryptionConfiguration"`
	// The tags used to organize, track, or control access for this resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnAssistant`.

TODO: EXAMPLE

type CfnAssistant_ServerSideEncryptionConfigurationProperty 

type CfnAssistant_ServerSideEncryptionConfigurationProperty struct {
	// The KMS key .
	//
	// For information about valid ID values, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) .
	KmsKeyId *string `json:"kmsKeyId" yaml:"kmsKeyId"`
}

The KMS key used for encryption.

TODO: EXAMPLE

type CfnKnowledgeBase 

type CfnKnowledgeBase interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrKnowledgeBaseArn() *string
	AttrKnowledgeBaseId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	KnowledgeBaseType() *string
	SetKnowledgeBaseType(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	RenderingConfiguration() interface{}
	SetRenderingConfiguration(val interface{})
	ServerSideEncryptionConfiguration() interface{}
	SetServerSideEncryptionConfiguration(val interface{})
	SourceConfiguration() interface{}
	SetSourceConfiguration(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Wisdom::KnowledgeBase`.

Specifies a knowledge base.

TODO: EXAMPLE

func NewCfnKnowledgeBase 

func NewCfnKnowledgeBase(scope constructs.Construct, id *string, props *CfnKnowledgeBaseProps) CfnKnowledgeBase

Create a new `AWS::Wisdom::KnowledgeBase`.

type CfnKnowledgeBaseProps 

type CfnKnowledgeBaseProps struct {
	// The type of knowledge base.
	//
	// Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
	KnowledgeBaseType *string `json:"knowledgeBaseType" yaml:"knowledgeBaseType"`
	// The name of the knowledge base.
	Name *string `json:"name" yaml:"name"`
	// The description.
	Description *string `json:"description" yaml:"description"`
	// Information about how to render the content.
	RenderingConfiguration interface{} `json:"renderingConfiguration" yaml:"renderingConfiguration"`
	// The KMS key used for encryption.
	ServerSideEncryptionConfiguration interface{} `json:"serverSideEncryptionConfiguration" yaml:"serverSideEncryptionConfiguration"`
	// The source of the knowledge base content.
	//
	// Only set this argument for EXTERNAL knowledge bases.
	SourceConfiguration interface{} `json:"sourceConfiguration" yaml:"sourceConfiguration"`
	// The tags used to organize, track, or control access for this resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnKnowledgeBase`.

TODO: EXAMPLE

type CfnKnowledgeBase_AppIntegrationsConfigurationProperty 

type CfnKnowledgeBase_AppIntegrationsConfigurationProperty struct {
	// The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
	AppIntegrationArn *string `json:"appIntegrationArn" yaml:"appIntegrationArn"`
	// The fields from the source that are made available to your agents in Wisdom.
	//
	// - For [Salesforce](https://docs.aws.amazon.com/https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm) , you must include at least `Id` , `ArticleNumber` , `VersionNumber` , `Title` , `PublishStatus` , and `IsDeleted` .
	// - For [ServiceNow](https://docs.aws.amazon.com/https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api) , you must include at least `number` , `short_description` , `sys_mod_count` , `workflow_state` , and `active` .
	//
	// Make sure to include additional fields. These fields are indexed and used to source recommendations.
	ObjectFields *[]*string `json:"objectFields" yaml:"objectFields"`
}

Configuration information for Amazon AppIntegrations to automatically ingest content.

TODO: EXAMPLE

type CfnKnowledgeBase_RenderingConfigurationProperty 

type CfnKnowledgeBase_RenderingConfigurationProperty struct {
	// A URI template containing exactly one variable in `${variableName}` format.
	//
	// This can only be set for `EXTERNAL` knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:
	//
	// - Salesforce: `Id` , `ArticleNumber` , `VersionNumber` , `Title` , `PublishStatus` , or `IsDeleted`
	// - ServiceNow: `number` , `short_description` , `sys_mod_count` , `workflow_state` , or `active`
	//
	// The variable is replaced with the actual value for a piece of content when calling [GetContent](https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html) .
	TemplateUri *string `json:"templateUri" yaml:"templateUri"`
}

Information about how to render the content.

TODO: EXAMPLE

type CfnKnowledgeBase_ServerSideEncryptionConfigurationProperty 

type CfnKnowledgeBase_ServerSideEncryptionConfigurationProperty struct {
	// The KMS key .
	//
	// For information about valid ID values, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) .
	KmsKeyId *string `json:"kmsKeyId" yaml:"kmsKeyId"`
}

The KMS key used for encryption.

TODO: EXAMPLE

type CfnKnowledgeBase_SourceConfigurationProperty 

type CfnKnowledgeBase_SourceConfigurationProperty struct {
	// Configuration information for Amazon AppIntegrations to automatically ingest content.
	AppIntegrations interface{} `json:"appIntegrations" yaml:"appIntegrations"`
}

Configuration information about the external data source.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.