amazonka-gamelift-1.5.0: Amazon GameLift SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.GameLift.ListBuilds

Contents

Description

Retrieves build records for all builds associated with the AWS 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-related operations include:

  • CreateBuild
  • ListBuilds
  • DescribeBuild
  • UpdateBuild
  • DeleteBuild

Synopsis

Creating a Request

listBuilds :: ListBuilds Source #

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

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

  • lbStatus - 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.
  • lbNextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
  • lbLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

data ListBuilds Source #

Represents the input for a request action.

See: listBuilds smart constructor.

Instances

Eq ListBuilds Source # 
Data ListBuilds Source # 

Methods

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

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

toConstr :: ListBuilds -> Constr #

dataTypeOf :: ListBuilds -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ListBuilds -> ListBuilds #

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

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

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

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

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

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

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

Read ListBuilds Source # 
Show ListBuilds Source # 
Generic ListBuilds Source # 

Associated Types

type Rep ListBuilds :: * -> * #

Hashable ListBuilds Source # 
ToJSON ListBuilds Source # 
NFData ListBuilds Source # 

Methods

rnf :: ListBuilds -> () #

AWSRequest ListBuilds Source # 
ToQuery ListBuilds Source # 
ToPath ListBuilds Source # 
ToHeaders ListBuilds Source # 

Methods

toHeaders :: ListBuilds -> [Header] #

type Rep ListBuilds Source # 
type Rep ListBuilds = D1 (MetaData "ListBuilds" "Network.AWS.GameLift.ListBuilds" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "ListBuilds'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lbStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BuildStatus))) ((:*:) (S1 (MetaSel (Just Symbol "_lbNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lbLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))
type Rs ListBuilds Source # 

Request Lenses

lbStatus :: 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.

lbNextToken :: Lens' ListBuilds (Maybe Text) Source #

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

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

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

Destructuring the Response

listBuildsResponse Source #

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

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

  • lbrsBuilds - Collection of build records that match the request.
  • lbrsNextToken - Token that indicates 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.
  • lbrsResponseStatus - -- | The response status code.

data ListBuildsResponse Source #

Represents the returned data in response to a request action.

See: listBuildsResponse smart constructor.

Instances

Eq ListBuildsResponse Source # 
Data ListBuildsResponse Source # 

Methods

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

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

toConstr :: ListBuildsResponse -> Constr #

dataTypeOf :: ListBuildsResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ListBuildsResponse -> ListBuildsResponse #

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

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

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

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

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

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

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

Read ListBuildsResponse Source # 
Show ListBuildsResponse Source # 
Generic ListBuildsResponse Source # 
NFData ListBuildsResponse Source # 

Methods

rnf :: ListBuildsResponse -> () #

type Rep ListBuildsResponse Source # 
type Rep ListBuildsResponse = D1 (MetaData "ListBuildsResponse" "Network.AWS.GameLift.ListBuilds" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "ListBuildsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lbrsBuilds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Build]))) ((:*:) (S1 (MetaSel (Just Symbol "_lbrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

lbrsBuilds :: Lens' ListBuildsResponse [Build] Source #

Collection of build records that match the request.

lbrsNextToken :: Lens' ListBuildsResponse (Maybe Text) Source #

Token that indicates 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.

lbrsResponseStatus :: Lens' ListBuildsResponse Int Source #

  • - | The response status code.