Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.DescribeFleetEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.

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.

Learn more

Setting up GameLift fleets

This operation returns paginated results.

Synopsis

data DescribeFleetEvents = DescribeFleetEvents' {
- endTime :: Maybe POSIX
- limit :: Maybe Natural
- nextToken :: Maybe Text
- startTime :: Maybe POSIX
- fleetId :: Text
}
newDescribeFleetEvents :: Text -> DescribeFleetEvents
describeFleetEvents_endTime :: Lens' DescribeFleetEvents (Maybe UTCTime)
describeFleetEvents_limit :: Lens' DescribeFleetEvents (Maybe Natural)
describeFleetEvents_nextToken :: Lens' DescribeFleetEvents (Maybe Text)
describeFleetEvents_startTime :: Lens' DescribeFleetEvents (Maybe UTCTime)
describeFleetEvents_fleetId :: Lens' DescribeFleetEvents Text
data DescribeFleetEventsResponse = DescribeFleetEventsResponse' {
- events :: Maybe [Event]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeFleetEventsResponse :: Int -> DescribeFleetEventsResponse
describeFleetEventsResponse_events :: Lens' DescribeFleetEventsResponse (Maybe [Event])
describeFleetEventsResponse_nextToken :: Lens' DescribeFleetEventsResponse (Maybe Text)
describeFleetEventsResponse_httpStatus :: Lens' DescribeFleetEventsResponse Int

Creating a Request

data DescribeFleetEvents Source #

See: newDescribeFleetEvents smart constructor.

Constructors

DescribeFleetEvents'

Fields

endTime :: Maybe POSIX
The 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").
limit :: Maybe Natural
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken :: Maybe Text
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
startTime :: Maybe POSIX
The 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").
fleetId :: Text
A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.

Instances

Instances details

ToJSON DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Methods toJSON :: DescribeFleetEvents -> Value # toEncoding :: DescribeFleetEvents -> Encoding # toJSONList :: [DescribeFleetEvents] -> Value # toEncodingList :: [DescribeFleetEvents] -> Encoding #
ToHeaders DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Methods toHeaders :: DescribeFleetEvents -> [Header] #
ToPath DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Methods toPath :: DescribeFleetEvents -> ByteString #
ToQuery DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Methods toQuery :: DescribeFleetEvents -> QueryString #
AWSPager DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Methods page :: DescribeFleetEvents -> AWSResponse DescribeFleetEvents -> Maybe DescribeFleetEvents #
AWSRequest DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Associated Types type AWSResponse DescribeFleetEvents # Methods request :: (Service -> Service) -> DescribeFleetEvents -> Request DescribeFleetEvents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFleetEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFleetEvents))) #
Generic DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Associated Types type Rep DescribeFleetEvents :: Type -> Type # Methods from :: DescribeFleetEvents -> Rep DescribeFleetEvents x # to :: Rep DescribeFleetEvents x -> DescribeFleetEvents #
Read DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Methods readsPrec :: Int -> ReadS DescribeFleetEvents # readList :: ReadS [DescribeFleetEvents] # readPrec :: ReadPrec DescribeFleetEvents # readListPrec :: ReadPrec [DescribeFleetEvents] #
Show DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Methods showsPrec :: Int -> DescribeFleetEvents -> ShowS # show :: DescribeFleetEvents -> String # showList :: [DescribeFleetEvents] -> ShowS #
NFData DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Methods rnf :: DescribeFleetEvents -> () #
Eq DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Methods (==) :: DescribeFleetEvents -> DescribeFleetEvents -> Bool # (/=) :: DescribeFleetEvents -> DescribeFleetEvents -> Bool #
Hashable DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents Methods hashWithSalt :: Int -> DescribeFleetEvents -> Int # hash :: DescribeFleetEvents -> Int #
type AWSResponse DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents type AWSResponse DescribeFleetEvents = DescribeFleetEventsResponse
type Rep DescribeFleetEvents Source #
Instance details Defined in Amazonka.GameLift.DescribeFleetEvents type Rep DescribeFleetEvents = D1 ('MetaData "DescribeFleetEvents" "Amazonka.GameLift.DescribeFleetEvents" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeFleetEvents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeFleetEvents Source #

Arguments

:: Text	`DescribeFleetEvents`
-> DescribeFleetEvents

Create a value of DescribeFleetEvents 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:

DescribeFleetEvents, describeFleetEvents_endTime - The 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").

$sel:limit:DescribeFleetEvents', describeFleetEvents_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

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

DescribeFleetEvents, describeFleetEvents_startTime - The 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").

DescribeFleetEvents, describeFleetEvents_fleetId - A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.

Request Lenses

describeFleetEvents_endTime :: Lens' DescribeFleetEvents (Maybe UTCTime) Source #

The 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").

describeFleetEvents_limit :: Lens' DescribeFleetEvents (Maybe Natural) Source #

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

describeFleetEvents_nextToken :: Lens' DescribeFleetEvents (Maybe Text) Source #

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

describeFleetEvents_startTime :: Lens' DescribeFleetEvents (Maybe UTCTime) Source #

The 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").

describeFleetEvents_fleetId :: Lens' DescribeFleetEvents Text Source #

A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.

Destructuring the Response

data DescribeFleetEventsResponse Source #

See: newDescribeFleetEventsResponse smart constructor.

Constructors

DescribeFleetEventsResponse'
Fields events :: Maybe [Event] A collection of objects containing event log entries for the specified fleet. nextToken :: Maybe Text A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeFleetEventsResponse Source #

Arguments

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

Create a value of DescribeFleetEventsResponse 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:DescribeFleetEventsResponse', describeFleetEventsResponse_events - A collection of objects containing event log entries for the specified fleet.

DescribeFleetEvents, describeFleetEventsResponse_nextToken - A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

$sel:httpStatus:DescribeFleetEventsResponse', describeFleetEventsResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetEventsResponse_events :: Lens' DescribeFleetEventsResponse (Maybe [Event]) Source #

A collection of objects containing event log entries for the specified fleet.

describeFleetEventsResponse_nextToken :: Lens' DescribeFleetEventsResponse (Maybe Text) Source #

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

describeFleetEventsResponse_httpStatus :: Lens' DescribeFleetEventsResponse Int Source #

The response's http status code.