OpenSearchService / Client / describe_insight_details

describe_insight_details¶

OpenSearchService.Client.describe_insight_details(**kwargs)¶

Describes the details of an existing insight for an Amazon OpenSearch Service domain. Returns detailed fields associated with the specified insight, such as text descriptions and metric data.

Request Syntax

response = client.describe_insight_details(
    Entity={
        'Type': 'Account'|'DomainName',
        'Value': 'string'
    },
    InsightId='string',
    ShowHtmlContent=True|False
)

Parameters:

Entity (dict) –
[REQUIRED]

The entity for which to retrieve insight details. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID.
- Type (string) – [REQUIRED]
  
  The type of the entity. Possible values are Account and DomainName.
- Value (string) –
  
  The value of the entity. For DomainName, this is the domain name. For Account, this is the Amazon Web Services account ID.
InsightId (string) –
[REQUIRED]

The unique identifier of the insight to describe.
ShowHtmlContent (boolean) – Specifies whether to show response with HTML content in response or not.

Return type:

dict

Returns:

Response Syntax

{
    'Fields': [
        {
            'Name': 'string',
            'Type': 'text'|'metric',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) –

The result of a DescribeInsightDetails request. Contains the detailed fields associated with the specified insight.
- Fields (list) –
  
  The list of fields that contain detailed information about the insight.
  - (dict) –
    
    Represents a field in the detailed view of an insight, returned by the DescribeInsightDetails operation.
    - Name (string) –
      
      The name of the insight field.
    - Type (string) –
      
      The type of the insight field. Possible values are text and metric.
    - Value (string) –
      
      The value of the insight field.

Exceptions

OpenSearchService.Client.exceptions.BaseException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.DisabledOperationException
OpenSearchService.Client.exceptions.LimitExceededException