Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns list of event descriptions matching criteria up to the last 6 weeks.
This operation returns paginated results.
Synopsis
- describeEvents :: DescribeEvents
- data DescribeEvents
- deRequestId :: Lens' DescribeEvents (Maybe Text)
- deTemplateName :: Lens' DescribeEvents (Maybe Text)
- deStartTime :: Lens' DescribeEvents (Maybe UTCTime)
- deSeverity :: Lens' DescribeEvents (Maybe EventSeverity)
- deNextToken :: Lens' DescribeEvents (Maybe Text)
- deVersionLabel :: Lens' DescribeEvents (Maybe Text)
- dePlatformARN :: Lens' DescribeEvents (Maybe Text)
- deEnvironmentName :: Lens' DescribeEvents (Maybe Text)
- deMaxRecords :: Lens' DescribeEvents (Maybe Natural)
- deEndTime :: Lens' DescribeEvents (Maybe UTCTime)
- deApplicationName :: Lens' DescribeEvents (Maybe Text)
- deEnvironmentId :: Lens' DescribeEvents (Maybe Text)
- describeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeEventsResponse
- dersNextToken :: Lens' DescribeEventsResponse (Maybe Text)
- dersEvents :: Lens' DescribeEventsResponse [EventDescription]
- dersResponseStatus :: Lens' DescribeEventsResponse Int
Creating a Request
describeEvents :: DescribeEvents Source #
Creates a value of DescribeEvents
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
deRequestId
- If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.deTemplateName
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.deStartTime
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.deSeverity
- If specified, limits the events returned from this call to include only those with the specified severity or higher.deNextToken
- Pagination token. If specified, the events return the next batch of results.deVersionLabel
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.dePlatformARN
- The ARN of the version of the custom platform.deEnvironmentName
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.deMaxRecords
- Specifies the maximum number of events that can be returned, beginning with the most recent event.deEndTime
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, theEndTime
.deApplicationName
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.deEnvironmentId
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
data DescribeEvents Source #
Request to retrieve a list of events for an environment.
See: describeEvents
smart constructor.
Instances
Request Lenses
deRequestId :: Lens' DescribeEvents (Maybe Text) Source #
If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
deTemplateName :: Lens' DescribeEvents (Maybe Text) Source #
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
deStartTime :: Lens' DescribeEvents (Maybe UTCTime) Source #
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
deSeverity :: Lens' DescribeEvents (Maybe EventSeverity) Source #
If specified, limits the events returned from this call to include only those with the specified severity or higher.
deNextToken :: Lens' DescribeEvents (Maybe Text) Source #
Pagination token. If specified, the events return the next batch of results.
deVersionLabel :: Lens' DescribeEvents (Maybe Text) Source #
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
dePlatformARN :: Lens' DescribeEvents (Maybe Text) Source #
The ARN of the version of the custom platform.
deEnvironmentName :: Lens' DescribeEvents (Maybe Text) Source #
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
deMaxRecords :: Lens' DescribeEvents (Maybe Natural) Source #
Specifies the maximum number of events that can be returned, beginning with the most recent event.
deEndTime :: Lens' DescribeEvents (Maybe UTCTime) Source #
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime
.
deApplicationName :: Lens' DescribeEvents (Maybe Text) Source #
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
deEnvironmentId :: Lens' DescribeEvents (Maybe Text) Source #
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
Destructuring the Response
describeEventsResponse Source #
Creates a value of DescribeEventsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dersNextToken
- If returned, this indicates that there are more results to obtain. Use this token in the nextDescribeEvents
call to get the next batch of events.dersEvents
- A list ofEventDescription
.dersResponseStatus
- -- | The response status code.
data DescribeEventsResponse Source #
Result message wrapping a list of event descriptions.
See: describeEventsResponse
smart constructor.
Instances
Response Lenses
dersNextToken :: Lens' DescribeEventsResponse (Maybe Text) Source #
If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents
call to get the next batch of events.
dersEvents :: Lens' DescribeEventsResponse [EventDescription] Source #
A list of EventDescription
.
dersResponseStatus :: Lens' DescribeEventsResponse Int Source #
- - | The response status code.