EngagementSummary
An object that contains an Engagement's subset of fields.
Contents
Note
In the following list, the required parameters are described first.
- Arn
-
The Amazon Resource Name (ARN) of the created Engagement.
Type: String
Pattern:
arn:.*Required: No
- ContextTypes
-
An array of context types associated with the engagement, such as "CustomerProject" or "Lead". This provides a quick overview of the types of contexts included in the engagement.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Valid Values:
CustomerProject | LeadRequired: No
- CreatedAt
-
The date and time when the Engagement was created.
Type: Timestamp
Required: No
- CreatedBy
-
The AWS Account ID of the Engagement creator.
Type: String
Pattern:
([0-9]{12}|\w{1,12})Required: No
- Id
-
The unique identifier for the Engagement.
Type: String
Pattern:
eng-[0-9a-z]{14}Required: No
- MemberCount
-
The number of members in the Engagement.
Type: Integer
Required: No
- ModifiedAt
-
The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".
Type: Timestamp
Required: No
- ModifiedBy
-
The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.
Type: String
Pattern:
([0-9]{12}|\w{1,12})Required: No
- Title
-
The title of the Engagement.
Type: String
Pattern:
(?s).{1,40}Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
