Amazonka.GameLift.ListFleets

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.

This operation can be used in the following ways:

• To get a list of all fleets in a Region, don't provide a build or script identifier.
• To get a list of all fleets where a specific custom game build is deployed, provide the build ID.
• To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.

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

If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.

Fleet resources are not listed in a particular order.

Learn more

Setting up GameLift fleets

This operation returns paginated results.

Creating a Request

data ListFleets

See: newListFleets smart constructor.

Constructors

ListFleets'

Fields

• buildId :: Maybe Text

  A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN 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.

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

• scriptId :: Maybe Text

  A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.

Instances

ToJSON ListFleets

Defined in Amazonka.GameLift.ListFleets

Methods

toJSON :: ListFleets -> Value

toEncoding :: ListFleets -> Encoding

toJSONList :: [ListFleets] -> Value

toEncodingList :: [ListFleets] -> Encoding

ToHeaders ListFleets

Defined in Amazonka.GameLift.ListFleets

Methods

toHeaders :: ListFleets -> [Header]

ToPath ListFleets

Defined in Amazonka.GameLift.ListFleets

Methods

toPath :: ListFleets -> ByteString

ToQuery ListFleets

Defined in Amazonka.GameLift.ListFleets

Methods

toQuery :: ListFleets -> QueryString

AWSPager ListFleets

Defined in Amazonka.GameLift.ListFleets

Methods

page :: ListFleets -> AWSResponse ListFleets -> Maybe ListFleets

AWSRequest ListFleets

Defined in Amazonka.GameLift.ListFleets

Associated Types

type AWSResponse ListFleets

Methods

request :: (Service -> Service) -> ListFleets -> Request ListFleets

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListFleets -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListFleets)))

Generic ListFleets

Defined in Amazonka.GameLift.ListFleets

Associated Types

type Rep ListFleets :: Type -> Type

Methods

from :: ListFleets -> Rep ListFleets x

to :: Rep ListFleets x -> ListFleets

Read ListFleets

Defined in Amazonka.GameLift.ListFleets

Methods

readsPrec :: Int -> ReadS ListFleets

readList :: ReadS [ListFleets]

readPrec :: ReadPrec ListFleets

readListPrec :: ReadPrec [ListFleets]

Show ListFleets

Defined in Amazonka.GameLift.ListFleets

Methods

showsPrec :: Int -> ListFleets -> ShowS

show :: ListFleets -> String

showList :: [ListFleets] -> ShowS

NFData ListFleets

Defined in Amazonka.GameLift.ListFleets

Methods

rnf :: ListFleets -> ()

Eq ListFleets

Defined in Amazonka.GameLift.ListFleets

Methods

(==) :: ListFleets -> ListFleets -> Bool

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

Hashable ListFleets

Defined in Amazonka.GameLift.ListFleets

Methods

hashWithSalt :: Int -> ListFleets -> Int

hash :: ListFleets -> Int

type AWSResponse ListFleets

Defined in Amazonka.GameLift.ListFleets

type AWSResponse ListFleets = ListFleetsResponse

type Rep ListFleets

Defined in Amazonka.GameLift.ListFleets

type Rep ListFleets = D1 ('MetaData "ListFleets" "Amazonka.GameLift.ListFleets" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "ListFleets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "buildId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scriptId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListFleets :: ListFleets

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

ListFleets, listFleets_buildId - A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.

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

ListFleets, listFleets_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.

ListFleets, listFleets_scriptId - A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.

Request Lenses

listFleets_buildId :: Lens' ListFleets (Maybe Text)

A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.

listFleets_limit :: Lens' ListFleets (Maybe Natural)

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

listFleets_nextToken :: Lens' ListFleets (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.

listFleets_scriptId :: Lens' ListFleets (Maybe Text)

A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.

Destructuring the Response

data ListFleetsResponse

See: newListFleetsResponse smart constructor.

Constructors

ListFleetsResponse'

Fields

• fleetIds :: Maybe (NonEmpty Text)

  A set of fleet IDs that match the list request.

• 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

Generic ListFleetsResponse

Defined in Amazonka.GameLift.ListFleets

Associated Types

type Rep ListFleetsResponse :: Type -> Type

Methods

from :: ListFleetsResponse -> Rep ListFleetsResponse x

to :: Rep ListFleetsResponse x -> ListFleetsResponse

Read ListFleetsResponse

Defined in Amazonka.GameLift.ListFleets

Methods

readsPrec :: Int -> ReadS ListFleetsResponse

readList :: ReadS [ListFleetsResponse]

readPrec :: ReadPrec ListFleetsResponse

readListPrec :: ReadPrec [ListFleetsResponse]

Show ListFleetsResponse

Defined in Amazonka.GameLift.ListFleets

Methods

showsPrec :: Int -> ListFleetsResponse -> ShowS

show :: ListFleetsResponse -> String

showList :: [ListFleetsResponse] -> ShowS

NFData ListFleetsResponse

Defined in Amazonka.GameLift.ListFleets

Methods

rnf :: ListFleetsResponse -> ()

Eq ListFleetsResponse

Defined in Amazonka.GameLift.ListFleets

Methods

(==) :: ListFleetsResponse -> ListFleetsResponse -> Bool

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

type Rep ListFleetsResponse

Defined in Amazonka.GameLift.ListFleets

type Rep ListFleetsResponse = D1 ('MetaData "ListFleetsResponse" "Amazonka.GameLift.ListFleets" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "ListFleetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListFleetsResponse

Arguments

:: Int

$sel:httpStatus:ListFleetsResponse'

-> ListFleetsResponse

Create a value of ListFleetsResponse 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:fleetIds:ListFleetsResponse', listFleetsResponse_fleetIds - A set of fleet IDs that match the list request.

ListFleets, listFleetsResponse_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:ListFleetsResponse', listFleetsResponse_httpStatus - The response's http status code.

Response Lenses

listFleetsResponse_fleetIds :: Lens' ListFleetsResponse (Maybe (NonEmpty Text))

A set of fleet IDs that match the list request.

listFleetsResponse_nextToken :: Lens' ListFleetsResponse (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.

listFleetsResponse_httpStatus :: Lens' ListFleetsResponse Int

The response's http status code.