amazonka-gamelift-1.6.0: Amazon GameLift 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.GameLift.DescribeFleetEvents

Contents

Description

Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

Fleet-related operations include:

  • CreateFleet
  • ListFleets
  • DeleteFleet
  • Describe fleets:
  • DescribeFleetAttributes
  • DescribeFleetCapacity
  • DescribeFleetPortSettings
  • DescribeFleetUtilization
  • DescribeRuntimeConfiguration
  • DescribeEC2InstanceLimits
  • DescribeFleetEvents
  • Update fleets:
  • UpdateFleetAttributes
  • UpdateFleetCapacity
  • UpdateFleetPortSettings
  • UpdateRuntimeConfiguration
  • Manage fleet actions:
  • StartFleetActions
  • StopFleetActions

Synopsis

Creating a Request

describeFleetEvents #

Creates a value of DescribeFleetEvents with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dfeStartTime - Earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
  • dfeNextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
  • dfeEndTime - Most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
  • dfeLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  • dfeFleetId - Unique identifier for a fleet to get event logs for.

data DescribeFleetEvents #

Represents the input for a request action.

See: describeFleetEvents smart constructor.

Instances

Eq DescribeFleetEvents # 
Data DescribeFleetEvents # 

Methods

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

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

toConstr :: DescribeFleetEvents -> Constr #

dataTypeOf :: DescribeFleetEvents -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeFleetEvents # 
Show DescribeFleetEvents # 
Generic DescribeFleetEvents # 
Hashable DescribeFleetEvents # 
ToJSON DescribeFleetEvents # 
NFData DescribeFleetEvents # 

Methods

rnf :: DescribeFleetEvents -> () #

AWSRequest DescribeFleetEvents # 
ToHeaders DescribeFleetEvents # 
ToPath DescribeFleetEvents # 
ToQuery DescribeFleetEvents # 
type Rep DescribeFleetEvents # 
type Rep DescribeFleetEvents = D1 * (MetaData "DescribeFleetEvents" "Network.AWS.GameLift.DescribeFleetEvents" "amazonka-gamelift-1.6.0-AFaGsb9wXmY9FImAlEHdkb" False) (C1 * (MetaCons "DescribeFleetEvents'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dfeStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_dfeNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dfeEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dfeLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_dfeFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))
type Rs DescribeFleetEvents # 

Request Lenses

dfeStartTime :: Lens' DescribeFleetEvents (Maybe UTCTime) #

Earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").

dfeNextToken :: Lens' DescribeFleetEvents (Maybe Text) #

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

dfeEndTime :: Lens' DescribeFleetEvents (Maybe UTCTime) #

Most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").

dfeLimit :: Lens' DescribeFleetEvents (Maybe Natural) #

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

dfeFleetId :: Lens' DescribeFleetEvents Text #

Unique identifier for a fleet to get event logs for.

Destructuring the Response

describeFleetEventsResponse #

Creates a value of DescribeFleetEventsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dfersNextToken - Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
  • dfersEvents - Collection of objects containing event log entries for the specified fleet.
  • dfersResponseStatus - -- | The response status code.

data DescribeFleetEventsResponse #

Represents the returned data in response to a request action.

See: describeFleetEventsResponse smart constructor.

Instances

Eq DescribeFleetEventsResponse # 
Data DescribeFleetEventsResponse # 

Methods

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

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

toConstr :: DescribeFleetEventsResponse -> Constr #

dataTypeOf :: DescribeFleetEventsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeFleetEventsResponse # 
Show DescribeFleetEventsResponse # 
Generic DescribeFleetEventsResponse # 
NFData DescribeFleetEventsResponse # 
type Rep DescribeFleetEventsResponse # 
type Rep DescribeFleetEventsResponse = D1 * (MetaData "DescribeFleetEventsResponse" "Network.AWS.GameLift.DescribeFleetEvents" "amazonka-gamelift-1.6.0-AFaGsb9wXmY9FImAlEHdkb" False) (C1 * (MetaCons "DescribeFleetEventsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dfersNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dfersEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Event]))) (S1 * (MetaSel (Just Symbol "_dfersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dfersNextToken :: Lens' DescribeFleetEventsResponse (Maybe Text) #

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

dfersEvents :: Lens' DescribeFleetEventsResponse [Event] #

Collection of objects containing event log entries for the specified fleet.