events
Creates, updates, deletes, gets or lists an events resource.
Overview
| Name | events |
| Type | Resource |
| Id | aws.elasticbeanstalk.events |
Fields
The following fields are returned by SELECT queries:
- describe_events
| Name | Datatype | Description |
|---|---|---|
application_name | string | The application associated with the event. |
environment_name | string | The name of the environment associated with this event. |
event_date | string | The date when the event occurred. |
message | string | The event message. |
platform_arn | string | The ARN of the platform version. |
request_id | string | The web service request ID for the activity of this event. |
severity | string | The severity level of this event. |
template_name | string | The name of the configuration associated with this event. |
version_label | string | The release label for the application version associated with this event. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_events | select | region | ApplicationName, VersionLabel, TemplateName, EnvironmentId, EnvironmentName, PlatformArn, RequestId, Severity, StartTime, EndTime, MaxRecords, NextToken | Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken. |
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.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
ApplicationName | string | If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application. |
EndTime | string (date-time) | If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime. |
EnvironmentId | string | If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. |
EnvironmentName | string | If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. |
MaxRecords | integer | Specifies the maximum number of events that can be returned, beginning with the most recent event. |
NextToken | string | Pagination token. If specified, the events return the next batch of results. |
PlatformArn | string | The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version. |
RequestId | string | If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID. |
Severity | string | If specified, limits the events returned from this call to include only those with the specified severity or higher. |
StartTime | string (date-time) | If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time. |
TemplateName | string | If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration. |
VersionLabel | string | If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version. |
SELECT examples
- describe_events
Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken.
SELECT
application_name,
environment_name,
event_date,
message,
platform_arn,
request_id,
severity,
template_name,
version_label
FROM aws.elasticbeanstalk.events
WHERE region = '{{ region }}' -- required
AND ApplicationName = '{{ ApplicationName }}'
AND VersionLabel = '{{ VersionLabel }}'
AND TemplateName = '{{ TemplateName }}'
AND EnvironmentId = '{{ EnvironmentId }}'
AND EnvironmentName = '{{ EnvironmentName }}'
AND PlatformArn = '{{ PlatformArn }}'
AND RequestId = '{{ RequestId }}'
AND Severity = '{{ Severity }}'
AND StartTime = '{{ StartTime }}'
AND EndTime = '{{ EndTime }}'
AND MaxRecords = '{{ MaxRecords }}'
AND NextToken = '{{ NextToken }}'
;