CodeCatalyst.Paginator.
ListEventLogs
¶paginator = client.get_paginator('list_event_logs')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_event_logs()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
spaceName='string',
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
eventName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the space.
[REQUIRED]
The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
[REQUIRED]
The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
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
{
'items': [
{
'id': 'string',
'eventName': 'string',
'eventType': 'string',
'eventCategory': 'string',
'eventSource': 'string',
'eventTime': datetime(2015, 1, 1),
'operationType': 'READONLY'|'MUTATION',
'userIdentity': {
'userType': 'USER'|'AWS_ACCOUNT'|'UNKNOWN',
'principalId': 'string',
'userName': 'string',
'awsAccountId': 'string'
},
'projectInformation': {
'name': 'string',
'projectId': 'string'
},
'requestId': 'string',
'requestPayload': {
'contentType': 'string',
'data': 'string'
},
'responsePayload': {
'contentType': 'string',
'data': 'string'
},
'errorCode': 'string',
'sourceIpAddress': 'string',
'userAgent': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Information about each event retrieved in the list.
(dict) --
Information about an entry in an event log of Amazon CodeCatalyst activity.
id (string) --
The system-generated unique ID of the event.
eventName (string) --
The name of the event.
eventType (string) --
The type of the event.
eventCategory (string) --
The category for the event.
eventSource (string) --
The source of the event.
eventTime (datetime) --
The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
operationType (string) --
The type of the event.
userIdentity (dict) --
The system-generated unique ID of the user whose actions are recorded in the event.
userType (string) --
The role assigned to the user in a Amazon CodeCatalyst space or project when the event occurred.
principalId (string) --
userName (string) --
The display name of the user in Amazon CodeCatalyst.
awsAccountId (string) --
The Amazon Web Services account number of the user in Amazon Web Services, if any.
projectInformation (dict) --
Information about the project where the event occurred.
name (string) --
The name of the project in the space.
projectId (string) --
The system-generated unique ID of the project.
requestId (string) --
The system-generated unique ID of the request.
requestPayload (dict) --
Information about the payload of the request.
contentType (string) --
The type of content in the event payload.
data (string) --
The data included in the event payload.
responsePayload (dict) --
Information about the payload of the response, if any.
contentType (string) --
The type of content in the event payload.
data (string) --
The data included in the event payload.
errorCode (string) --
The code of the error, if any.
sourceIpAddress (string) --
The IP address of the user whose actions are recorded in the event.
userAgent (string) --
NextToken (string) --
A token to resume pagination.