Copyright	(c) 2013-2021 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

Amazonka.ElasticBeanstalk.DescribeEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Synopsis

data DescribeEvents = DescribeEvents' {
- requestId :: Maybe Text
- templateName :: Maybe Text
- startTime :: Maybe ISO8601
- severity :: Maybe EventSeverity
- nextToken :: Maybe Text
- versionLabel :: Maybe Text
- platformArn :: Maybe Text
- environmentName :: Maybe Text
- maxRecords :: Maybe Natural
- endTime :: Maybe ISO8601
- applicationName :: Maybe Text
- environmentId :: Maybe Text
}
newDescribeEvents :: DescribeEvents
describeEvents_requestId :: Lens' DescribeEvents (Maybe Text)
describeEvents_templateName :: Lens' DescribeEvents (Maybe Text)
describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_severity :: Lens' DescribeEvents (Maybe EventSeverity)
describeEvents_nextToken :: Lens' DescribeEvents (Maybe Text)
describeEvents_versionLabel :: Lens' DescribeEvents (Maybe Text)
describeEvents_platformArn :: Lens' DescribeEvents (Maybe Text)
describeEvents_environmentName :: Lens' DescribeEvents (Maybe Text)
describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Natural)
describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_applicationName :: Lens' DescribeEvents (Maybe Text)
describeEvents_environmentId :: Lens' DescribeEvents (Maybe Text)
data DescribeEventsResponse = DescribeEventsResponse' {
- nextToken :: Maybe Text
- events :: Maybe [EventDescription]
- httpStatus :: Int
}
newDescribeEventsResponse :: Int -> DescribeEventsResponse
describeEventsResponse_nextToken :: Lens' DescribeEventsResponse (Maybe Text)
describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [EventDescription])
describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int

Creating a Request

data DescribeEvents Source #

Request to retrieve a list of events for an environment.

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents'

Fields

requestId :: Maybe Text
If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
templateName :: Maybe Text
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
startTime :: Maybe ISO8601
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
severity :: Maybe EventSeverity
If specified, limits the events returned from this call to include only those with the specified severity or higher.
nextToken :: Maybe Text
Pagination token. If specified, the events return the next batch of results.
versionLabel :: Maybe Text
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
platformArn :: Maybe Text
The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.
environmentName :: Maybe Text
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
maxRecords :: Maybe Natural
Specifies the maximum number of events that can be returned, beginning with the most recent event.
endTime :: Maybe ISO8601
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.
applicationName :: Maybe Text
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
environmentId :: Maybe Text
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Instances

Instances details

Eq DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods (==) :: DescribeEvents -> DescribeEvents -> Bool # (/=) :: DescribeEvents -> DescribeEvents -> Bool #
Read DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEvents # readList :: ReadS [DescribeEvents] # readPrec :: ReadPrec DescribeEvents # readListPrec :: ReadPrec [DescribeEvents] #
Show DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods showsPrec :: Int -> DescribeEvents -> ShowS # show :: DescribeEvents -> String # showList :: [DescribeEvents] -> ShowS #
Generic DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Associated Types type Rep DescribeEvents :: Type -> Type # Methods from :: DescribeEvents -> Rep DescribeEvents x # to :: Rep DescribeEvents x -> DescribeEvents #
NFData DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods rnf :: DescribeEvents -> () #
Hashable DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods hashWithSalt :: Int -> DescribeEvents -> Int # hash :: DescribeEvents -> Int #
AWSPager DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods page :: DescribeEvents -> AWSResponse DescribeEvents -> Maybe DescribeEvents #
AWSRequest DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Associated Types type AWSResponse DescribeEvents # Methods request :: DescribeEvents -> Request DescribeEvents # response :: MonadResource m => Logger -> Service -> Proxy DescribeEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEvents))) #
ToHeaders DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods toHeaders :: DescribeEvents -> [Header] #
ToPath DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods toPath :: DescribeEvents -> ByteString #
ToQuery DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods toQuery :: DescribeEvents -> QueryString #
type Rep DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents type Rep DescribeEvents = D1 ('MetaData "DescribeEvents" "Amazonka.ElasticBeanstalk.DescribeEvents" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "DescribeEvents'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: (S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSeverity)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "versionLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "platformArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))
type AWSResponse DescribeEvents Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents type AWSResponse DescribeEvents = DescribeEventsResponse

