SSM / Paginator / ListOpsItemEvents
ListOpsItemEvents#
- class SSM.Paginator.ListOpsItemEvents#
paginator = client.get_paginator('list_ops_item_events')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
SSM.Client.list_ops_item_events()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( Filters=[ { 'Key': 'OpsItemId', 'Values': [ 'string', ], 'Operator': 'Equal' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
Filters (list) –
One or more OpsItem filters. Use a filter to return a more specific list of results.
(dict) –
Describes a filter for a specific list of OpsItem events. You can filter event information by using tags. You specify tags by using a key-value pair mapping.
Key (string) – [REQUIRED]
The name of the filter key. Currently, the only supported value is
OpsItemId
.Values (list) – [REQUIRED]
The values for the filter, consisting of one or more OpsItem IDs.
(string) –
Operator (string) – [REQUIRED]
The operator used by the filter call. Currently, the only supported value is
Equal
.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'Summaries': [ { 'OpsItemId': 'string', 'EventId': 'string', 'Source': 'string', 'DetailType': 'string', 'Detail': 'string', 'CreatedBy': { 'Arn': 'string' }, 'CreatedTime': datetime(2015, 1, 1) }, ] }
Response Structure
(dict) –
Summaries (list) –
A list of event information for the specified OpsItems.
(dict) –
Summary information about an OpsItem event or that associated an OpsItem with a related item.
OpsItemId (string) –
The ID of the OpsItem.
EventId (string) –
The ID of the OpsItem event.
Source (string) –
The source of the OpsItem event.
DetailType (string) –
The type of information provided as a detail.
Detail (string) –
Specific information about the OpsItem event.
CreatedBy (dict) –
Information about the user or resource that created the OpsItem event.
Arn (string) –
The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.
CreatedTime (datetime) –
The date and time the OpsItem event was created.