[ aws . wisdom ]

create-assistant-association

Description

Creates 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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-assistant-association
--assistant-id <value>
--association <value>
--association-type <value>
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--assistant-id (string)

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

--association (structure)

The identifier of the associated resource.

knowledgeBaseId -> (string)

The identifier of the knowledge base.

Shorthand Syntax:

knowledgeBaseId=string

JSON Syntax:

{
  "knowledgeBaseId": "string"
}

--association-type (string)

The type of association.

Possible values:

  • KNOWLEDGE_BASE

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--tags (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

assistantAssociation -> (structure)

The assistant association.

assistantArn -> (string)

The Amazon Resource Name (ARN) of the Wisdom assistant.

assistantAssociationArn -> (string)

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

assistantAssociationId -> (string)

The identifier of the assistant association.

assistantId -> (string)

The identifier of the Wisdom assistant.

associationData -> (structure)

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

knowledgeBaseAssociation -> (structure)

The knowledge base where output data is sent.

knowledgeBaseArn -> (string)

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

knowledgeBaseId -> (string)

The identifier of the knowledge base.

associationType -> (string)

The type of association.

tags -> (map)

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

key -> (string)

value -> (string)