list-entity-events¶

Description¶

Returns a list of change events for a specific entity, such as deployments, configuration changes, or other state-changing activities. This operation helps track the history of changes that may have affected service performance.

Synopsis¶

  list-entity-events
--entity <value>
--start-time <value>
--end-time <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--entity (map) [required]

The entity for which to retrieve change events. This specifies the service, resource, or other entity whose event history you want to examine.

This is a string-to-string map. It can include the following fields.

Type designates the type of object this is.

ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource .

Name specifies the name of the object. This is used only if the value of the Type field is Service , RemoteService , or AWS::Service .

Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource .

Environment specifies the location where this object is hosted, or what it belongs to.

AwsAccountId specifies the account where this object is in.

Below is an example of a service.

{ "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" }

Below is an example of a resource.

{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" }

Constraints:

min: 1

max: 4

key -> (string)

Constraints:

pattern: [a-zA-Z]{1,50}

value -> (string)

Constraints:

min: 1

max: 1024

pattern: [ -~]*[!-~]+[ -~]*

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--start-time (timestamp) [required]

The start of the time period to retrieve change events for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: 1698778057

--end-time (timestamp) [required]

The end of the time period to retrieve change events for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: 1698778057

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

StartTime -> (timestamp)

The start of the time period that the returned change events apply to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: 1698778057

EndTime -> (timestamp)

The end of the time period that the returned change events apply to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: 1698778057

ChangeEvents -> (list)

An array of structures, where each structure contains information about one change event that occurred for the specified entity during the requested time period.

Constraints:

min: 0

max: 250

(structure)

A structure that contains information about a change event that occurred for a service, such as a deployment or configuration change.

Timestamp -> (timestamp) [required]

The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.

AccountId -> (string) [required]

The Amazon Web Services account ID where this change event occurred.

Constraints:

pattern: [0-9]{12}

Region -> (string) [required]

The Amazon Web Services region where this change event occurred.

Entity -> (map) [required]

The entity (service or resource) that was affected by this change event, including its key attributes.

This is a string-to-string map. It can include the following fields.

Type designates the type of object this is.

ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource .

Name specifies the name of the object. This is used only if the value of the Type field is Service , RemoteService , or AWS::Service .

Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource .

Environment specifies the location where this object is hosted, or what it belongs to.

AwsAccountId specifies the account where this object is in.

Below is an example of a service.

{ "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" }

Below is an example of a resource.

{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" }

Constraints:

min: 1

max: 4

key -> (string)

Constraints:

pattern: [a-zA-Z]{1,50}

value -> (string)

Constraints:

min: 1

max: 1024

pattern: [ -~]*[!-~]+[ -~]*

ChangeEventType -> (string) [required]

The type of change event that occurred, such as DEPLOYMENT .

Possible values:

DEPLOYMENT

CONFIGURATION

EventId -> (string) [required]

A unique identifier for this change event. For CloudTrail-based events, this is the CloudTrail event id. For other events, this will be Unknown .

UserName -> (string)

The name of the user who initiated this change event, if available.

EventName -> (string)

The name or description of this change event.

NextToken -> (string)

Include this value in your next use of this API to get the next set of change events.

Table of Contents

Feedback

User Guide