| 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.GamesParks.Types
Contents
- Service Configuration
- Errors
- DeploymentAction
- DeploymentState
- GameState
- GeneratedCodeJobState
- Operation
- ResultCode
- StageState
- Connection
- DeploymentResult
- Document
- ExtensionDetails
- ExtensionVersionDetails
- GameConfigurationDetails
- GameDetails
- GameSummary
- GeneratedCodeJobDetails
- Generator
- ImportGameConfigurationSource
- Section
- SectionModification
- SnapshotDetails
- SnapshotSummary
- StageDeploymentDetails
- StageDeploymentSummary
- StageDetails
- StageSummary
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype DeploymentAction where
- DeploymentAction' { }
- pattern DeploymentAction_DEPLOY :: DeploymentAction
- pattern DeploymentAction_UNDEPLOY :: DeploymentAction
- newtype DeploymentState where
- DeploymentState' { }
- pattern DeploymentState_COMPLETED :: DeploymentState
- pattern DeploymentState_FAILED :: DeploymentState
- pattern DeploymentState_IN_PROGRESS :: DeploymentState
- pattern DeploymentState_PENDING :: DeploymentState
- newtype GameState where
- GameState' { }
- pattern GameState_ACTIVE :: GameState
- pattern GameState_DELETING :: GameState
- newtype GeneratedCodeJobState where
- newtype Operation where
- Operation' { }
- pattern Operation_ADD :: Operation
- pattern Operation_REMOVE :: Operation
- pattern Operation_REPLACE :: Operation
- newtype ResultCode where
- ResultCode' { }
- pattern ResultCode_INVALID_ROLE_FAILURE :: ResultCode
- pattern ResultCode_SUCCESS :: ResultCode
- pattern ResultCode_UNSPECIFIED_FAILURE :: ResultCode
- newtype StageState where
- StageState' { }
- pattern StageState_ACTIVE :: StageState
- pattern StageState_DELETING :: StageState
- data Connection = Connection' {}
- newConnection :: Connection
- connection_created :: Lens' Connection (Maybe UTCTime)
- connection_id :: Lens' Connection (Maybe Text)
- data DeploymentResult = DeploymentResult' {}
- newDeploymentResult :: DeploymentResult
- deploymentResult_message :: Lens' DeploymentResult (Maybe Text)
- deploymentResult_resultCode :: Lens' DeploymentResult (Maybe ResultCode)
- data Document = Document' {
- newDocument :: Document
- data ExtensionDetails = ExtensionDetails' {}
- newExtensionDetails :: ExtensionDetails
- extensionDetails_description :: Lens' ExtensionDetails (Maybe Text)
- extensionDetails_name :: Lens' ExtensionDetails (Maybe Text)
- extensionDetails_namespace :: Lens' ExtensionDetails (Maybe Text)
- data ExtensionVersionDetails = ExtensionVersionDetails' {}
- newExtensionVersionDetails :: ExtensionVersionDetails
- extensionVersionDetails_name :: Lens' ExtensionVersionDetails (Maybe Text)
- extensionVersionDetails_namespace :: Lens' ExtensionVersionDetails (Maybe Text)
- extensionVersionDetails_schema :: Lens' ExtensionVersionDetails (Maybe Text)
- extensionVersionDetails_version :: Lens' ExtensionVersionDetails (Maybe Text)
- data GameConfigurationDetails = GameConfigurationDetails' {}
- newGameConfigurationDetails :: GameConfigurationDetails
- gameConfigurationDetails_created :: Lens' GameConfigurationDetails (Maybe UTCTime)
- gameConfigurationDetails_lastUpdated :: Lens' GameConfigurationDetails (Maybe UTCTime)
- gameConfigurationDetails_sections :: Lens' GameConfigurationDetails (Maybe (HashMap Text Section))
- data GameDetails = GameDetails' {}
- newGameDetails :: GameDetails
- gameDetails_arn :: Lens' GameDetails (Maybe Text)
- gameDetails_created :: Lens' GameDetails (Maybe UTCTime)
- gameDetails_description :: Lens' GameDetails (Maybe Text)
- gameDetails_enableTerminationProtection :: Lens' GameDetails (Maybe Bool)
- gameDetails_lastUpdated :: Lens' GameDetails (Maybe UTCTime)
- gameDetails_name :: Lens' GameDetails (Maybe Text)
- gameDetails_state :: Lens' GameDetails (Maybe GameState)
- gameDetails_tags :: Lens' GameDetails (Maybe (HashMap Text Text))
- data GameSummary = GameSummary' {}
- newGameSummary :: GameSummary
- gameSummary_description :: Lens' GameSummary (Maybe Text)
- gameSummary_name :: Lens' GameSummary (Maybe Text)
- gameSummary_state :: Lens' GameSummary (Maybe GameState)
- gameSummary_tags :: Lens' GameSummary (Maybe (HashMap Text Text))
- data GeneratedCodeJobDetails = GeneratedCodeJobDetails' {}
- newGeneratedCodeJobDetails :: GeneratedCodeJobDetails
- generatedCodeJobDetails_description :: Lens' GeneratedCodeJobDetails (Maybe Text)
- generatedCodeJobDetails_expirationTime :: Lens' GeneratedCodeJobDetails (Maybe UTCTime)
- generatedCodeJobDetails_generatedCodeJobId :: Lens' GeneratedCodeJobDetails (Maybe Text)
- generatedCodeJobDetails_s3Url :: Lens' GeneratedCodeJobDetails (Maybe Text)
- generatedCodeJobDetails_status :: Lens' GeneratedCodeJobDetails (Maybe GeneratedCodeJobState)
- data Generator = Generator' {}
- newGenerator :: Generator
- generator_gameSdkVersion :: Lens' Generator (Maybe Text)
- generator_language :: Lens' Generator (Maybe Text)
- generator_targetPlatform :: Lens' Generator (Maybe Text)
- data ImportGameConfigurationSource = ImportGameConfigurationSource' {}
- newImportGameConfigurationSource :: ByteString -> ImportGameConfigurationSource
- importGameConfigurationSource_file :: Lens' ImportGameConfigurationSource ByteString
- data Section = Section' {}
- newSection :: Section
- section_attributes :: Lens' Section (Maybe Document)
- section_name :: Lens' Section (Maybe Text)
- section_size :: Lens' Section (Maybe Natural)
- data SectionModification = SectionModification' {}
- newSectionModification :: Operation -> Text -> Text -> SectionModification
- sectionModification_value :: Lens' SectionModification (Maybe Document)
- sectionModification_operation :: Lens' SectionModification Operation
- sectionModification_path :: Lens' SectionModification Text
- sectionModification_section :: Lens' SectionModification Text
- data SnapshotDetails = SnapshotDetails' {}
- newSnapshotDetails :: SnapshotDetails
- snapshotDetails_created :: Lens' SnapshotDetails (Maybe UTCTime)
- snapshotDetails_description :: Lens' SnapshotDetails (Maybe Text)
- snapshotDetails_id :: Lens' SnapshotDetails (Maybe Text)
- snapshotDetails_lastUpdated :: Lens' SnapshotDetails (Maybe UTCTime)
- snapshotDetails_sections :: Lens' SnapshotDetails (Maybe (HashMap Text Section))
- data SnapshotSummary = SnapshotSummary' {}
- newSnapshotSummary :: SnapshotSummary
- snapshotSummary_created :: Lens' SnapshotSummary (Maybe UTCTime)
- snapshotSummary_description :: Lens' SnapshotSummary (Maybe Text)
- snapshotSummary_id :: Lens' SnapshotSummary (Maybe Text)
- snapshotSummary_lastUpdated :: Lens' SnapshotSummary (Maybe UTCTime)
- data StageDeploymentDetails = StageDeploymentDetails' {}
- newStageDeploymentDetails :: StageDeploymentDetails
- stageDeploymentDetails_created :: Lens' StageDeploymentDetails (Maybe UTCTime)
- stageDeploymentDetails_deploymentAction :: Lens' StageDeploymentDetails (Maybe DeploymentAction)
- stageDeploymentDetails_deploymentId :: Lens' StageDeploymentDetails (Maybe Text)
- stageDeploymentDetails_deploymentResult :: Lens' StageDeploymentDetails (Maybe DeploymentResult)
- stageDeploymentDetails_deploymentState :: Lens' StageDeploymentDetails (Maybe DeploymentState)
- stageDeploymentDetails_lastUpdated :: Lens' StageDeploymentDetails (Maybe UTCTime)
- stageDeploymentDetails_snapshotId :: Lens' StageDeploymentDetails (Maybe Text)
- data StageDeploymentSummary = StageDeploymentSummary' {}
- newStageDeploymentSummary :: StageDeploymentSummary
- stageDeploymentSummary_deploymentAction :: Lens' StageDeploymentSummary (Maybe DeploymentAction)
- stageDeploymentSummary_deploymentId :: Lens' StageDeploymentSummary (Maybe Text)
- stageDeploymentSummary_deploymentResult :: Lens' StageDeploymentSummary (Maybe DeploymentResult)
- stageDeploymentSummary_deploymentState :: Lens' StageDeploymentSummary (Maybe DeploymentState)
- stageDeploymentSummary_lastUpdated :: Lens' StageDeploymentSummary (Maybe UTCTime)
- stageDeploymentSummary_snapshotId :: Lens' StageDeploymentSummary (Maybe Text)
- data StageDetails = StageDetails' {}
- newStageDetails :: StageDetails
- stageDetails_arn :: Lens' StageDetails (Maybe Text)
- stageDetails_created :: Lens' StageDetails (Maybe UTCTime)
- stageDetails_description :: Lens' StageDetails (Maybe Text)
- stageDetails_gameKey :: Lens' StageDetails (Maybe Text)
- stageDetails_lastUpdated :: Lens' StageDetails (Maybe UTCTime)
- stageDetails_logGroup :: Lens' StageDetails (Maybe Text)
- stageDetails_name :: Lens' StageDetails (Maybe Text)
- stageDetails_role :: Lens' StageDetails (Maybe Text)
- stageDetails_state :: Lens' StageDetails (Maybe StageState)
- stageDetails_tags :: Lens' StageDetails (Maybe (HashMap Text Text))
- data StageSummary = StageSummary' {}
- newStageSummary :: StageSummary
- stageSummary_description :: Lens' StageSummary (Maybe Text)
- stageSummary_gameKey :: Lens' StageSummary (Maybe Text)
- stageSummary_name :: Lens' StageSummary (Maybe Text)
- stageSummary_state :: Lens' StageSummary (Maybe StageState)
- stageSummary_tags :: Lens' StageSummary (Maybe (HashMap Text Text))
Service Configuration
defaultService :: Service Source #
API version 2021-08-17 of the Amazon GameSparks SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
The resource already exists, or another operation is in progress.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The service encountered an internal error.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource specified in the request does not exist.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request would result in exceeding service quota.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request throughput limit was exceeded.
_ValidationException :: AsError a => Fold a ServiceError Source #
One of the parameters in the request is invalid.
DeploymentAction
newtype DeploymentAction Source #
Constructors
| DeploymentAction' | |
Fields | |
Bundled Patterns
| pattern DeploymentAction_DEPLOY :: DeploymentAction | |
| pattern DeploymentAction_UNDEPLOY :: DeploymentAction |
Instances
DeploymentState
newtype DeploymentState Source #
Constructors
| DeploymentState' | |
Fields | |
Bundled Patterns
| pattern DeploymentState_COMPLETED :: DeploymentState | |
| pattern DeploymentState_FAILED :: DeploymentState | |
| pattern DeploymentState_IN_PROGRESS :: DeploymentState | |
| pattern DeploymentState_PENDING :: DeploymentState |
Instances
GameState
Constructors
| GameState' | |
Fields | |
Bundled Patterns
| pattern GameState_ACTIVE :: GameState | |
| pattern GameState_DELETING :: GameState |
Instances
GeneratedCodeJobState
newtype GeneratedCodeJobState Source #
Constructors
| GeneratedCodeJobState' | |
Fields | |
Bundled Patterns
Instances
Operation
Constructors
| Operation' | |
Fields | |
Bundled Patterns
| pattern Operation_ADD :: Operation | |
| pattern Operation_REMOVE :: Operation | |
| pattern Operation_REPLACE :: Operation |
Instances
ResultCode
newtype ResultCode Source #
Constructors
| ResultCode' | |
Fields | |
Bundled Patterns
| pattern ResultCode_INVALID_ROLE_FAILURE :: ResultCode | |
| pattern ResultCode_SUCCESS :: ResultCode | |
| pattern ResultCode_UNSPECIFIED_FAILURE :: ResultCode |
Instances
StageState
newtype StageState Source #
Constructors
| StageState' | |
Fields | |
Bundled Patterns
| pattern StageState_ACTIVE :: StageState | |
| pattern StageState_DELETING :: StageState |
Instances
Connection
data Connection Source #
Details about a WebSocket connection.
See: newConnection smart constructor.
Constructors
| Connection' | |
Instances
newConnection :: Connection Source #
Create a value of Connection 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:created:Connection', connection_created - The date and time when the connection was created.
$sel:id:Connection', connection_id - The identifier used to indicate a specific WebSocket 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
data DeploymentResult Source #
The result of the deployment.
See: newDeploymentResult smart constructor.
Constructors
| DeploymentResult' | |
Fields
| |
Instances
newDeploymentResult :: DeploymentResult Source #
Create a value of DeploymentResult 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:message:DeploymentResult', deploymentResult_message - Details about the deployment result.
$sel:resultCode:DeploymentResult', deploymentResult_resultCode - The type of deployment result.
deploymentResult_message :: Lens' DeploymentResult (Maybe Text) Source #
Details about the deployment result.
deploymentResult_resultCode :: Lens' DeploymentResult (Maybe ResultCode) Source #
The type of deployment result.
Document
See: newDocument smart constructor.
Constructors
| Document' | |
Instances
| FromJSON Document Source # | |
| ToJSON Document Source # | |
Defined in Amazonka.GamesParks.Types.Document | |
| Generic Document Source # | |
| Read Document Source # | |
| Show Document Source # | |
| NFData Document Source # | |
Defined in Amazonka.GamesParks.Types.Document | |
| Eq Document Source # | |
| Hashable Document Source # | |
Defined in Amazonka.GamesParks.Types.Document | |
| type Rep Document Source # | |
newDocument :: Document Source #
Create a value of Document with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ExtensionDetails
data ExtensionDetails Source #
Details about the extension.
See: newExtensionDetails smart constructor.
Constructors
| ExtensionDetails' | |
Instances
newExtensionDetails :: ExtensionDetails Source #
Create a value of ExtensionDetails 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:description:ExtensionDetails', extensionDetails_description - The description of the extension.
$sel:name:ExtensionDetails', extensionDetails_name - The name of the extension.
$sel:namespace:ExtensionDetails', extensionDetails_namespace - The namespace (qualifier) of the extension.
extensionDetails_description :: Lens' ExtensionDetails (Maybe Text) Source #
The description of the extension.
extensionDetails_name :: Lens' ExtensionDetails (Maybe Text) Source #
The name of the extension.
extensionDetails_namespace :: Lens' ExtensionDetails (Maybe Text) Source #
The namespace (qualifier) of the extension.
ExtensionVersionDetails
data ExtensionVersionDetails Source #
Details about the extension version.
See: newExtensionVersionDetails smart constructor.
Constructors
| ExtensionVersionDetails' | |
Instances
newExtensionVersionDetails :: ExtensionVersionDetails Source #
Create a value of ExtensionVersionDetails 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:name:ExtensionVersionDetails', extensionVersionDetails_name - The name of the extension.
$sel:namespace:ExtensionVersionDetails', extensionVersionDetails_namespace - The namespace (qualifier) of the extension.
$sel:schema:ExtensionVersionDetails', extensionVersionDetails_schema - The model that defines the interface for this extension version.
$sel:version:ExtensionVersionDetails', extensionVersionDetails_version - The version of the extension.
extensionVersionDetails_name :: Lens' ExtensionVersionDetails (Maybe Text) Source #
The name of the extension.
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.
extensionVersionDetails_version :: Lens' ExtensionVersionDetails (Maybe Text) Source #
The version of the extension.
GameConfigurationDetails
data GameConfigurationDetails Source #
Details about the game configuration.
The game configuration is organized into named sections, where the
schema of each section is defined by an extension. The schema for these
sections can be retrieved using the GetExtensionVersion operation.
See: newGameConfigurationDetails smart constructor.
Constructors
| GameConfigurationDetails' | |
Instances
newGameConfigurationDetails :: GameConfigurationDetails Source #
Create a value of GameConfigurationDetails 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:created:GameConfigurationDetails', gameConfigurationDetails_created - The date when the game was created.
$sel:lastUpdated:GameConfigurationDetails', gameConfigurationDetails_lastUpdated - The date when the game was last modified.
$sel:sections:GameConfigurationDetails', gameConfigurationDetails_sections - Configuration data, organized by section name.
gameConfigurationDetails_created :: Lens' GameConfigurationDetails (Maybe UTCTime) Source #
The date when the game was created.
gameConfigurationDetails_lastUpdated :: Lens' GameConfigurationDetails (Maybe UTCTime) Source #
The date when the game was last modified.
gameConfigurationDetails_sections :: Lens' GameConfigurationDetails (Maybe (HashMap Text Section)) Source #
Configuration data, organized by section name.
GameDetails
data GameDetails Source #
Details about a game.
See: newGameDetails smart constructor.
Constructors
| GameDetails' | |
Fields
| |
Instances
newGameDetails :: GameDetails Source #
Create a value of GameDetails 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:arn:GameDetails', gameDetails_arn - The Amazon Resource Name (ARN) of this game.
$sel:created:GameDetails', gameDetails_created - The date when the game was created.
$sel:description:GameDetails', gameDetails_description - The description of the game.
$sel:enableTerminationProtection:GameDetails', gameDetails_enableTerminationProtection - Determines if the game can be deleted.
$sel:lastUpdated:GameDetails', gameDetails_lastUpdated - The date when the game was last modified.
$sel:name:GameDetails', gameDetails_name - The name of the game.
$sel:state:GameDetails', gameDetails_state - The state of the game.
$sel:tags:GameDetails', gameDetails_tags - The tags associated with the game.
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_state :: Lens' GameDetails (Maybe GameState) Source #
The state of the game.
gameDetails_tags :: Lens' GameDetails (Maybe (HashMap Text Text)) Source #
The tags associated with the game.
GameSummary
data GameSummary Source #
The summary of the properties of a game.
See: newGameSummary smart constructor.
Constructors
| GameSummary' | |
Instances
newGameSummary :: GameSummary Source #
Create a value of GameSummary 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:description:GameSummary', gameSummary_description - The description of the game.
$sel:name:GameSummary', gameSummary_name - The name of the game.
$sel:state:GameSummary', gameSummary_state - The state of the game.
$sel:tags:GameSummary', gameSummary_tags - The tags associated with the game.
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_state :: Lens' GameSummary (Maybe GameState) Source #
The state of the game.
gameSummary_tags :: Lens' GameSummary (Maybe (HashMap Text Text)) Source #
The tags associated with the game.
GeneratedCodeJobDetails
data GeneratedCodeJobDetails Source #
Details about a generated code job.
See: newGeneratedCodeJobDetails smart constructor.
Constructors
| GeneratedCodeJobDetails' | |
Fields
| |
Instances
newGeneratedCodeJobDetails :: GeneratedCodeJobDetails Source #
Create a value of GeneratedCodeJobDetails 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:description:GeneratedCodeJobDetails', generatedCodeJobDetails_description - The description of the generated code job.
$sel:expirationTime:GeneratedCodeJobDetails', generatedCodeJobDetails_expirationTime - The expiration date and time for the download URL.
The download URL us guaranteed to be available until at least this time.
$sel:generatedCodeJobId:GeneratedCodeJobDetails', generatedCodeJobDetails_generatedCodeJobId - The identifier for the generated code job.
$sel:s3Url:GeneratedCodeJobDetails', generatedCodeJobDetails_s3Url - A presigned URL that can be used to download the generated code.
$sel:status:GeneratedCodeJobDetails', generatedCodeJobDetails_status - The status of the generated code job
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_generatedCodeJobId :: Lens' GeneratedCodeJobDetails (Maybe Text) Source #
The identifier for the generated code job.
generatedCodeJobDetails_s3Url :: Lens' GeneratedCodeJobDetails (Maybe Text) Source #
A presigned URL that can be used to download the generated code.
generatedCodeJobDetails_status :: Lens' GeneratedCodeJobDetails (Maybe GeneratedCodeJobState) Source #
The status of the generated code job
Generator
Properties that specify the code generator for a generated code job.
See: newGenerator smart constructor.
Constructors
| Generator' | |
Fields
| |
Instances
| ToJSON Generator Source # | |
Defined in Amazonka.GamesParks.Types.Generator | |
| Generic Generator Source # | |
| Read Generator Source # | |
| Show Generator Source # | |
| NFData Generator Source # | |
Defined in Amazonka.GamesParks.Types.Generator | |
| Eq Generator Source # | |
| Hashable Generator Source # | |
Defined in Amazonka.GamesParks.Types.Generator | |
| type Rep Generator Source # | |
Defined in Amazonka.GamesParks.Types.Generator type Rep Generator = D1 ('MetaData "Generator" "Amazonka.GamesParks.Types.Generator" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "Generator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameSdkVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetPlatform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newGenerator :: Generator Source #
Create a value of Generator 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:gameSdkVersion:Generator', generator_gameSdkVersion - The target version of the GameSparks Game SDK.
$sel:language:Generator', generator_language - 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.
$sel:targetPlatform:Generator', generator_targetPlatform - The platform that will be used to run the generated code.
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
data ImportGameConfigurationSource Source #
The source used to import configuration sections.
See: newImportGameConfigurationSource smart constructor.
Constructors
| ImportGameConfigurationSource' | |
Instances
newImportGameConfigurationSource Source #
Create a value of ImportGameConfigurationSource 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:file:ImportGameConfigurationSource', importGameConfigurationSource_file - 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.
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
The configuration section.
See: newSection smart constructor.
Constructors
| Section' | |
Instances
| FromJSON Section Source # | |
| Generic Section Source # | |
| Read Section Source # | |
| Show Section Source # | |
| NFData Section Source # | |
Defined in Amazonka.GamesParks.Types.Section | |
| Eq Section Source # | |
| Hashable Section Source # | |
Defined in Amazonka.GamesParks.Types.Section | |
| type Rep Section Source # | |
Defined in Amazonka.GamesParks.Types.Section type Rep Section = D1 ('MetaData "Section" "Amazonka.GamesParks.Types.Section" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "Section'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Document)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) | |
newSection :: Section Source #
Create a value of Section 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:attributes:Section', section_attributes - The content of a configuration section.
$sel:name:Section', section_name - The name of the section.
$sel:size:Section', section_size - The size, in bytes, of the section contents.
section_attributes :: Lens' Section (Maybe Document) Source #
The content of a configuration section.
SectionModification
data SectionModification Source #
A single modification to the configuration section.
See: newSectionModification smart constructor.
Constructors
| SectionModification' | |
Fields
| |
Instances
newSectionModification Source #
Arguments
| :: Operation | |
| -> Text | |
| -> Text | |
| -> SectionModification |
Create a value of SectionModification 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:value:SectionModification', sectionModification_value - For add and replace operations, this is the value that will be used.
This field should be omitted for delete operations.
$sel:operation:SectionModification', sectionModification_operation - The operation to be performed on a configuration section.
Content can be added, deleted, or replaced within a section.
$sel:path:SectionModification', sectionModification_path - The path within the section content to be modified.
$sel:section:SectionModification', sectionModification_section - The name of the section to be modified.
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
data SnapshotDetails Source #
Properties that provide details of a snapshot.
See: newSnapshotDetails smart constructor.
Constructors
| SnapshotDetails' | |
Fields
| |
Instances
newSnapshotDetails :: SnapshotDetails Source #
Create a value of SnapshotDetails 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:created:SnapshotDetails', snapshotDetails_created - The timestamp of when the snapshot was created.
$sel:description:SnapshotDetails', snapshotDetails_description - The description of the snapshot.
$sel:id:SnapshotDetails', snapshotDetails_id - The identifier of the snapshot.
$sel:lastUpdated:SnapshotDetails', snapshotDetails_lastUpdated - The timestamp of when the snapshot was last updated.
$sel:sections:SnapshotDetails', snapshotDetails_sections - The sections in the snapshot.
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.
snapshotDetails_sections :: Lens' SnapshotDetails (Maybe (HashMap Text Section)) Source #
The sections in the snapshot.
SnapshotSummary
data SnapshotSummary Source #
The summary of the properties of a snapshot.
See: newSnapshotSummary smart constructor.
Constructors
| SnapshotSummary' | |
Instances
newSnapshotSummary :: SnapshotSummary Source #
Create a value of SnapshotSummary 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:created:SnapshotSummary', snapshotSummary_created - The timestamp of when the snapshot was created.
$sel:description:SnapshotSummary', snapshotSummary_description - The description of the snapshot.
$sel:id:SnapshotSummary', snapshotSummary_id - The identifier of the snapshot.
$sel:lastUpdated:SnapshotSummary', snapshotSummary_lastUpdated - Then timestamp of when the snapshot was last updated.
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
data StageDeploymentDetails Source #
Properties that provide details of a stage deployment.
See: newStageDeploymentDetails smart constructor.
Constructors
| StageDeploymentDetails' | |
Fields
| |
Instances
newStageDeploymentDetails :: StageDeploymentDetails Source #
Create a value of StageDeploymentDetails 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:created:StageDeploymentDetails', stageDeploymentDetails_created - The timestamp of when the stage deployment was created.
$sel:deploymentAction:StageDeploymentDetails', stageDeploymentDetails_deploymentAction - The type of action of the stage deployment.
$sel:deploymentId:StageDeploymentDetails', stageDeploymentDetails_deploymentId - The identifier of the deployment.
$sel:deploymentResult:StageDeploymentDetails', stageDeploymentDetails_deploymentResult - The result of the deployment.
$sel:deploymentState:StageDeploymentDetails', stageDeploymentDetails_deploymentState - The state of the deployment.
$sel:lastUpdated:StageDeploymentDetails', stageDeploymentDetails_lastUpdated - The timestamp of when the deployment was last updated.
$sel:snapshotId:StageDeploymentDetails', stageDeploymentDetails_snapshotId - The identifier of the snapshot associated with the stage deployment.
stageDeploymentDetails_created :: Lens' StageDeploymentDetails (Maybe UTCTime) Source #
The timestamp of when the stage deployment was created.
stageDeploymentDetails_deploymentAction :: Lens' StageDeploymentDetails (Maybe DeploymentAction) Source #
The type of action of the stage deployment.
stageDeploymentDetails_deploymentId :: Lens' StageDeploymentDetails (Maybe Text) Source #
The identifier of the deployment.
stageDeploymentDetails_deploymentResult :: Lens' StageDeploymentDetails (Maybe DeploymentResult) Source #
The result of the deployment.
stageDeploymentDetails_deploymentState :: Lens' StageDeploymentDetails (Maybe DeploymentState) Source #
The state of the deployment.
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
data StageDeploymentSummary Source #
The summary of the properties of a stage deployment.
See: newStageDeploymentSummary smart constructor.
Constructors
| StageDeploymentSummary' | |
Fields
| |
Instances
newStageDeploymentSummary :: StageDeploymentSummary Source #
Create a value of StageDeploymentSummary 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:deploymentAction:StageDeploymentSummary', stageDeploymentSummary_deploymentAction - The type of action of the deployment.
$sel:deploymentId:StageDeploymentSummary', stageDeploymentSummary_deploymentId - The identifier of the deployment.
$sel:deploymentResult:StageDeploymentSummary', stageDeploymentSummary_deploymentResult - The result of the deployment.
$sel:deploymentState:StageDeploymentSummary', stageDeploymentSummary_deploymentState - The state of the deployment.
$sel:lastUpdated:StageDeploymentSummary', stageDeploymentSummary_lastUpdated - The timestamp of when the deployment was last updated.
$sel:snapshotId:StageDeploymentSummary', stageDeploymentSummary_snapshotId - The identifier of the snapshot associated with the stage deployment.
stageDeploymentSummary_deploymentAction :: Lens' StageDeploymentSummary (Maybe DeploymentAction) Source #
The type of action of the deployment.
stageDeploymentSummary_deploymentId :: Lens' StageDeploymentSummary (Maybe Text) Source #
The identifier of the deployment.
stageDeploymentSummary_deploymentResult :: Lens' StageDeploymentSummary (Maybe DeploymentResult) Source #
The result of the deployment.
stageDeploymentSummary_deploymentState :: Lens' StageDeploymentSummary (Maybe DeploymentState) Source #
The state of the deployment.
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
data StageDetails Source #
Properties that provide details of a stage.
See: newStageDetails smart constructor.
Constructors
| StageDetails' | |
Fields
| |
Instances
newStageDetails :: StageDetails Source #
Create a value of StageDetails 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:arn:StageDetails', stageDetails_arn - The Amazon Resource Name (ARN) of the stage.
$sel:created:StageDetails', stageDetails_created - The timestamp of when the stage was created.
$sel:description:StageDetails', stageDetails_description - The description of the stage.
$sel:gameKey:StageDetails', stageDetails_gameKey - 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.
$sel:lastUpdated:StageDetails', stageDetails_lastUpdated - The timestamp of when the stage was last updated.
$sel:logGroup:StageDetails', stageDetails_logGroup - The Amazon CloudWatch log group for game runtimes deployed to the stage.
$sel:name:StageDetails', stageDetails_name - The name of the stage.
$sel:role':StageDetails', stageDetails_role - The Amazon Resource Name (ARN) of the role used to run the game runtimes
deployed to the stage.
$sel:state:StageDetails', stageDetails_state - The state of the stage.
$sel:tags:StageDetails', stageDetails_tags - The tags associated with the stage.
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_name :: Lens' StageDetails (Maybe Text) Source #
The name of 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_state :: Lens' StageDetails (Maybe StageState) Source #
The state of the stage.
stageDetails_tags :: Lens' StageDetails (Maybe (HashMap Text Text)) Source #
The tags associated with the stage.
StageSummary
data StageSummary Source #
The summary of the properties of a stage.
See: newStageSummary smart constructor.
Constructors
| StageSummary' | |
Fields
| |
Instances
newStageSummary :: StageSummary Source #
Create a value of StageSummary 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:description:StageSummary', stageSummary_description - The description of the stage.
$sel:gameKey:StageSummary', stageSummary_gameKey - 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.
$sel:name:StageSummary', stageSummary_name - The name of the stage.
$sel:state:StageSummary', stageSummary_state - The state of the stage.
$sel:tags:StageSummary', stageSummary_tags - The tags associated with the stage.
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_name :: Lens' StageSummary (Maybe Text) Source #
The name of the stage.
stageSummary_state :: Lens' StageSummary (Maybe StageState) Source #
The state of the stage.
stageSummary_tags :: Lens' StageSummary (Maybe (HashMap Text Text)) Source #
The tags associated with the stage.