AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codecatalyst ]

list-event-logs

Description

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 .

Note

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 .

See also: AWS API Documentation

list-event-logs is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: items

Synopsis

  list-event-logs
--space-name <value>
--start-time <value>
--end-time <value>
[--event-name <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--space-name (string)

The name of the space.

--start-time (timestamp)

The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC 3339 .

--end-time (timestamp)

The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC 3339 .

--event-name (string)

The name of the event.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

nextToken -> (string)

A token returned from a call to this API to indicate the next batch of results to return, if any.

items -> (list)

Information about each event retrieved in the list.

(structure)

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 -> (timestamp)

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 -> (structure)

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)

The ID of the Amazon CodeCatalyst service principal.

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 -> (structure)

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 -> (structure)

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 -> (structure)

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)

The user agent whose actions are recorded in the event.