Class AgentInsightSummary
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AgentInsightSummary.Builder,AgentInsightSummary>
Contains summary information about an Amazon Bedrock AgentCore Agent Insight, including its label, description, and
creation time. This structure is returned by ListAgentInsights; use GetAgentInsight to
retrieve the sample sessions and root causes for a specific insight.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal IntegerThe number of sessions affected by the insight pattern.final StringThe unique identifier of the Agent Insight.final StringThe application that the Agent Insight belongs to.Specifies whether the Agent Insight is active or archived.final StringSpecifies whether the Agent Insight is active or archived.final StringThe Batch Evaluation that produced this Insight, when applicable.static AgentInsightSummary.Builderbuilder()final InstantThe date and time when the Agent Insight was first created.Specifies whether customer-encrypted metadata is available for the Agent Insight.final StringSpecifies whether customer-encrypted metadata is available for the Agent Insight.final StringA generated description of the Agent Insight that explains the detected pattern and its observed behavior across sessions.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final InstantThe most recent date and time when the insight pattern was observed.final Stringname()A generated display label for the Agent Insight.static Class<? extends AgentInsightSummary.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final InsightTypetype()Returns the value of the Type property for this object.final StringReturns the value of the Type property for this object.final InstantThe date and time when the Agent Insight was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
Returns the value of the Type property for this object.If the service returns an enum value that is not available in the current SDK version,
typewill returnInsightType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The value of the Type property for this object.
- See Also:
-
typeAsString
Returns the value of the Type property for this object.If the service returns an enum value that is not available in the current SDK version,
typewill returnInsightType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The value of the Type property for this object.
- See Also:
-
name
A generated display label for the Agent Insight. This is a human-readable summary of the detected pattern, not an identifier.
- Returns:
- A generated display label for the Agent Insight. This is a human-readable summary of the detected pattern, not an identifier.
-
description
A generated description of the Agent Insight that explains the detected pattern and its observed behavior across sessions.
- Returns:
- A generated description of the Agent Insight that explains the detected pattern and its observed behavior across sessions.
-
createdAt
The date and time when the Agent Insight was first created.
- Returns:
- The date and time when the Agent Insight was first created.
-
affectedSessionCount
The number of sessions affected by the insight pattern.
- Returns:
- The number of sessions affected by the insight pattern.
-
agentInsightId
The unique identifier of the Agent Insight.
- Returns:
- The unique identifier of the Agent Insight.
-
applicationName
The application that the Agent Insight belongs to.
- Returns:
- The application that the Agent Insight belongs to.
-
batchEvaluationId
The Batch Evaluation that produced this Insight, when applicable.
- Returns:
- The Batch Evaluation that produced this Insight, when applicable.
-
customerMetadataStatus
Specifies whether customer-encrypted metadata is available for the Agent Insight.
If the service returns an enum value that is not available in the current SDK version,
customerMetadataStatuswill returnAgentInsightCustomerMetadataStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcustomerMetadataStatusAsString().- Returns:
- Specifies whether customer-encrypted metadata is available for the Agent Insight.
- See Also:
-
customerMetadataStatusAsString
Specifies whether customer-encrypted metadata is available for the Agent Insight.
If the service returns an enum value that is not available in the current SDK version,
customerMetadataStatuswill returnAgentInsightCustomerMetadataStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcustomerMetadataStatusAsString().- Returns:
- Specifies whether customer-encrypted metadata is available for the Agent Insight.
- See Also:
-
updatedAt
The date and time when the Agent Insight was last updated.
- Returns:
- The date and time when the Agent Insight was last updated.
-
archiveStatus
Specifies whether the Agent Insight is active or archived. Valid values:
-
ACTIVE- The insight is currently active. -
ARCHIVED- The insight has been archived.
If the service returns an enum value that is not available in the current SDK version,
archiveStatuswill returnAgentInsightArchiveStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromarchiveStatusAsString().- Returns:
- Specifies whether the Agent Insight is active or archived. Valid values:
-
ACTIVE- The insight is currently active. -
ARCHIVED- The insight has been archived.
-
- See Also:
-
-
archiveStatusAsString
Specifies whether the Agent Insight is active or archived. Valid values:
-
ACTIVE- The insight is currently active. -
ARCHIVED- The insight has been archived.
If the service returns an enum value that is not available in the current SDK version,
archiveStatuswill returnAgentInsightArchiveStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromarchiveStatusAsString().- Returns:
- Specifies whether the Agent Insight is active or archived. Valid values:
-
ACTIVE- The insight is currently active. -
ARCHIVED- The insight has been archived.
-
- See Also:
-
-
lastSeenAt
The most recent date and time when the insight pattern was observed.
- Returns:
- The most recent date and time when the insight pattern was observed.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<AgentInsightSummary.Builder,AgentInsightSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-