newDescribeEvents :: DescribeEvents Source #

Create a value of DescribeEvents with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestId:DescribeEvents', describeEvents_requestId - If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

$sel:templateName:DescribeEvents', describeEvents_templateName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

$sel:startTime:DescribeEvents', describeEvents_startTime - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

$sel:severity:DescribeEvents', describeEvents_severity - If specified, limits the events returned from this call to include only those with the specified severity or higher.

$sel:nextToken:DescribeEvents', describeEvents_nextToken - Pagination token. If specified, the events return the next batch of results.

$sel:versionLabel:DescribeEvents', describeEvents_versionLabel - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

$sel:platformArn:DescribeEvents', describeEvents_platformArn - The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.

$sel:environmentName:DescribeEvents', describeEvents_environmentName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

$sel:maxRecords:DescribeEvents', describeEvents_maxRecords - Specifies the maximum number of events that can be returned, beginning with the most recent event.

$sel:endTime:DescribeEvents', describeEvents_endTime - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

$sel:applicationName:DescribeEvents', describeEvents_applicationName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

$sel:environmentId:DescribeEvents', describeEvents_environmentId - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Request Lenses

describeEvents_requestId :: Lens' DescribeEvents (Maybe Text) Source #

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

describeEvents_templateName :: Lens' DescribeEvents (Maybe Text) Source #

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

describeEvents_severity :: Lens' DescribeEvents (Maybe EventSeverity) Source #

If specified, limits the events returned from this call to include only those with the specified severity or higher.

describeEvents_nextToken :: Lens' DescribeEvents (Maybe Text) Source #

Pagination token. If specified, the events return the next batch of results.

describeEvents_versionLabel :: Lens' DescribeEvents (Maybe Text) Source #

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

describeEvents_platformArn :: Lens' DescribeEvents (Maybe Text) Source #

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.

describeEvents_environmentName :: Lens' DescribeEvents (Maybe Text) Source #

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Natural) Source #

Specifies the maximum number of events that can be returned, beginning with the most recent event.

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

describeEvents_applicationName :: Lens' DescribeEvents (Maybe Text) Source #

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

describeEvents_environmentId :: Lens' DescribeEvents (Maybe Text) Source #

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Destructuring the Response

data DescribeEventsResponse Source #

Result message wrapping a list of event descriptions.

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse'
Fields nextToken :: Maybe Text 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. events :: Maybe [EventDescription] A list of EventDescription. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeEventsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods (==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool # (/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool #
Read DescribeEventsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEventsResponse # readList :: ReadS [DescribeEventsResponse] # readPrec :: ReadPrec DescribeEventsResponse # readListPrec :: ReadPrec [DescribeEventsResponse] #
Show DescribeEventsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods showsPrec :: Int -> DescribeEventsResponse -> ShowS # show :: DescribeEventsResponse -> String # showList :: [DescribeEventsResponse] -> ShowS #
Generic DescribeEventsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Associated Types type Rep DescribeEventsResponse :: Type -> Type # Methods from :: DescribeEventsResponse -> Rep DescribeEventsResponse x # to :: Rep DescribeEventsResponse x -> DescribeEventsResponse #
NFData DescribeEventsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents Methods rnf :: DescribeEventsResponse -> () #
type Rep DescribeEventsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEvents type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.ElasticBeanstalk.DescribeEvents" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "DescribeEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventDescription])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEventsResponse'`
-> DescribeEventsResponse

Create a value of DescribeEventsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:DescribeEvents', describeEventsResponse_nextToken - 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.

$sel:events:DescribeEventsResponse', describeEventsResponse_events - A list of EventDescription.

$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.

Response Lenses

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

describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [EventDescription]) Source #

A list of EventDescription.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #

The response's http status code.