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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about a fleet's instances, including instance IDs, connection data, and status.

This operation can be used in the following ways:

To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.
To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.
To get information on a specific instance in a fleet, provide the fleet ID and instance ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, an Instance object is returned for each requested instance. Instances are not returned in any particular order.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

Related actions

All APIs by task

This operation returns paginated results.

Synopsis

data DescribeInstances = DescribeInstances' {
- instanceId :: Maybe Text
- limit :: Maybe Natural
- location :: Maybe Text
- nextToken :: Maybe Text
- fleetId :: Text
}
newDescribeInstances :: Text -> DescribeInstances
describeInstances_instanceId :: Lens' DescribeInstances (Maybe Text)
describeInstances_limit :: Lens' DescribeInstances (Maybe Natural)
describeInstances_location :: Lens' DescribeInstances (Maybe Text)
describeInstances_nextToken :: Lens' DescribeInstances (Maybe Text)
describeInstances_fleetId :: Lens' DescribeInstances Text
data DescribeInstancesResponse = DescribeInstancesResponse' {
- instances :: Maybe [Instance]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeInstancesResponse :: Int -> DescribeInstancesResponse
describeInstancesResponse_instances :: Lens' DescribeInstancesResponse (Maybe [Instance])
describeInstancesResponse_nextToken :: Lens' DescribeInstancesResponse (Maybe Text)
describeInstancesResponse_httpStatus :: Lens' DescribeInstancesResponse Int

Creating a Request

data DescribeInstances Source #

See: newDescribeInstances smart constructor.

Constructors

DescribeInstances'

Fields

instanceId :: Maybe Text
A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.
limit :: Maybe Natural
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
location :: Maybe Text
The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.
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.
fleetId :: Text
A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Instances

Instances details

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

newDescribeInstances Source #

Arguments

:: Text	`DescribeInstances`
-> DescribeInstances

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

DescribeInstances, describeInstances_instanceId - A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

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

DescribeInstances, describeInstances_location - The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

DescribeInstances, describeInstances_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.

DescribeInstances, describeInstances_fleetId - A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Request Lenses

describeInstances_instanceId :: Lens' DescribeInstances (Maybe Text) Source #

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

describeInstances_limit :: Lens' DescribeInstances (Maybe Natural) Source #

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

describeInstances_location :: Lens' DescribeInstances (Maybe Text) Source #

The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

describeInstances_nextToken :: Lens' DescribeInstances (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.

describeInstances_fleetId :: Lens' DescribeInstances Text Source #

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Destructuring the Response

data DescribeInstancesResponse Source #

See: newDescribeInstancesResponse smart constructor.

Constructors

DescribeInstancesResponse'
Fields instances :: Maybe [Instance] A collection of objects containing properties for each instance returned. 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 DescribeInstancesResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeInstances Associated Types type Rep DescribeInstancesResponse :: Type -> Type # Methods from :: DescribeInstancesResponse -> Rep DescribeInstancesResponse x # to :: Rep DescribeInstancesResponse x -> DescribeInstancesResponse #
Read DescribeInstancesResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeInstances Methods readsPrec :: Int -> ReadS DescribeInstancesResponse # readList :: ReadS [DescribeInstancesResponse] # readPrec :: ReadPrec DescribeInstancesResponse # readListPrec :: ReadPrec [DescribeInstancesResponse] #
Show DescribeInstancesResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeInstances Methods showsPrec :: Int -> DescribeInstancesResponse -> ShowS # show :: DescribeInstancesResponse -> String # showList :: [DescribeInstancesResponse] -> ShowS #
NFData DescribeInstancesResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeInstances Methods rnf :: DescribeInstancesResponse -> () #
Eq DescribeInstancesResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeInstances Methods (==) :: DescribeInstancesResponse -> DescribeInstancesResponse -> Bool # (/=) :: DescribeInstancesResponse -> DescribeInstancesResponse -> Bool #
type Rep DescribeInstancesResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeInstances type Rep DescribeInstancesResponse = D1 ('MetaData "DescribeInstancesResponse" "Amazonka.GameLift.DescribeInstances" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Instance])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeInstancesResponse Source #

Arguments

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

Create a value of DescribeInstancesResponse 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:instances:DescribeInstancesResponse', describeInstancesResponse_instances - A collection of objects containing properties for each instance returned.

DescribeInstances, describeInstancesResponse_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:DescribeInstancesResponse', describeInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeInstancesResponse_instances :: Lens' DescribeInstancesResponse (Maybe [Instance]) Source #

A collection of objects containing properties for each instance returned.

describeInstancesResponse_nextToken :: Lens' DescribeInstancesResponse (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.

describeInstancesResponse_httpStatus :: Lens' DescribeInstancesResponse Int Source #

The response's http status code.