amazonka-gamesparks-2.0: Amazon GameSparks SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GamesParks.Lens

Description

 
Synopsis

Operations

CreateGame

createGame_clientToken :: Lens' CreateGame (Maybe Text) Source #

A client-defined token. With an active client token in the request, this action is idempotent.

createGame_description :: Lens' CreateGame (Maybe Text) Source #

The description of the game.

createGame_tags :: Lens' CreateGame (Maybe (HashMap Text Text)) Source #

The list of tags to apply to the game.

createGameResponse_game :: Lens' CreateGameResponse (Maybe GameDetails) Source #

Details about the game that was created.

CreateSnapshot

createSnapshot_description :: Lens' CreateSnapshot (Maybe Text) Source #

The description of the snapshot.

createSnapshotResponse_snapshot :: Lens' CreateSnapshotResponse (Maybe SnapshotDetails) Source #

Properties that provide details of the created snapshot.

CreateStage

createStage_clientToken :: Lens' CreateStage (Maybe Text) Source #

A client-defined token. With an active client token in the request, this action is idempotent.

createStage_description :: Lens' CreateStage (Maybe Text) Source #

The description of the stage.

createStage_tags :: Lens' CreateStage (Maybe (HashMap Text Text)) Source #

The list of tags to apply to the stage.

createStage_role :: Lens' CreateStage Text Source #

The Amazon Resource Name (ARN) of the role to run the game with. This role can be a game-defined role or the default role that GameSparks created.

DeleteGame

deleteGame_gameName :: Lens' DeleteGame Text Source #

The name of the game to delete.

DeleteStage

deleteStage_stageName :: Lens' DeleteStage Text Source #

The name of the stage to delete.

DisconnectPlayer

disconnectPlayer_playerId :: Lens' DisconnectPlayer Text Source #

The unique identifier representing a player.

disconnectPlayerResponse_disconnectFailures :: Lens' DisconnectPlayerResponse (Maybe [Text]) Source #

The list of the connection ids that could not be disconnected.

disconnectPlayerResponse_disconnectSuccesses :: Lens' DisconnectPlayerResponse (Maybe [Text]) Source #

The list of the connection ids that were disconnected.

ExportSnapshot

exportSnapshot_snapshotId :: Lens' ExportSnapshot Text Source #

The identifier of the snapshot to export.

exportSnapshotResponse_s3Url :: Lens' ExportSnapshotResponse (Maybe Text) Source #

The presigned URL for the snapshot data.

This URL will be available for 10 minutes, and can be used to download the snapshot content. If the URL expires, a new one can be requested using the same operation.

GetExtension

getExtension_name :: Lens' GetExtension Text Source #

The name of the extension.

getExtension_namespace :: Lens' GetExtension Text Source #

The namespace (qualifier) of the extension.

GetExtensionVersion

getExtensionVersion_namespace :: Lens' GetExtensionVersion Text Source #

The namespace (qualifier) of the extension.

GetGame

getGame_gameName :: Lens' GetGame Text Source #

The name of the game.

getGameResponse_httpStatus :: Lens' GetGameResponse Int Source #

The response's http status code.

GetGameConfiguration

GetGeneratedCodeJob

getGeneratedCodeJob_jobId :: Lens' GetGeneratedCodeJob Text Source #

The identifier of the code generation job.

getGeneratedCodeJob_snapshotId :: Lens' GetGeneratedCodeJob Text Source #

The identifier of the snapshot for the code generation job.

GetPlayerConnectionStatus

getPlayerConnectionStatus_playerId :: Lens' GetPlayerConnectionStatus Text Source #

The unique identifier representing a player.

getPlayerConnectionStatusResponse_connections :: Lens' GetPlayerConnectionStatusResponse (Maybe [Connection]) Source #

The list of connection ids, one for each connection in use by the player.

GetSnapshot

getSnapshot_sections :: Lens' GetSnapshot (Maybe (NonEmpty Text)) Source #

The list of game configuration sections to be described.

getSnapshot_snapshotId :: Lens' GetSnapshot Text Source #

The identifier of the snapshot.

getSnapshotResponse_snapshot :: Lens' GetSnapshotResponse (Maybe SnapshotDetails) Source #

Properties that provide details of the snapshot.

GetStage

getStage_gameName :: Lens' GetStage Text Source #

The name of the game.

getStage_stageName :: Lens' GetStage Text Source #

The name of the stage.

getStageResponse_stage :: Lens' GetStageResponse (Maybe StageDetails) Source #

Properties that provide details of the stage.

getStageResponse_httpStatus :: Lens' GetStageResponse Int Source #

The response's http status code.

GetStageDeployment

getStageDeployment_deploymentId :: Lens' GetStageDeployment (Maybe Text) Source #

