OpenSearchService / Client / insight_feedback

insight_feedback

OpenSearchService.Client.insight_feedback(**kwargs)

Submits feedback for an existing insight in an Amazon OpenSearch Service domain. Allows users to provide a thumbs up or thumbs down rating and optional text feedback for a specific insight.

See also: AWS API Documentation

Request Syntax

response = client.insight_feedback(
    Entity={
        'Type': 'DomainName',
        'Value': 'string'
    },
    InsightId='string',
    Thumbs='Up'|'Down',
    FeedbackText='string'
)
Parameters:

  • Entity (dict) –

    [REQUIRED]

    The entity for which to submit insight feedback. Specifies the type and value of the entity, such as a domain name.

    • Type (string) – [REQUIRED]

      The type of the entity. Possible values are DomainName.

    • Value (string) – [REQUIRED]

      The value of the entity, such as a domain name.

  • InsightId (string) –

    [REQUIRED]

    The unique identifier of the insight for which to submit feedback.

  • Thumbs (string) –

    [REQUIRED]

    The thumbs up or thumbs down feedback for the insight. Possible values are Up and Down.

  • FeedbackText (string) – Optional text feedback providing additional details about the insight. Maximum length is 1000 characters.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'SUCCESS'|'ERROR'
}

Response Structure

  • (dict) –

    The result of an InsightFeedback request. Contains the status of the feedback submission.

    • Status (string) –

      The status of the feedback submission. Possible values are SUCCESS and ERROR.

Exceptions