QuickResponseSearchResultData
The result of quick response search.
Contents
- contents
-
The contents of the quick response.
Type: QuickResponseContents object
Required: Yes
- contentType
-
The media type of the quick response content.
-
Use
application/x.quickresponse;format=plainfor quick response written in plain text. -
Use
application/x.quickresponse;format=markdownfor quick response written in richtext.
Type: String
Pattern:
^(application/x\.quickresponse;format=(plain|markdown))$Required: Yes
-
- createdTime
-
The timestamp when the quick response was created.
Type: Timestamp
Required: Yes
- isActive
-
Whether the quick response is active.
Type: Boolean
Required: Yes
- knowledgeBaseArn
-
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Pattern:
^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$Required: Yes
- knowledgeBaseId
-
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
- lastModifiedTime
-
The timestamp when the quick response search result data was last modified.
Type: Timestamp
Required: Yes
- name
-
The name of the quick response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- quickResponseArn
-
The Amazon Resource Name (ARN) of the quick response.
Type: String
Pattern:
^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$Required: Yes
- quickResponseId
-
The identifier of the quick response.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
- status
-
The resource status of the quick response.
Type: String
Valid Values:
CREATE_IN_PROGRESS | CREATE_FAILED | CREATED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED | UPDATE_IN_PROGRESS | UPDATE_FAILEDRequired: Yes
- attributesInterpolated
-
The user defined contact attributes that are resolved when the search result is returned.
Type: Array of strings
Required: No
- attributesNotInterpolated
-
The user defined contact attributes that are not resolved when the search result is returned.
Type: Array of strings
Required: No
- channels
-
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat.Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 10.
Required: No
- description
-
The description of the quick response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- groupingConfiguration
-
The configuration information of the user groups that the quick response is accessible to.
Type: GroupingConfiguration object
Required: No
- language
-
The language code value for the language in which the quick response is written.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 5.
Required: No
- lastModifiedBy
-
The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$Required: No
- shortcutKey
-
The shortcut key of the quick response. The value should be unique across the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Required: No
-
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
