Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_assistant_association

get_assistant_association(**kwargs)

Retrieves information about an assistant association.

See also: AWS API Documentation

Request Syntax

response = client.get_assistant_association(
    assistantAssociationId='string',
    assistantId='string'
)
Parameters
  • assistantAssociationId (string) --

    [REQUIRED]

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

  • assistantId (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'assistantAssociation': {
        'assistantArn': 'string',
        'assistantAssociationArn': 'string',
        'assistantAssociationId': 'string',
        'assistantId': 'string',
        'associationData': {
            'knowledgeBaseAssociation': {
                'knowledgeBaseArn': 'string',
                'knowledgeBaseId': 'string'
            }
        },
        'associationType': 'KNOWLEDGE_BASE',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assistantAssociation (dict) --

      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 (dict) --

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

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: knowledgeBaseAssociation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        • knowledgeBaseAssociation (dict) --

          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 (dict) --

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

        • (string) --
          • (string) --

Exceptions

  • ConnectWisdomService.Client.exceptions.ValidationException
  • ConnectWisdomService.Client.exceptions.AccessDeniedException
  • ConnectWisdomService.Client.exceptions.ResourceNotFoundException