SSMContacts.Paginator.
ListEngagements
¶paginator = client.get_paginator('list_engagements')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from SSMContacts.Client.list_engagements()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
IncidentId='string',
TimeRangeValue={
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The time range to lists engagements for an incident.
The start of the time range.
The end of the time range.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Engagements': [
{
'EngagementArn': 'string',
'ContactArn': 'string',
'Sender': 'string',
'IncidentId': 'string',
'StartTime': datetime(2015, 1, 1),
'StopTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Engagements (list) --
A list of each engagement that occurred during the specified time range of an incident.
(dict) --
Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.
EngagementArn (string) --
The Amazon Resource Name (ARN) of the engagement.
ContactArn (string) --
The ARN of the escalation plan or contact that Incident Manager is engaging.
Sender (string) --
The user that started the engagement.
IncidentId (string) --
The ARN of the incident that's engaging the contact.
StartTime (datetime) --
The time that the engagement began.
StopTime (datetime) --
The time that the engagement ended.