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

Amazonka.GameLift.ListScripts

Description

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

Learn more

Amazon GameLift Realtime Servers

Related actions

CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task

This operation returns paginated results.

Synopsis

Creating a Request

data ListScripts Source #

See: newListScripts smart constructor.

Constructors

ListScripts' 

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.

Instances

Instances details
Eq ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Read ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Show ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Generic ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Associated Types

type Rep ListScripts :: Type -> Type #

NFData ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

rnf :: ListScripts -> () #

Hashable ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

ToJSON ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

AWSPager ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

AWSRequest ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Associated Types

type AWSResponse ListScripts #

ToHeaders ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

toHeaders :: ListScripts -> [Header] #

ToPath ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

ToQuery ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

type Rep ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

type Rep ListScripts = D1 ('MetaData "ListScripts" "Amazonka.GameLift.ListScripts" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "ListScripts'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListScripts Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

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

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

Request Lenses

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.

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.

Destructuring the Response

data ListScriptsResponse Source #

See: newListScriptsResponse smart constructor.

Constructors

ListScriptsResponse' 

Fields

  • scripts :: Maybe [Script]

    A set of properties describing the requested script.

  • 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
Eq ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Read ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Show ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Generic ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Associated Types

type Rep ListScriptsResponse :: Type -> Type #

NFData ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

Methods

rnf :: ListScriptsResponse -> () #

type Rep ListScriptsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListScripts

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

newListScriptsResponse Source #

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:

$sel:scripts:ListScriptsResponse', listScriptsResponse_scripts - A set of properties describing the requested script.

$sel:nextToken: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:httpStatus:ListScriptsResponse', listScriptsResponse_httpStatus - The response's http status code.

Response Lenses

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

A set of properties describing the requested script.

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.