Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GameLift.DescribeFleetLocationAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.

This operation can be used in the following ways:

To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.
To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.

When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.

Learn more

Setting up GameLift fleets

Related actions

Synopsis

Creating a Request

data DescribeFleetLocationAttributes Source #

Represents the input for a request operation.

See: newDescribeFleetLocationAttributes smart constructor.

Constructors

DescribeFleetLocationAttributes'

Fields

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.
limit :: Maybe Natural
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.
locations :: Maybe (NonEmpty Text)
A list of fleet locations to retrieve information for. Specify locations in the form of an AWS Region code, such as us-west-2.
fleetId :: Text
A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.

Instances

Instances details

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

newDescribeFleetLocationAttributes Source #

Arguments

:: Text	`$sel:fleetId:DescribeFleetLocationAttributes'`
-> DescribeFleetLocationAttributes

Create a value of DescribeFleetLocationAttributes 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:nextToken:DescribeFleetLocationAttributes', describeFleetLocationAttributes_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.

$sel:limit:DescribeFleetLocationAttributes', describeFleetLocationAttributes_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.

$sel:locations:DescribeFleetLocationAttributes', describeFleetLocationAttributes_locations - A list of fleet locations to retrieve information for. Specify locations in the form of an AWS Region code, such as us-west-2.

$sel:fleetId:DescribeFleetLocationAttributes', describeFleetLocationAttributes_fleetId - A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.

Request Lenses

describeFleetLocationAttributes_nextToken :: Lens' DescribeFleetLocationAttributes (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.

describeFleetLocationAttributes_limit :: Lens' DescribeFleetLocationAttributes (Maybe Natural) Source #

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.

describeFleetLocationAttributes_locations :: Lens' DescribeFleetLocationAttributes (Maybe (NonEmpty Text)) Source #

A list of fleet locations to retrieve information for. Specify locations in the form of an AWS Region code, such as us-west-2.

describeFleetLocationAttributes_fleetId :: Lens' DescribeFleetLocationAttributes Text Source #

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

Destructuring the Response

data DescribeFleetLocationAttributesResponse Source #

Represents the returned data in response to a request operation.

See: newDescribeFleetLocationAttributesResponse smart constructor.

Constructors

DescribeFleetLocationAttributesResponse'

Fields

fleetArn :: Maybe Text
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
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.
locationAttributes :: Maybe [LocationAttributes]
Location-specific information on the requested fleet's remote locations.
fleetId :: Maybe Text
A unique identifier for the fleet that location attributes were requested for.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeFleetLocationAttributesResponse Source #

Arguments

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

Create a value of DescribeFleetLocationAttributesResponse 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:fleetArn:DescribeFleetLocationAttributesResponse', describeFleetLocationAttributesResponse_fleetArn - The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

$sel:nextToken:DescribeFleetLocationAttributes', describeFleetLocationAttributesResponse_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:locationAttributes:DescribeFleetLocationAttributesResponse', describeFleetLocationAttributesResponse_locationAttributes - Location-specific information on the requested fleet's remote locations.

$sel:fleetId:DescribeFleetLocationAttributes', describeFleetLocationAttributesResponse_fleetId - A unique identifier for the fleet that location attributes were requested for.

$sel:httpStatus:DescribeFleetLocationAttributesResponse', describeFleetLocationAttributesResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetLocationAttributesResponse_fleetArn :: Lens' DescribeFleetLocationAttributesResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

describeFleetLocationAttributesResponse_nextToken :: Lens' DescribeFleetLocationAttributesResponse (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.

describeFleetLocationAttributesResponse_locationAttributes :: Lens' DescribeFleetLocationAttributesResponse (Maybe [LocationAttributes]) Source #

Location-specific information on the requested fleet's remote locations.

describeFleetLocationAttributesResponse_fleetId :: Lens' DescribeFleetLocationAttributesResponse (Maybe Text) Source #

A unique identifier for the fleet that location attributes were requested for.

describeFleetLocationAttributesResponse_httpStatus :: Lens' DescribeFleetLocationAttributesResponse Int Source #

The response's http status code.