View a markdown version of this page

QuerySummary - AWS Artifact

QuerySummary

Summary information about a single query within a compliance inquiry.

Contents

createdAt

Timestamp indicating when the query was created.

Type: Timestamp

Required: Yes

query

The actual query text.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^<>]*

Required: Yes

queryIdentifier

Sequential identifier of the query within the inquiry.

Type: Integer

Required: Yes

status

Current processing status of the query.

Type: String

Valid Values: PROCESSING | COMPLETED | FAILED

Required: Yes

statusMessage

Descriptive status message.

Type: String

Valid Values: Query processing is complete. | Query processing is in-progress. | An internal error occurred while processing the query. Try again at a later time. | Query is pending human review. | Query contains restricted or unsupported content.

Required: Yes

citations

Supporting citations for the response.

Type: Array of Citation objects

Required: No

response

Generated response to the query.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^<>]*

Required: No

reviewType

Type of review for the response.

Type: String

Valid Values: HUMAN | AI

Required: No

updatedResponseVersions

Ordered list of response version history entries, oldest first.

Type: Array of ResponseVersion objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: