CodeStarNotifications / Paginator / ListEventTypes
ListEventTypes#
- class CodeStarNotifications.Paginator.ListEventTypes#
paginator = client.get_paginator('list_event_types')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
CodeStarNotifications.Client.list_event_types()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( Filters=[ { 'Name': 'RESOURCE_TYPE'|'SERVICE_NAME', 'Value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
Filters (list) –
The filters to use to return information by service or resource type.
(dict) –
Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.
Name (string) – [REQUIRED]
The system-generated name of the filter type you want to filter by.
Value (string) – [REQUIRED]
The name of the resource type (for example, pipeline) or service name (for example, CodePipeline) that you want to filter by.
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
{ 'EventTypes': [ { 'EventTypeId': 'string', 'ServiceName': 'string', 'EventTypeName': 'string', 'ResourceType': 'string' }, ], }
Response Structure
(dict) –
EventTypes (list) –
Information about each event, including service name, resource type, event ID, and event name.
(dict) –
Returns information about an event that has triggered a notification rule.
EventTypeId (string) –
The system-generated ID of the event. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.
ServiceName (string) –
The name of the service for which the event applies.
EventTypeName (string) –
The name of the event.
ResourceType (string) –
The resource type of the event.