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

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

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

Synopsis

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

Defined in Amazonka.GameLift.DeleteScript

Read DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

Show DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

Generic DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

Associated Types

type Rep DeleteScript :: Type -> Type #

NFData DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

Methods

rnf :: DeleteScript -> () #

Hashable DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

ToJSON DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

AWSRequest DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

Associated Types

type AWSResponse DeleteScript #

ToHeaders DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

ToPath DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

ToQuery DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

type Rep DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

type Rep DeleteScript = D1 ('MetaData "DeleteScript" "Amazonka.GameLift.DeleteScript" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DeleteScript'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scriptId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteScript Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

newDeleteScript Source #

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:

$sel:scriptId: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
Eq DeleteScriptResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

Read DeleteScriptResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

Show DeleteScriptResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

Generic DeleteScriptResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

Associated Types

type Rep DeleteScriptResponse :: Type -> Type #

NFData DeleteScriptResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

Methods

rnf :: DeleteScriptResponse -> () #

type Rep DeleteScriptResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteScript

type Rep DeleteScriptResponse = D1 ('MetaData "DeleteScriptResponse" "Amazonka.GameLift.DeleteScript" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" '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.