amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.ListScripts

Description

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

This operation returns paginated results.

Synopsis

Creating a Request

data ListScripts Source #

See: newListScripts smart constructor.

Constructors

ListScripts' 

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.

Instances

Instances details
ToJSON ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

toJSON :: ListScripts -> Value #

toEncoding :: ListScripts -> Encoding #

toJSONList :: [ListScripts] -> Value #

toEncodingList :: [ListScripts] -> Encoding #

ToHeaders ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

toHeaders :: ListScripts -> [Header] #

ToPath ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

toPath :: ListScripts -> ByteString #

ToQuery ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

toQuery :: ListScripts -> QueryString #

AWSPager ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

page :: ListScripts -> AWSResponse ListScripts -> Maybe ListScripts #

AWSRequest ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Associated Types

type AWSResponse ListScripts #

Methods

request :: (Service -> Service) -> ListScripts -> Request ListScripts #

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

Generic ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Associated Types

type Rep ListScripts :: Type -> Type #

Methods

from :: ListScripts -> Rep ListScripts x #

to :: Rep ListScripts x -> ListScripts #

Read ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

readsPrec :: Int -> ReadS ListScripts #

readList :: ReadS [ListScripts] #

readPrec :: ReadPrec ListScripts #

readListPrec :: ReadPrec [ListScripts] #

Show ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

showsPrec :: Int -> ListScripts -> ShowS #

show :: ListScripts -> String #

showList :: [ListScripts] -> ShowS #

NFData ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

rnf :: ListScripts -> () #

Eq ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

(==) :: ListScripts -> ListScripts -> Bool #

(/=) :: ListScripts -> ListScripts -> Bool #

Hashable ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

hashWithSalt :: Int -> ListScripts -> Int #

hash :: ListScripts -> Int #

type AWSResponse ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

type AWSResponse ListScripts = ListScriptsResponse
type Rep ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

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

newListScripts :: ListScripts Source #

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

ListScripts, listScripts_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.

Request Lenses

listScripts_limit :: Lens' ListScripts (Maybe Natural) Source #

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

listScripts_nextToken :: Lens' ListScripts (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.

Destructuring the Response

data ListScriptsResponse Source #

See: newListScriptsResponse smart constructor.

Constructors

ListScriptsResponse' 

Fields

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

  • scripts :: Maybe [Script]

    A set of properties describing the requested script.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Associated Types

type Rep ListScriptsResponse :: Type -> Type #

Methods

from :: ListScriptsResponse -> Rep ListScriptsResponse x #

to :: Rep ListScriptsResponse x -> ListScriptsResponse #

Read ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

readsPrec :: Int -> ReadS ListScriptsResponse #

readList :: ReadS [ListScriptsResponse] #

readPrec :: ReadPrec ListScriptsResponse #

readListPrec :: ReadPrec [ListScriptsResponse] #

Show ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

showsPrec :: Int -> ListScriptsResponse -> ShowS #

show :: ListScriptsResponse -> String #

showList :: [ListScriptsResponse] -> ShowS #

NFData ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

rnf :: ListScriptsResponse -> () #

Eq ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

(==) :: ListScriptsResponse -> ListScriptsResponse -> Bool #

(/=) :: ListScriptsResponse -> ListScriptsResponse -> Bool #

type Rep ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

type Rep ListScriptsResponse = D1 ('MetaData "ListScriptsResponse" "Amazonka.GameLift.ListScripts" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "ListScriptsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "scripts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Script])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListScriptsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListScriptsResponse'

-> ListScriptsResponse 

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

ListScripts, listScriptsResponse_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:scripts:ListScriptsResponse', listScriptsResponse_scripts - A set of properties describing the requested script.

$sel:httpStatus:ListScriptsResponse', listScriptsResponse_httpStatus - The response's http status code.

Response Lenses

listScriptsResponse_nextToken :: Lens' ListScriptsResponse (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.

listScriptsResponse_scripts :: Lens' ListScriptsResponse (Maybe [Script]) Source #

A set of properties describing the requested script.

listScriptsResponse_httpStatus :: Lens' ListScriptsResponse Int Source #

The response's http status code.