search_content

ConnectWisdomService.Client.search_content(**kwargs)

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

See also: AWS API Documentation

Request Syntax

response = client.search_content(
    knowledgeBaseId='string',
    maxResults=123,
    nextToken='string',
    searchExpression={
        'filters': [
            {
                'field': 'NAME',
                'operator': 'EQUALS',
                'value': 'string'
            },
        ]
    }
)

Parameters

• knowledgeBaseId (string) --

  [REQUIRED]

  The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

• maxResults (integer) -- The maximum number of results to return per page.
• nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
• searchExpression (dict) --

  [REQUIRED]

  The search expression to filter results.

  • filters (list) -- [REQUIRED]

    The search expression filters.

    • (dict) --

      A search filter.

      • field (string) -- [REQUIRED]

        The field on which to filter.

      • operator (string) -- [REQUIRED]

        The operator to use for comparing the field’s value with the provided value.

      • value (string) -- [REQUIRED]

        The desired field value on which to filter.

Return type

dict

Returns

Response Syntax

{
    'contentSummaries': [
        {
            'contentArn': 'string',
            'contentId': 'string',
            'contentType': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'metadata': {
                'string': 'string'
            },
            'name': 'string',
            'revisionId': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
            'tags': {
                'string': 'string'
            },
            'title': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • contentSummaries (list) --

    Summary information about the content.

    • (dict) --

      Summary information about the content.

      • contentArn (string) --

        The Amazon Resource Name (ARN) of the content.

      • contentId (string) --

        The identifier of the content.

      • contentType (string) --

        The media type of the content.

      • knowledgeBaseArn (string) --

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

      • knowledgeBaseId (string) --

        The identifier of the knowledge base.

      • metadata (dict) --

        A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.

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

      • name (string) --

        The name of the content.

      • revisionId (string) --

        The identifier of the revision of the content.

      • status (string) --

        The status of the content.

      • tags (dict) --

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

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

      • title (string) --

        The title of the content.

  • nextToken (string) --

    If there are additional results, this is the token for the next set of results.

Exceptions

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