Skip to main content

event_logs

Creates, updates, deletes, gets or lists an event_logs resource.

Overview​

Nameevent_logs
TypeResource
Idaws.codecatalyst.event_logs

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe system-generated unique ID of the event.
error_codestringThe code of the error, if any.
event_categorystringThe category for the event.
event_namestringThe name of the event.
event_sourcestringThe source of the event.
event_timestring (date-time)The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
event_typestringThe type of the event.
operation_typestringThe type of the event. (READONLY, MUTATION)
project_informationobjectInformation about the project where the event occurred.
request_idstringThe system-generated unique ID of the request.
request_payloadobjectInformation about the payload of the request.
response_payloadobjectInformation about the payload of the response, if any.
source_ip_addressstringThe IP address of the user whose actions are recorded in the event.
user_agentstringThe user agent whose actions are recorded in the event.
user_identityobjectThe system-generated unique ID of the user whose actions are recorded in the event.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_event_logsselectspace_name, regionRetrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide. ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History and Working with CloudTrail trails.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
space_namestringThe name of the space.

SELECT examples​

Retrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide. ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History and Working with CloudTrail trails.

SELECT
id,
error_code,
event_category,
event_name,
event_source,
event_time,
event_type,
operation_type,
project_information,
request_id,
request_payload,
response_payload,
source_ip_address,
user_agent,
user_identity
FROM aws.codecatalyst.event_logs
WHERE space_name = '{{ space_name }}' -- required
AND region = '{{ region }}' -- required
;