Engagement
Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.
Contents
- ContactArn
-
The ARN of the escalation plan or contact that Incident Manager is engaging.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*Required: Yes
- EngagementArn
-
The Amazon Resource Name (ARN) of the engagement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*Required: Yes
- Sender
-
The user that started the engagement.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$Required: Yes
- IncidentId
-
The ARN of the incident that's engaging the contact.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$Required: No
- StartTime
-
The time that the engagement began.
Type: Timestamp
Required: No
- StopTime
-
The time that the engagement ended.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