The identifier of the stage deployment. StartStageDeployment returns the identifier that you use here.

ImportGameConfiguration

ListExtensionVersions

listExtensionVersions_maxResults :: Lens' ListExtensionVersions (Maybe Natural) Source #

The maximum number of results to return.

Use this parameter with NextToken to get results as a set of sequential pages.

listExtensionVersions_nextToken :: Lens' ListExtensionVersions (Maybe Text) Source #

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

listExtensionVersions_namespace :: Lens' ListExtensionVersions Text Source #

The namespace (qualifier) of the extension.

listExtensionVersionsResponse_nextToken :: Lens' ListExtensionVersionsResponse (Maybe Text) Source #

The token that indicates the start of the next sequential page of results.

Use this value when making the next call to this operation to continue where the last one finished.

ListExtensions

listExtensions_maxResults :: Lens' ListExtensions (Maybe Natural) Source #

The maximum number of results to return.

Use this parameter with NextToken to get results as a set of sequential pages.

listExtensions_nextToken :: Lens' ListExtensions (Maybe Text) Source #

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

listExtensionsResponse_nextToken :: Lens' ListExtensionsResponse (Maybe Text) Source #

The token that indicates the start of the next sequential page of results.

Use this value when making the next call to this operation to continue where the last one finished.

ListGames

listGames_maxResults :: Lens' ListGames (Maybe Natural) Source #

The maximum number of results to return.

Use this parameter with NextToken to get results as a set of sequential pages.

listGames_nextToken :: Lens' ListGames (Maybe Text) Source #

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

listGamesResponse_nextToken :: Lens' ListGamesResponse (Maybe Text) Source #

The token that indicates the start of the next sequential page of results.

Use this value when making the next call to this operation to continue where the last one finished.

listGamesResponse_httpStatus :: Lens' ListGamesResponse Int Source #

The response's http status code.

ListGeneratedCodeJobs

listGeneratedCodeJobs_maxResults :: Lens' ListGeneratedCodeJobs (Maybe Natural) Source #

The maximum number of results to return.

Use this parameter with NextToken to get results as a set of sequential pages.

listGeneratedCodeJobs_nextToken :: Lens' ListGeneratedCodeJobs (Maybe Text) Source #

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

listGeneratedCodeJobsResponse_nextToken :: Lens' ListGeneratedCodeJobsResponse (Maybe Text) Source #

The token that indicates the start of the next sequential page of results.

Use this value when making the next call to this operation to continue where the last one finished.

ListSnapshots

listSnapshots_maxResults :: Lens' ListSnapshots (Maybe Natural) Source #

The maximum number of results to return.

Use this parameter with NextToken to get results as a set of sequential pages.

listSnapshots_nextToken :: Lens' ListSnapshots (Maybe Text) Source #

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

listSnapshotsResponse_nextToken :: Lens' ListSnapshotsResponse (Maybe Text) Source #

The token that indicates the start of the next sequential page of results.

Use this value when making the next call to this operation to continue where the last one finished.

listSnapshotsResponse_snapshots :: Lens' ListSnapshotsResponse (Maybe [SnapshotSummary]) Source #

A list of snapshot summaries. You can use the returned snapshot IDs in the UpdateSnapshot and GetSnapshot operations.

ListStageDeployments

listStageDeployments_maxResults :: Lens' ListStageDeployments (Maybe Natural) Source #

The maximum number of results to return.

Use this parameter with NextToken to get results as a set of sequential pages.

listStageDeployments_nextToken :: Lens' ListStageDeployments (Maybe Text) Source #

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

listStageDeploymentsResponse_nextToken :: Lens' ListStageDeploymentsResponse (Maybe Text) Source #

The token that indicates the start of the next sequential page of results.

Use this value when making the next call to this operation to continue where the last one finished.

listStageDeploymentsResponse_stageDeployments :: Lens' ListStageDeploymentsResponse (Maybe [StageDeploymentSummary]) Source #

A list of stage deployment summaries. You can use the deployment IDs in the UpdateStageDeployment and GetStageDeployment actions.

ListStages

listStages_maxResults :: Lens' ListStages (Maybe Natural) Source #

The maximum number of results to return.

Use this parameter with NextToken to get results as a set of sequential pages.

listStages_nextToken :: Lens' ListStages (Maybe Text) Source #

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

listStagesResponse_nextToken :: Lens' ListStagesResponse (Maybe Text) Source #

The token that indicates the start of the next sequential page of results.

Use this value when making the next call to this operation to continue where the last one finished.

listStagesResponse_stages :: Lens' ListStagesResponse (Maybe [StageSummary]) Source #

A list of stage summaries. You can use the stage names in the UpdateStage and GetStage actions.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the GameSparks resource.

StartGeneratedCodeJob

