EngagementContextDetails
Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.
Contents
Note
In the following list, the required parameters are described first.
- Type
-
Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.
Type: String
Valid Values:
CustomerProject | LeadRequired: Yes
- Id
-
The unique identifier of the engagement context. This ID is used to reference and manage the specific context within the engagement.
Type: String
Pattern:
(?s).{1,3}Required: No
- Payload
-
Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.
Type: EngagementContextPayload object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
