Network.AWS.GameLift.DescribeInstances

Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.

To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.

Creating a Request

describeInstances

Arguments

:: Text

diFleetId

-> DescribeInstances

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

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

• diInstanceId - Unique identifier for an instance. Specify an instance to retrieve information for or leave blank to get information on all instances in the fleet.
• diNextToken - Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
• diLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• diFleetId - Unique identifier for a fleet. Specify the fleet to retrieve instance information for.

data DescribeInstances

Represents the input for a request action.

See: describeInstances smart constructor.

Instances

Eq DescribeInstances

Methods

(==) :: DescribeInstances -> DescribeInstances -> Bool

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

Data DescribeInstances

Methods

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

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

toConstr :: DescribeInstances -> Constr

dataTypeOf :: DescribeInstances -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeInstances -> DescribeInstances

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

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

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

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

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

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

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

Read DescribeInstances

Methods

readsPrec :: Int -> ReadS DescribeInstances

readList :: ReadS [DescribeInstances]

readPrec :: ReadPrec DescribeInstances

readListPrec :: ReadPrec [DescribeInstances]

Show DescribeInstances

Methods

showsPrec :: Int -> DescribeInstances -> ShowS

show :: DescribeInstances -> String

showList :: [DescribeInstances] -> ShowS

Generic DescribeInstances

Associated Types

type Rep DescribeInstances :: * -> *

Methods

from :: DescribeInstances -> Rep DescribeInstances x

to :: Rep DescribeInstances x -> DescribeInstances

Hashable DescribeInstances

Methods

hashWithSalt :: Int -> DescribeInstances -> Int

hash :: DescribeInstances -> Int

ToJSON DescribeInstances

Methods

toJSON :: DescribeInstances -> Value

toEncoding :: DescribeInstances -> Encoding

toJSONList :: [DescribeInstances] -> Value

toEncodingList :: [DescribeInstances] -> Encoding

NFData DescribeInstances

Methods

rnf :: DescribeInstances -> ()

AWSRequest DescribeInstances

Associated Types

type Rs DescribeInstances :: *

Methods

request :: DescribeInstances -> Request DescribeInstances

response :: MonadResource m => Logger -> Service -> Proxy * DescribeInstances -> ClientResponse -> m (Response DescribeInstances)

ToPath DescribeInstances

Methods

toPath :: DescribeInstances -> ByteString

ToHeaders DescribeInstances

Methods

toHeaders :: DescribeInstances -> [Header]

ToQuery DescribeInstances

Methods

toQuery :: DescribeInstances -> QueryString

type Rep DescribeInstances

type Rep DescribeInstances = D1 (MetaData "DescribeInstances" "Network.AWS.GameLift.DescribeInstances" "amazonka-gamelift-1.4.5-2krZbzEaIqtLV8ATX8AZ52" False) (C1 (MetaCons "DescribeInstances'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_diInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_diNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_diLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_diFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs DescribeInstances

type Rs DescribeInstances = DescribeInstancesResponse

Request Lenses

diInstanceId :: Lens' DescribeInstances (Maybe Text)

Unique identifier for an instance. Specify an instance to retrieve information for or leave blank to get information on all instances in the fleet.

diNextToken :: Lens' DescribeInstances (Maybe Text)

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

diLimit :: Lens' DescribeInstances (Maybe Natural)

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

diFleetId :: Lens' DescribeInstances Text

Unique identifier for a fleet. Specify the fleet to retrieve instance information for.

Destructuring the Response

describeInstancesResponse

Arguments

:: Int

dirsResponseStatus

-> DescribeInstancesResponse

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

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

• dirsNextToken - Token indicating 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.
• dirsInstances - Collection of objects containing properties for each instance returned.
• dirsResponseStatus - -- | The response status code.

data DescribeInstancesResponse

Represents the returned data in response to a request action.

See: describeInstancesResponse smart constructor.

Instances

Eq DescribeInstancesResponse

Methods

(==) :: DescribeInstancesResponse -> DescribeInstancesResponse -> Bool

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

Data DescribeInstancesResponse

Methods

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

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

toConstr :: DescribeInstancesResponse -> Constr

dataTypeOf :: DescribeInstancesResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeInstancesResponse -> DescribeInstancesResponse

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

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

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

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

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

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

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

Read DescribeInstancesResponse

Methods

readsPrec :: Int -> ReadS DescribeInstancesResponse

readList :: ReadS [DescribeInstancesResponse]

readPrec :: ReadPrec DescribeInstancesResponse

readListPrec :: ReadPrec [DescribeInstancesResponse]

Show DescribeInstancesResponse

Methods

showsPrec :: Int -> DescribeInstancesResponse -> ShowS

show :: DescribeInstancesResponse -> String

showList :: [DescribeInstancesResponse] -> ShowS

Generic DescribeInstancesResponse

Associated Types

type Rep DescribeInstancesResponse :: * -> *

Methods

from :: DescribeInstancesResponse -> Rep DescribeInstancesResponse x

to :: Rep DescribeInstancesResponse x -> DescribeInstancesResponse

NFData DescribeInstancesResponse

Methods

rnf :: DescribeInstancesResponse -> ()

type Rep DescribeInstancesResponse

type Rep DescribeInstancesResponse = D1 (MetaData "DescribeInstancesResponse" "Network.AWS.GameLift.DescribeInstances" "amazonka-gamelift-1.4.5-2krZbzEaIqtLV8ATX8AZ52" False) (C1 (MetaCons "DescribeInstancesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dirsInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Instance]))) (S1 (MetaSel (Just Symbol "_dirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dirsNextToken :: Lens' DescribeInstancesResponse (Maybe Text)

Token indicating 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.

dirsInstances :: Lens' DescribeInstancesResponse [Instance]

Collection of objects containing properties for each instance returned.

dirsResponseStatus :: Lens' DescribeInstancesResponse Int

• - | The response status code.