startGeneratedCodeJob_generator :: Lens' StartGeneratedCodeJob Generator Source #

Properties of the generator to use for the job.

startGeneratedCodeJob_snapshotId :: Lens' StartGeneratedCodeJob Text Source #

The identifier of the snapshot for which to generate code.

startGeneratedCodeJobResponse_generatedCodeJobId :: Lens' StartGeneratedCodeJobResponse (Maybe Text) Source #

The identifier of the code generation job. You can use this identifier in the GetGeneratedCodeJob operation.

StartStageDeployment

startStageDeployment_clientToken :: Lens' StartStageDeployment (Maybe Text) Source #

A client-defined token. With an active client token in the request, this action is idempotent.

startStageDeployment_snapshotId :: Lens' StartStageDeployment Text Source #

The identifier of the snapshot to deploy.

startStageDeployment_stageName :: Lens' StartStageDeployment Text Source #

The name of the stage to deploy the snapshot onto.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource to add the tags to.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags to add to the resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource to remove the tags from.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The keys of the tags to remove.

UpdateGame

updateGame_description :: Lens' UpdateGame (Maybe Text) Source #

The description of the game.

UpdateGameConfiguration

UpdateSnapshot

updateSnapshot_description :: Lens' UpdateSnapshot (Maybe Text) Source #

The description of the snapshot.

updateSnapshot_snapshotId :: Lens' UpdateSnapshot Text Source #

The identifier of the snapshot.

updateSnapshotResponse_snapshot :: Lens' UpdateSnapshotResponse (Maybe SnapshotDetails) Source #

Properties that provide details of the updated snapshot.

UpdateStage

updateStage_description :: Lens' UpdateStage (Maybe Text) Source #

The description of the stage.

updateStage_role :: Lens' UpdateStage (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role to use for the game snapshots deployed to this stage.

updateStageResponse_stage :: Lens' UpdateStageResponse (Maybe StageDetails) Source #

Properties that provide details of the updated stage.

Types

Connection

connection_created :: Lens' Connection (Maybe UTCTime) Source #

The date and time when the connection was created.

connection_id :: Lens' Connection (Maybe Text) Source #

The identifier used to indicate a specific WebSocket connection.

DeploymentResult

deploymentResult_message :: Lens' DeploymentResult (Maybe Text) Source #

Details about the deployment result.

Document

ExtensionDetails

extensionDetails_description :: Lens' ExtensionDetails (Maybe Text) Source #

The description of the extension.

extensionDetails_namespace :: Lens' ExtensionDetails (Maybe Text) Source #

The namespace (qualifier) of the extension.

ExtensionVersionDetails

extensionVersionDetails_namespace :: Lens' ExtensionVersionDetails (Maybe Text) Source #

The namespace (qualifier) of the extension.

extensionVersionDetails_schema :: Lens' ExtensionVersionDetails (Maybe Text) Source #

The model that defines the interface for this extension version.

GameConfigurationDetails

GameDetails

gameDetails_arn :: Lens' GameDetails (Maybe Text) Source #

The Amazon Resource Name (ARN) of this game.

gameDetails_created :: Lens' GameDetails (Maybe UTCTime) Source #

The date when the game was created.

gameDetails_description :: Lens' GameDetails (Maybe Text) Source #

The description of the game.

gameDetails_enableTerminationProtection :: Lens' GameDetails (Maybe Bool) Source #

Determines if the game can be deleted.

gameDetails_lastUpdated :: Lens' GameDetails (Maybe UTCTime) Source #

The date when the game was last modified.

gameDetails_name :: Lens' GameDetails (Maybe Text) Source #

The name of the game.

gameDetails_tags :: Lens' GameDetails (Maybe (HashMap Text Text)) Source #

The tags associated with the game.

GameSummary

gameSummary_description :: Lens' GameSummary (Maybe Text) Source #

The description of the game.

gameSummary_name :: Lens' GameSummary (Maybe Text) Source #

The name of the game.

gameSummary_tags :: Lens' GameSummary (Maybe (HashMap Text Text)) Source #

The tags associated with the game.

GeneratedCodeJobDetails

generatedCodeJobDetails_description :: Lens' GeneratedCodeJobDetails (Maybe Text) Source #

The description of the generated code job.

generatedCodeJobDetails_expirationTime :: Lens' GeneratedCodeJobDetails (Maybe UTCTime) Source #

The expiration date and time for the download URL.

The download URL us guaranteed to be available until at least this time.

generatedCodeJobDetails_s3Url :: Lens' GeneratedCodeJobDetails (Maybe Text) Source #

A presigned URL that can be used to download the generated code.

Generator

generator_gameSdkVersion :: Lens' Generator (Maybe Text) Source #

