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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build resources are not listed in any particular order.

Learn more

Upload a Custom Server Build

All APIs by task

This operation returns paginated results.

Synopsis

data ListBuilds = ListBuilds' {
- limit :: Maybe Natural
- nextToken :: Maybe Text
- status :: Maybe BuildStatus
}
newListBuilds :: ListBuilds
listBuilds_limit :: Lens' ListBuilds (Maybe Natural)
listBuilds_nextToken :: Lens' ListBuilds (Maybe Text)
listBuilds_status :: Lens' ListBuilds (Maybe BuildStatus)
data ListBuildsResponse = ListBuildsResponse' {
- builds :: Maybe [Build]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListBuildsResponse :: Int -> ListBuildsResponse
listBuildsResponse_builds :: Lens' ListBuildsResponse (Maybe [Build])
listBuildsResponse_nextToken :: Lens' ListBuildsResponse (Maybe Text)
listBuildsResponse_httpStatus :: Lens' ListBuildsResponse Int

Creating a Request

data ListBuilds Source #

See: newListBuilds smart constructor.

Constructors

ListBuilds'

Fields

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.
status :: Maybe BuildStatus
Build status to filter results by. To retrieve all builds, leave this parameter empty.
Possible build statuses include the following:
- INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.
- READY -- The game build has been successfully uploaded. You can now create new fleets for this build.
- FAILED -- The game build upload failed. You cannot create new fleets for this build.

Instances

Instances details

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

newListBuilds :: ListBuilds Source #

Create a value of ListBuilds 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:limit:ListBuilds', listBuilds_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

ListBuilds, listBuilds_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.

ListBuilds, listBuilds_status - Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.
READY -- The game build has been successfully uploaded. You can now create new fleets for this build.
FAILED -- The game build upload failed. You cannot create new fleets for this build.

Request Lenses

listBuilds_limit :: Lens' ListBuilds (Maybe Natural) Source #

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

listBuilds_nextToken :: Lens' ListBuilds (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.

listBuilds_status :: Lens' ListBuilds (Maybe BuildStatus) Source #

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.
READY -- The game build has been successfully uploaded. You can now create new fleets for this build.
FAILED -- The game build upload failed. You cannot create new fleets for this build.

Destructuring the Response

data ListBuildsResponse Source #

See: newListBuildsResponse smart constructor.

Constructors

ListBuildsResponse'
Fields builds :: Maybe [Build] A collection of build resources that match the 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

Instances details

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

newListBuildsResponse Source #

Arguments

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

Create a value of ListBuildsResponse 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:builds:ListBuildsResponse', listBuildsResponse_builds - A collection of build resources that match the request.

ListBuilds, listBuildsResponse_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:ListBuildsResponse', listBuildsResponse_httpStatus - The response's http status code.

Response Lenses

listBuildsResponse_builds :: Lens' ListBuildsResponse (Maybe [Build]) Source #

A collection of build resources that match the request.

listBuildsResponse_nextToken :: Lens' ListBuildsResponse (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.

listBuildsResponse_httpStatus :: Lens' ListBuildsResponse Int Source #

The response's http status code.