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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves properties for a Realtime script.

To request a script record, specify the script ID. If successful, an object containing the script properties is returned.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

Creating a Request

data DescribeScript Source #

See: newDescribeScript smart constructor.

Constructors

DescribeScript'
Fields scriptId :: Text A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.

Instances

Instances details

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

newDescribeScript Source #

Arguments

:: Text	`DescribeScript`
-> DescribeScript

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

DescribeScript, describeScript_scriptId - A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.

Request Lenses

describeScript_scriptId :: Lens' DescribeScript Text Source #

A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.

Destructuring the Response

data DescribeScriptResponse Source #

See: newDescribeScriptResponse smart constructor.

Constructors

DescribeScriptResponse'
Fields script :: Maybe Script A set of properties describing the requested script. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeScriptResponse Source #

Arguments

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

Create a value of DescribeScriptResponse 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:script:DescribeScriptResponse', describeScriptResponse_script - A set of properties describing the requested script.

$sel:httpStatus:DescribeScriptResponse', describeScriptResponse_httpStatus - The response's http status code.

Response Lenses

describeScriptResponse_script :: Lens' DescribeScriptResponse (Maybe Script) Source #

A set of properties describing the requested script.

describeScriptResponse_httpStatus :: Lens' DescribeScriptResponse Int Source #

The response's http status code.