Amazonka.ElasticBeanstalk.DescribeEvents

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.

Creating a Request

data DescribeEvents

Request to retrieve a list of events for an environment.

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents'

Fields

• applicationName :: Maybe Text

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

• endTime :: Maybe ISO8601

  If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

• environmentId :: Maybe Text

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

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

• nextToken :: Maybe Text

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

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

• requestId :: Maybe Text

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

• severity :: Maybe EventSeverity

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

• startTime :: Maybe ISO8601

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

• templateName :: Maybe Text

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

• versionLabel :: Maybe Text

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

Instances

ToHeaders DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

toHeaders :: DescribeEvents -> [Header]

ToPath DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

toPath :: DescribeEvents -> ByteString

ToQuery DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

toQuery :: DescribeEvents -> QueryString

AWSPager DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

page :: DescribeEvents -> AWSResponse DescribeEvents -> Maybe DescribeEvents

AWSRequest DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Associated Types

type AWSResponse DescribeEvents

Methods

request :: (Service -> Service) -> DescribeEvents -> Request DescribeEvents

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEvents)))

Generic DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Associated Types

type Rep DescribeEvents :: Type -> Type

Methods

from :: DescribeEvents -> Rep DescribeEvents x

to :: Rep DescribeEvents x -> DescribeEvents

Read DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

readsPrec :: Int -> ReadS DescribeEvents

readList :: ReadS [DescribeEvents]

readPrec :: ReadPrec DescribeEvents

readListPrec :: ReadPrec [DescribeEvents]

Show DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

showsPrec :: Int -> DescribeEvents -> ShowS

show :: DescribeEvents -> String

showList :: [DescribeEvents] -> ShowS

NFData DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

rnf :: DescribeEvents -> ()

Eq DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

(==) :: DescribeEvents -> DescribeEvents -> Bool

(/=) :: DescribeEvents -> DescribeEvents -> Bool

Hashable DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

hashWithSalt :: Int -> DescribeEvents -> Int

hash :: DescribeEvents -> Int

type AWSResponse DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

type AWSResponse DescribeEvents = DescribeEventsResponse

type Rep DescribeEvents

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

type Rep DescribeEvents = D1 ('MetaData "DescribeEvents" "Amazonka.ElasticBeanstalk.DescribeEvents" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "DescribeEvents'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "environmentId") '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 "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "platformArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSeverity)))) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newDescribeEvents :: DescribeEvents

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:

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

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

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

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.

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

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.

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

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

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

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

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

Request Lenses

describeEvents_applicationName :: Lens' DescribeEvents (Maybe Text)

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

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

describeEvents_environmentId :: Lens' DescribeEvents (Maybe Text)

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

describeEvents_environmentName :: Lens' DescribeEvents (Maybe Text)

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

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Natural)

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

describeEvents_nextToken :: Lens' DescribeEvents (Maybe Text)

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

describeEvents_platformArn :: Lens' DescribeEvents (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.

describeEvents_requestId :: Lens' DescribeEvents (Maybe Text)

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

describeEvents_severity :: Lens' DescribeEvents (Maybe EventSeverity)

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

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)

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

describeEvents_templateName :: Lens' DescribeEvents (Maybe Text)

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

describeEvents_versionLabel :: Lens' DescribeEvents (Maybe Text)

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

Destructuring the Response

data DescribeEventsResponse

Result message wrapping a list of event descriptions.

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse'

Fields

• events :: Maybe [EventDescription]

  A list of EventDescription.

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeEventsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Associated Types

type Rep DescribeEventsResponse :: Type -> Type

Methods

from :: DescribeEventsResponse -> Rep DescribeEventsResponse x

to :: Rep DescribeEventsResponse x -> DescribeEventsResponse

Read DescribeEventsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

readsPrec :: Int -> ReadS DescribeEventsResponse

readList :: ReadS [DescribeEventsResponse]

readPrec :: ReadPrec DescribeEventsResponse

readListPrec :: ReadPrec [DescribeEventsResponse]

Show DescribeEventsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

showsPrec :: Int -> DescribeEventsResponse -> ShowS

show :: DescribeEventsResponse -> String

showList :: [DescribeEventsResponse] -> ShowS

NFData DescribeEventsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

rnf :: DescribeEventsResponse -> ()

Eq DescribeEventsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

Methods

(==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool

(/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool

type Rep DescribeEventsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEvents

type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.ElasticBeanstalk.DescribeEvents" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "DescribeEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventDescription])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventsResponse

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:events:DescribeEventsResponse', describeEventsResponse_events - A list of EventDescription.

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:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.

Response Lenses

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

A list of EventDescription.

describeEventsResponse_nextToken :: Lens' DescribeEventsResponse (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.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int

The response's http status code.