amazonka-opsworks-cm-1.6.1: Amazon OpsWorks for Chef Automate SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.OpsWorksCM.DescribeEvents

Contents

Description

Describes events for a specified server. Results are ordered by time, with newest events first.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Synopsis

Creating a Request

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:

  • deNextToken - NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null . Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
  • deMaxResults - To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
  • deServerName - The name of the server for which you want to view events.

data DescribeEvents Source #

See: describeEvents smart constructor.

Instances
Eq DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Data DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEvents -> c DescribeEvents #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEvents #

toConstr :: DescribeEvents -> Constr #

dataTypeOf :: DescribeEvents -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEvents) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEvents) #

gmapT :: (forall b. Data b => b -> b) -> DescribeEvents -> DescribeEvents #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEvents -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEvents -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeEvents -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEvents -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #

Read DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Show DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Generic DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Associated Types

type Rep DescribeEvents :: Type -> Type #

Hashable DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

ToJSON DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

AWSRequest DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Associated Types

type Rs DescribeEvents :: Type #

ToHeaders DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

ToPath DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

ToQuery DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

NFData DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Methods

rnf :: DescribeEvents -> () #

type Rep DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

type Rep DescribeEvents = D1 (MetaData "DescribeEvents" "Network.AWS.OpsWorksCM.DescribeEvents" "amazonka-opsworks-cm-1.6.1-DBtTlJOATBfGleOMllIGPs" False) (C1 (MetaCons "DescribeEvents'" PrefixI True) (S1 (MetaSel (Just "_deNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_deMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_deServerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs DescribeEvents Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Request Lenses

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

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null . Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

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

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

deServerName :: Lens' DescribeEvents Text Source #

The name of the server for which you want to view events.

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:

  • dersServerEvents - Contains the response to a DescribeEvents request.
  • dersNextToken - NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null . Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
  • dersResponseStatus - -- | The response status code.

data DescribeEventsResponse Source #

See: describeEventsResponse smart constructor.

Instances
Eq DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Data DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEventsResponse -> c DescribeEventsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEventsResponse #

toConstr :: DescribeEventsResponse -> Constr #

dataTypeOf :: DescribeEventsResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEventsResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEventsResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeEventsResponse -> DescribeEventsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeEventsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEventsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #

Read DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Show DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Generic DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Associated Types

type Rep DescribeEventsResponse :: Type -> Type #

NFData DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

Methods

rnf :: DescribeEventsResponse -> () #

type Rep DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.OpsWorksCM.DescribeEvents

type Rep DescribeEventsResponse = D1 (MetaData "DescribeEventsResponse" "Network.AWS.OpsWorksCM.DescribeEvents" "amazonka-opsworks-cm-1.6.1-DBtTlJOATBfGleOMllIGPs" False) (C1 (MetaCons "DescribeEventsResponse'" PrefixI True) (S1 (MetaSel (Just "_dersServerEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ServerEvent])) :*: (S1 (MetaSel (Just "_dersNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dersServerEvents :: Lens' DescribeEventsResponse [ServerEvent] Source #

Contains the response to a DescribeEvents request.

dersNextToken :: Lens' DescribeEventsResponse (Maybe Text) Source #

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null . Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

dersResponseStatus :: Lens' DescribeEventsResponse Int Source #

  • - | The response status code.