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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).

To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

Synopsis

data DeleteScript = DeleteScript' {
- scriptId :: Text
}
newDeleteScript :: Text -> DeleteScript
deleteScript_scriptId :: Lens' DeleteScript Text
data DeleteScriptResponse = DeleteScriptResponse' {
}
newDeleteScriptResponse :: DeleteScriptResponse

Creating a Request

data DeleteScript Source #

See: newDeleteScript smart constructor.

Constructors

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

Instances

Instances details

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

newDeleteScript Source #

Arguments

:: Text	`DeleteScript`
-> DeleteScript

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

DeleteScript, deleteScript_scriptId - A unique identifier for the Realtime script to delete. You can use either the script ID or ARN value.

Request Lenses

deleteScript_scriptId :: Lens' DeleteScript Text Source #

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

Destructuring the Response

data DeleteScriptResponse Source #

See: newDeleteScriptResponse smart constructor.

Constructors

DeleteScriptResponse'

Instances

Instances details

Generic DeleteScriptResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteScript Associated Types type Rep DeleteScriptResponse :: Type -> Type # Methods from :: DeleteScriptResponse -> Rep DeleteScriptResponse x # to :: Rep DeleteScriptResponse x -> DeleteScriptResponse #
Read DeleteScriptResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteScript Methods readsPrec :: Int -> ReadS DeleteScriptResponse # readList :: ReadS [DeleteScriptResponse] # readPrec :: ReadPrec DeleteScriptResponse # readListPrec :: ReadPrec [DeleteScriptResponse] #
Show DeleteScriptResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteScript Methods showsPrec :: Int -> DeleteScriptResponse -> ShowS # show :: DeleteScriptResponse -> String # showList :: [DeleteScriptResponse] -> ShowS #
NFData DeleteScriptResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteScript Methods rnf :: DeleteScriptResponse -> () #
Eq DeleteScriptResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteScript Methods (==) :: DeleteScriptResponse -> DeleteScriptResponse -> Bool # (/=) :: DeleteScriptResponse -> DeleteScriptResponse -> Bool #
type Rep DeleteScriptResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteScript type Rep DeleteScriptResponse = D1 ('MetaData "DeleteScriptResponse" "Amazonka.GameLift.DeleteScript" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DeleteScriptResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteScriptResponse :: DeleteScriptResponse Source #

Create a value of DeleteScriptResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.