GameLift / Client / describe_script

describe_script#

GameLift.Client.describe_script(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_script(
    ScriptId='string'
)
Parameters:

ScriptId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Script': {
        'ScriptId': 'string',
        'ScriptArn': 'string',
        'Name': 'string',
        'Version': 'string',
        'SizeOnDisk': 123,
        'CreationTime': datetime(2015, 1, 1),
        'StorageLocation': {
            'Bucket': 'string',
            'Key': 'string',
            'RoleArn': 'string',
            'ObjectVersion': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • Script (dict) –

      A set of properties describing the requested script.

      • ScriptId (string) –

        A unique identifier for the Realtime script

      • ScriptArn (string) –

        The Amazon Resource Name ( ARN) that is assigned to a GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.

      • Name (string) –

        A descriptive label that is associated with a script. Script names do not need to be unique.

      • Version (string) –

        Version information associated with a build or script. Version strings do not need to be unique.

      • SizeOnDisk (integer) –

        The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at “0”.

      • CreationTime (datetime) –

        A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      • StorageLocation (dict) –

        The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the “key”), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.

        • Bucket (string) –

          An Amazon S3 bucket identifier. Thename of the S3 bucket.

          Note

          GameLift doesn’t support uploading from Amazon S3 buckets with names that contain a dot (.).

        • Key (string) –

          The name of the zip file that contains the build files or script files.

        • RoleArn (string) –

          The Amazon Resource Name ( ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.

        • ObjectVersion (string) –

          The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

Exceptions

  • GameLift.Client.exceptions.UnauthorizedException

  • GameLift.Client.exceptions.InvalidRequestException

  • GameLift.Client.exceptions.InternalServiceException

  • GameLift.Client.exceptions.NotFoundException