ChatResponseConfiguration
Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.
Contents
- chatResponseConfigurationArn
-
The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all AWS services and accounts.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1284.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Required: Yes
- chatResponseConfigurationId
-
A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}Required: Yes
- displayName
-
A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- status
-
The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use in chat interactions.
Type: String
Valid Values:
CREATING | UPDATING | FAILED | ACTIVERequired: Yes
- createdAt
-
The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.
Type: Timestamp
Required: No
- responseConfigurationSummary
-
A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
- updatedAt
-
The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
