Describe Insight Details

opensearchservice_describe_insight_details

R Documentation

Describes the details of an existing insight for an Amazon OpenSearch Service domain¶

Description¶

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.

Usage¶

opensearchservice_describe_insight_details(Entity, InsightId,
  ShowHtmlContent)

Arguments¶

Entity

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

InsightId

[required] The unique identifier of the insight to describe.

ShowHtmlContent

Specifies whether to show response with HTML content in response or not.

Value¶

A list with the following syntax:

list(
  Fields = list(
    list(
      Name = "string",
      Type = "text"|"metric",
      Value = "string"
    )
  )
)

Request syntax¶

svc$describe_insight_details(
  Entity = list(
    Type = "Account"|"DomainName",
    Value = "string"
  ),
  InsightId = "string",
  ShowHtmlContent = TRUE|FALSE
)