The target version of the GameSparks Game SDK.

generator_language :: Lens' Generator (Maybe Text) Source #

The programming language for the generated code.

Not all languages are supported for each platform. For cases where multiple languages are supported, this parameter specifies the language to be used. If this value is omitted, the default language for the target platform will be used.

generator_targetPlatform :: Lens' Generator (Maybe Text) Source #

The platform that will be used to run the generated code.

ImportGameConfigurationSource

importGameConfigurationSource_file :: Lens' ImportGameConfigurationSource ByteString Source #

The JSON string containing the configuration sections.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Section

section_attributes :: Lens' Section (Maybe Document) Source #

The content of a configuration section.

section_name :: Lens' Section (Maybe Text) Source #

The name of the section.

section_size :: Lens' Section (Maybe Natural) Source #

The size, in bytes, of the section contents.

SectionModification

sectionModification_value :: Lens' SectionModification (Maybe Document) Source #

For add and replace operations, this is the value that will be used.

This field should be omitted for delete operations.

sectionModification_operation :: Lens' SectionModification Operation Source #

The operation to be performed on a configuration section.

Content can be added, deleted, or replaced within a section.

sectionModification_path :: Lens' SectionModification Text Source #

The path within the section content to be modified.

sectionModification_section :: Lens' SectionModification Text Source #

The name of the section to be modified.

SnapshotDetails

snapshotDetails_created :: Lens' SnapshotDetails (Maybe UTCTime) Source #

The timestamp of when the snapshot was created.

snapshotDetails_description :: Lens' SnapshotDetails (Maybe Text) Source #

The description of the snapshot.

snapshotDetails_id :: Lens' SnapshotDetails (Maybe Text) Source #

The identifier of the snapshot.

snapshotDetails_lastUpdated :: Lens' SnapshotDetails (Maybe UTCTime) Source #

The timestamp of when the snapshot was last updated.

SnapshotSummary

snapshotSummary_created :: Lens' SnapshotSummary (Maybe UTCTime) Source #

The timestamp of when the snapshot was created.

snapshotSummary_description :: Lens' SnapshotSummary (Maybe Text) Source #

The description of the snapshot.

snapshotSummary_id :: Lens' SnapshotSummary (Maybe Text) Source #

The identifier of the snapshot.

snapshotSummary_lastUpdated :: Lens' SnapshotSummary (Maybe UTCTime) Source #

Then timestamp of when the snapshot was last updated.

StageDeploymentDetails

stageDeploymentDetails_created :: Lens' StageDeploymentDetails (Maybe UTCTime) Source #

The timestamp of when the stage deployment was created.

stageDeploymentDetails_lastUpdated :: Lens' StageDeploymentDetails (Maybe UTCTime) Source #

The timestamp of when the deployment was last updated.

stageDeploymentDetails_snapshotId :: Lens' StageDeploymentDetails (Maybe Text) Source #

The identifier of the snapshot associated with the stage deployment.

StageDeploymentSummary

stageDeploymentSummary_lastUpdated :: Lens' StageDeploymentSummary (Maybe UTCTime) Source #

The timestamp of when the deployment was last updated.

stageDeploymentSummary_snapshotId :: Lens' StageDeploymentSummary (Maybe Text) Source #

The identifier of the snapshot associated with the stage deployment.

StageDetails

stageDetails_arn :: Lens' StageDetails (Maybe Text) Source #

The Amazon Resource Name (ARN) of the stage.

stageDetails_created :: Lens' StageDetails (Maybe UTCTime) Source #

The timestamp of when the stage was created.

stageDetails_description :: Lens' StageDetails (Maybe Text) Source #

The description of the stage.

stageDetails_gameKey :: Lens' StageDetails (Maybe Text) Source #

The game key associated with the stage.

The game key is a unique identifier that the game client uses to connect to the GameSparks backend.

stageDetails_lastUpdated :: Lens' StageDetails (Maybe UTCTime) Source #

The timestamp of when the stage was last updated.

stageDetails_logGroup :: Lens' StageDetails (Maybe Text) Source #

The Amazon CloudWatch log group for game runtimes deployed to the stage.

stageDetails_role :: Lens' StageDetails (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role used to run the game runtimes deployed to the stage.

stageDetails_tags :: Lens' StageDetails (Maybe (HashMap Text Text)) Source #

The tags associated with the stage.

StageSummary

stageSummary_description :: Lens' StageSummary (Maybe Text) Source #

The description of the stage.

stageSummary_gameKey :: Lens' StageSummary (Maybe Text) Source #

The game key associated with the stage.

The game key is a unique identifier that the game client uses to connect to the GameSparks backend.

stageSummary_tags :: Lens' StageSummary (Maybe (HashMap Text Text)) Source #

The tags associated with the stage.