gamesparks

package module
v1.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 12, 2023 License: Apache-2.0 Imports: 36 Imported by: 2

Documentation

Overview

Package gamesparks provides the API client, operations, and parameter types for GameSparks.

Index

Constants

View Source
const ServiceAPIVersion = "2021-08-17"
View Source
const ServiceID = "GameSparks"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.3.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for GameSparks.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateGame

func (c *Client) CreateGame(ctx context.Context, params *CreateGameInput, optFns ...func(*Options)) (*CreateGameOutput, error)

Creates a new game with an empty configuration. After creating your game, you can update the configuration using UpdateGameConfiguration or ImportGameConfiguration .

func (*Client) CreateSnapshot

func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error)

Creates a snapshot of the game configuration.

func (*Client) CreateStage

func (c *Client) CreateStage(ctx context.Context, params *CreateStageInput, optFns ...func(*Options)) (*CreateStageOutput, error)

Creates a new stage for stage-by-stage game development and deployment.

func (*Client) DeleteGame

func (c *Client) DeleteGame(ctx context.Context, params *DeleteGameInput, optFns ...func(*Options)) (*DeleteGameOutput, error)

Deletes a game.

func (*Client) DeleteStage

func (c *Client) DeleteStage(ctx context.Context, params *DeleteStageInput, optFns ...func(*Options)) (*DeleteStageOutput, error)

Deletes a stage from a game, along with the associated game runtime.

func (*Client) DisconnectPlayer

func (c *Client) DisconnectPlayer(ctx context.Context, params *DisconnectPlayerInput, optFns ...func(*Options)) (*DisconnectPlayerOutput, error)

Disconnects a player from the game runtime. If a player has multiple connections, this operation attempts to close all of them.

func (*Client) ExportSnapshot

func (c *Client) ExportSnapshot(ctx context.Context, params *ExportSnapshotInput, optFns ...func(*Options)) (*ExportSnapshotOutput, error)

Exports a game configuration snapshot.

func (*Client) GetExtension

func (c *Client) GetExtension(ctx context.Context, params *GetExtensionInput, optFns ...func(*Options)) (*GetExtensionOutput, error)

Gets details about a specified extension.

func (*Client) GetExtensionVersion

func (c *Client) GetExtensionVersion(ctx context.Context, params *GetExtensionVersionInput, optFns ...func(*Options)) (*GetExtensionVersionOutput, error)

Gets details about a specified extension version.

func (*Client) GetGame

func (c *Client) GetGame(ctx context.Context, params *GetGameInput, optFns ...func(*Options)) (*GetGameOutput, error)

Gets details about a game.

func (*Client) GetGameConfiguration

func (c *Client) GetGameConfiguration(ctx context.Context, params *GetGameConfigurationInput, optFns ...func(*Options)) (*GetGameConfigurationOutput, error)

Gets the configuration of the game.

func (*Client) GetGeneratedCodeJob

func (c *Client) GetGeneratedCodeJob(ctx context.Context, params *GetGeneratedCodeJobInput, optFns ...func(*Options)) (*GetGeneratedCodeJobOutput, error)

Gets details about a job that is generating code for a snapshot.

func (*Client) GetPlayerConnectionStatus

func (c *Client) GetPlayerConnectionStatus(ctx context.Context, params *GetPlayerConnectionStatusInput, optFns ...func(*Options)) (*GetPlayerConnectionStatusOutput, error)

Gets the status of a player's connection to the game runtime. It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list.

func (*Client) GetSnapshot

func (c *Client) GetSnapshot(ctx context.Context, params *GetSnapshotInput, optFns ...func(*Options)) (*GetSnapshotOutput, error)

Gets a copy of the game configuration in a snapshot.

func (*Client) GetStage

func (c *Client) GetStage(ctx context.Context, params *GetStageInput, optFns ...func(*Options)) (*GetStageOutput, error)

Gets information about a stage.

func (*Client) GetStageDeployment

func (c *Client) GetStageDeployment(ctx context.Context, params *GetStageDeploymentInput, optFns ...func(*Options)) (*GetStageDeploymentOutput, error)

Gets information about a stage deployment.

func (*Client) ImportGameConfiguration

func (c *Client) ImportGameConfiguration(ctx context.Context, params *ImportGameConfigurationInput, optFns ...func(*Options)) (*ImportGameConfigurationOutput, error)

Imports a game configuration. This operation replaces the current configuration of the game with the provided input. This is not a reversible operation. If you want to preserve the previous configuration, use CreateSnapshot to make a new snapshot before importing.

func (*Client) ListExtensionVersions

func (c *Client) ListExtensionVersions(ctx context.Context, params *ListExtensionVersionsInput, optFns ...func(*Options)) (*ListExtensionVersionsOutput, error)

Gets a paginated list of available versions for the extension. Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available.

func (*Client) ListExtensions

func (c *Client) ListExtensions(ctx context.Context, params *ListExtensionsInput, optFns ...func(*Options)) (*ListExtensionsOutput, error)

Gets a paginated list of available extensions. Extensions provide features that games can use from scripts.

func (*Client) ListGames

func (c *Client) ListGames(ctx context.Context, params *ListGamesInput, optFns ...func(*Options)) (*ListGamesOutput, error)

Gets a paginated list of games.

func (*Client) ListGeneratedCodeJobs

func (c *Client) ListGeneratedCodeJobs(ctx context.Context, params *ListGeneratedCodeJobsInput, optFns ...func(*Options)) (*ListGeneratedCodeJobsOutput, error)

Gets a paginated list of code generation jobs for a snapshot.

func (*Client) ListSnapshots

func (c *Client) ListSnapshots(ctx context.Context, params *ListSnapshotsInput, optFns ...func(*Options)) (*ListSnapshotsOutput, error)

Gets a paginated list of snapshot summaries from the game.

func (*Client) ListStageDeployments

func (c *Client) ListStageDeployments(ctx context.Context, params *ListStageDeploymentsInput, optFns ...func(*Options)) (*ListStageDeploymentsOutput, error)

Gets a paginated list of stage deployment summaries from the game.

func (*Client) ListStages

func (c *Client) ListStages(ctx context.Context, params *ListStagesInput, optFns ...func(*Options)) (*ListStagesOutput, error)

Gets a paginated list of stage summaries from the game.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags associated with a GameSparks resource.

func (*Client) StartGeneratedCodeJob

func (c *Client) StartGeneratedCodeJob(ctx context.Context, params *StartGeneratedCodeJobInput, optFns ...func(*Options)) (*StartGeneratedCodeJobOutput, error)

Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL.

func (*Client) StartStageDeployment

func (c *Client) StartStageDeployment(ctx context.Context, params *StartStageDeploymentInput, optFns ...func(*Options)) (*StartStageDeploymentOutput, error)

Deploys a snapshot to the stage and creates a new game runtime. After you call this operation, you can check the deployment status by using GetStageDeployment . If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds tags to a GameSparks resource.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from a GameSparks resource.

func (*Client) UpdateGame

func (c *Client) UpdateGame(ctx context.Context, params *UpdateGameInput, optFns ...func(*Options)) (*UpdateGameOutput, error)

Updates details of the game.

func (*Client) UpdateGameConfiguration

func (c *Client) UpdateGameConfiguration(ctx context.Context, params *UpdateGameConfigurationInput, optFns ...func(*Options)) (*UpdateGameConfigurationOutput, error)

Updates one or more sections of the game configuration.

func (*Client) UpdateSnapshot

func (c *Client) UpdateSnapshot(ctx context.Context, params *UpdateSnapshotInput, optFns ...func(*Options)) (*UpdateSnapshotOutput, error)

Updates the metadata of a GameSparks snapshot.

func (*Client) UpdateStage

func (c *Client) UpdateStage(ctx context.Context, params *UpdateStageInput, optFns ...func(*Options)) (*UpdateStageOutput, error)

Updates the metadata of a stage.

type CreateGameInput

type CreateGameInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

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

	// The description of the game.
	Description *string

	// The list of tags to apply to the game.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateGameOutput

type CreateGameOutput struct {

	// Details about the game that was created.
	Game *types.GameDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSnapshotInput

type CreateSnapshotInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The description of the snapshot.
	Description *string
	// contains filtered or unexported fields
}

type CreateSnapshotOutput

type CreateSnapshotOutput struct {

	// Properties that provide details of the created snapshot.
	Snapshot *types.SnapshotDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateStageInput

type CreateStageInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// 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.
	//
	// This member is required.
	Role *string

	// The name of the stage.
	//
	// This member is required.
	StageName *string

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

	// The description of the stage.
	Description *string

	// The list of tags to apply to the stage.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateStageOutput

type CreateStageOutput struct {

	// Properties that describe the stage.
	Stage *types.StageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGameInput

type DeleteGameInput struct {

	// The name of the game to delete.
	//
	// This member is required.
	GameName *string
	// contains filtered or unexported fields
}

type DeleteGameOutput

type DeleteGameOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteStageInput

type DeleteStageInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The name of the stage to delete.
	//
	// This member is required.
	StageName *string
	// contains filtered or unexported fields
}

type DeleteStageOutput

type DeleteStageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisconnectPlayerInput

type DisconnectPlayerInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The unique identifier representing a player.
	//
	// This member is required.
	PlayerId *string

	// The name of the stage.
	//
	// This member is required.
	StageName *string
	// contains filtered or unexported fields
}

type DisconnectPlayerOutput

type DisconnectPlayerOutput struct {

	// The list of the connection ids that could not be disconnected.
	DisconnectFailures []string

	// The list of the connection ids that were disconnected.
	DisconnectSuccesses []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.3.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.3.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.3.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.3.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.3.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExportSnapshotInput

type ExportSnapshotInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The identifier of the snapshot to export.
	//
	// This member is required.
	SnapshotId *string
	// contains filtered or unexported fields
}

type ExportSnapshotOutput

type ExportSnapshotOutput struct {

	// 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.
	S3Url *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetExtensionInput

type GetExtensionInput struct {

	// The name of the extension.
	//
	// This member is required.
	Name *string

	// The namespace (qualifier) of the extension.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type GetExtensionOutput

type GetExtensionOutput struct {

	// Details about the extension.
	Extension *types.ExtensionDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetExtensionVersionInput

type GetExtensionVersionInput struct {

	// The version of the extension.
	//
	// This member is required.
	ExtensionVersion *string

	// The name of the extension.
	//
	// This member is required.
	Name *string

	// The namespace (qualifier) of the extension.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type GetExtensionVersionOutput

type GetExtensionVersionOutput struct {

	// The version of the extension.
	ExtensionVersion *types.ExtensionVersionDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGameConfigurationInput

type GetGameConfigurationInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The list of sections to return.
	Sections []string
	// contains filtered or unexported fields
}

type GetGameConfigurationOutput

type GetGameConfigurationOutput struct {

	// Details about the game configuration.
	GameConfiguration *types.GameConfigurationDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGameInput

type GetGameInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string
	// contains filtered or unexported fields
}

type GetGameOutput

type GetGameOutput struct {

	// The details of the game.
	Game *types.GameDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGeneratedCodeJobInput

type GetGeneratedCodeJobInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The identifier of the code generation job.
	//
	// This member is required.
	JobId *string

	// The identifier of the snapshot for the code generation job.
	//
	// This member is required.
	SnapshotId *string
	// contains filtered or unexported fields
}

type GetGeneratedCodeJobOutput

type GetGeneratedCodeJobOutput struct {

	// Details about the generated code job.
	GeneratedCodeJob *types.GeneratedCodeJobDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPlayerConnectionStatusInput

type GetPlayerConnectionStatusInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The unique identifier representing a player.
	//
	// This member is required.
	PlayerId *string

	// The name of the stage.
	//
	// This member is required.
	StageName *string
	// contains filtered or unexported fields
}

type GetPlayerConnectionStatusOutput

type GetPlayerConnectionStatusOutput struct {

	// The list of connection ids, one for each connection in use by the player.
	Connections []types.Connection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSnapshotInput

type GetSnapshotInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The identifier of the snapshot.
	//
	// This member is required.
	SnapshotId *string

	// The list of game configuration sections to be described.
	Sections []string
	// contains filtered or unexported fields
}

type GetSnapshotOutput

type GetSnapshotOutput struct {

	// Properties that provide details of the snapshot.
	Snapshot *types.SnapshotDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetStageDeploymentInput

type GetStageDeploymentInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The name of the stage.
	//
	// This member is required.
	StageName *string

	// The identifier of the stage deployment. StartStageDeployment returns the
	// identifier that you use here.
	DeploymentId *string
	// contains filtered or unexported fields
}

type GetStageDeploymentOutput

type GetStageDeploymentOutput struct {

	// Properties that provide details of the stage deployment.
	StageDeployment *types.StageDeploymentDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetStageInput

type GetStageInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The name of the stage.
	//
	// This member is required.
	StageName *string
	// contains filtered or unexported fields
}

type GetStageOutput

type GetStageOutput struct {

	// Properties that provide details of the stage.
	Stage *types.StageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ImportGameConfigurationInput

type ImportGameConfigurationInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The source used to import configuration sections.
	//
	// This member is required.
	ImportSource *types.ImportGameConfigurationSource
	// contains filtered or unexported fields
}

type ImportGameConfigurationOutput

type ImportGameConfigurationOutput struct {

	// Details about the game configuration.
	GameConfiguration *types.GameConfigurationDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListExtensionVersionsAPIClient

type ListExtensionVersionsAPIClient interface {
	ListExtensionVersions(context.Context, *ListExtensionVersionsInput, ...func(*Options)) (*ListExtensionVersionsOutput, error)
}

ListExtensionVersionsAPIClient is a client that implements the ListExtensionVersions operation.

type ListExtensionVersionsInput

type ListExtensionVersionsInput struct {

	// The name of the extension.
	//
	// This member is required.
	Name *string

	// The namespace (qualifier) of the extension.
	//
	// This member is required.
	Namespace *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListExtensionVersionsOutput

type ListExtensionVersionsOutput struct {

	// The list of extension versions.
	ExtensionVersions []types.ExtensionVersionDetails

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListExtensionVersionsPaginator

type ListExtensionVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListExtensionVersionsPaginator is a paginator for ListExtensionVersions

func NewListExtensionVersionsPaginator

NewListExtensionVersionsPaginator returns a new ListExtensionVersionsPaginator

func (*ListExtensionVersionsPaginator) HasMorePages

func (p *ListExtensionVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExtensionVersionsPaginator) NextPage

NextPage retrieves the next ListExtensionVersions page.

type ListExtensionVersionsPaginatorOptions

type ListExtensionVersionsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListExtensionVersionsPaginatorOptions is the paginator options for ListExtensionVersions

type ListExtensionsAPIClient

type ListExtensionsAPIClient interface {
	ListExtensions(context.Context, *ListExtensionsInput, ...func(*Options)) (*ListExtensionsOutput, error)
}

ListExtensionsAPIClient is a client that implements the ListExtensions operation.

type ListExtensionsInput

type ListExtensionsInput struct {

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListExtensionsOutput

type ListExtensionsOutput struct {

	// The list of extensions.
	Extensions []types.ExtensionDetails

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListExtensionsPaginator

type ListExtensionsPaginator struct {
	// contains filtered or unexported fields
}

ListExtensionsPaginator is a paginator for ListExtensions

func NewListExtensionsPaginator

func NewListExtensionsPaginator(client ListExtensionsAPIClient, params *ListExtensionsInput, optFns ...func(*ListExtensionsPaginatorOptions)) *ListExtensionsPaginator

NewListExtensionsPaginator returns a new ListExtensionsPaginator

func (*ListExtensionsPaginator) HasMorePages

func (p *ListExtensionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExtensionsPaginator) NextPage

func (p *ListExtensionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExtensionsOutput, error)

NextPage retrieves the next ListExtensions page.

type ListExtensionsPaginatorOptions

type ListExtensionsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListExtensionsPaginatorOptions is the paginator options for ListExtensions

type ListGamesAPIClient

type ListGamesAPIClient interface {
	ListGames(context.Context, *ListGamesInput, ...func(*Options)) (*ListGamesOutput, error)
}

ListGamesAPIClient is a client that implements the ListGames operation.

type ListGamesInput

type ListGamesInput struct {

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGamesOutput

type ListGamesOutput struct {

	// The list of games.
	Games []types.GameSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGamesPaginator

type ListGamesPaginator struct {
	// contains filtered or unexported fields
}

ListGamesPaginator is a paginator for ListGames

func NewListGamesPaginator

func NewListGamesPaginator(client ListGamesAPIClient, params *ListGamesInput, optFns ...func(*ListGamesPaginatorOptions)) *ListGamesPaginator

NewListGamesPaginator returns a new ListGamesPaginator

func (*ListGamesPaginator) HasMorePages

func (p *ListGamesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGamesPaginator) NextPage

func (p *ListGamesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGamesOutput, error)

NextPage retrieves the next ListGames page.

type ListGamesPaginatorOptions

type ListGamesPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGamesPaginatorOptions is the paginator options for ListGames

type ListGeneratedCodeJobsAPIClient

type ListGeneratedCodeJobsAPIClient interface {
	ListGeneratedCodeJobs(context.Context, *ListGeneratedCodeJobsInput, ...func(*Options)) (*ListGeneratedCodeJobsOutput, error)
}

ListGeneratedCodeJobsAPIClient is a client that implements the ListGeneratedCodeJobs operation.

type ListGeneratedCodeJobsInput

type ListGeneratedCodeJobsInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The identifier of the snapshot.
	//
	// This member is required.
	SnapshotId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGeneratedCodeJobsOutput

type ListGeneratedCodeJobsOutput struct {

	// The list of generated code jobs.
	GeneratedCodeJobs []types.GeneratedCodeJobDetails

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGeneratedCodeJobsPaginator

type ListGeneratedCodeJobsPaginator struct {
	// contains filtered or unexported fields
}

ListGeneratedCodeJobsPaginator is a paginator for ListGeneratedCodeJobs

func NewListGeneratedCodeJobsPaginator

NewListGeneratedCodeJobsPaginator returns a new ListGeneratedCodeJobsPaginator

func (*ListGeneratedCodeJobsPaginator) HasMorePages

func (p *ListGeneratedCodeJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGeneratedCodeJobsPaginator) NextPage

NextPage retrieves the next ListGeneratedCodeJobs page.

type ListGeneratedCodeJobsPaginatorOptions

type ListGeneratedCodeJobsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGeneratedCodeJobsPaginatorOptions is the paginator options for ListGeneratedCodeJobs

type ListSnapshotsAPIClient

type ListSnapshotsAPIClient interface {
	ListSnapshots(context.Context, *ListSnapshotsInput, ...func(*Options)) (*ListSnapshotsOutput, error)
}

ListSnapshotsAPIClient is a client that implements the ListSnapshots operation.

type ListSnapshotsInput

type ListSnapshotsInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSnapshotsOutput

type ListSnapshotsOutput struct {

	// 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.
	NextToken *string

	// A list of snapshot summaries. You can use the returned snapshot IDs in the
	// UpdateSnapshot and GetSnapshot operations.
	Snapshots []types.SnapshotSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSnapshotsPaginator

type ListSnapshotsPaginator struct {
	// contains filtered or unexported fields
}

ListSnapshotsPaginator is a paginator for ListSnapshots

func NewListSnapshotsPaginator

func NewListSnapshotsPaginator(client ListSnapshotsAPIClient, params *ListSnapshotsInput, optFns ...func(*ListSnapshotsPaginatorOptions)) *ListSnapshotsPaginator

NewListSnapshotsPaginator returns a new ListSnapshotsPaginator

func (*ListSnapshotsPaginator) HasMorePages

func (p *ListSnapshotsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSnapshotsPaginator) NextPage

func (p *ListSnapshotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSnapshotsOutput, error)

NextPage retrieves the next ListSnapshots page.

type ListSnapshotsPaginatorOptions

type ListSnapshotsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSnapshotsPaginatorOptions is the paginator options for ListSnapshots

type ListStageDeploymentsAPIClient

type ListStageDeploymentsAPIClient interface {
	ListStageDeployments(context.Context, *ListStageDeploymentsInput, ...func(*Options)) (*ListStageDeploymentsOutput, error)
}

ListStageDeploymentsAPIClient is a client that implements the ListStageDeployments operation.

type ListStageDeploymentsInput

type ListStageDeploymentsInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The name of the stage.
	//
	// This member is required.
	StageName *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStageDeploymentsOutput

type ListStageDeploymentsOutput struct {

	// 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.
	NextToken *string

	// A list of stage deployment summaries. You can use the deployment IDs in the
	// UpdateStageDeployment and GetStageDeployment actions.
	StageDeployments []types.StageDeploymentSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStageDeploymentsPaginator

type ListStageDeploymentsPaginator struct {
	// contains filtered or unexported fields
}

ListStageDeploymentsPaginator is a paginator for ListStageDeployments

func NewListStageDeploymentsPaginator

NewListStageDeploymentsPaginator returns a new ListStageDeploymentsPaginator

func (*ListStageDeploymentsPaginator) HasMorePages

func (p *ListStageDeploymentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStageDeploymentsPaginator) NextPage

NextPage retrieves the next ListStageDeployments page.

type ListStageDeploymentsPaginatorOptions

type ListStageDeploymentsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStageDeploymentsPaginatorOptions is the paginator options for ListStageDeployments

type ListStagesAPIClient

type ListStagesAPIClient interface {
	ListStages(context.Context, *ListStagesInput, ...func(*Options)) (*ListStagesOutput, error)
}

ListStagesAPIClient is a client that implements the ListStages operation.

type ListStagesInput

type ListStagesInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStagesOutput

type ListStagesOutput struct {

	// 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.
	NextToken *string

	// A list of stage summaries. You can use the stage names in the UpdateStage and
	// GetStage actions.
	Stages []types.StageSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStagesPaginator

type ListStagesPaginator struct {
	// contains filtered or unexported fields
}

ListStagesPaginator is a paginator for ListStages

func NewListStagesPaginator

func NewListStagesPaginator(client ListStagesAPIClient, params *ListStagesInput, optFns ...func(*ListStagesPaginatorOptions)) *ListStagesPaginator

NewListStagesPaginator returns a new ListStagesPaginator

func (*ListStagesPaginator) HasMorePages

func (p *ListStagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStagesPaginator) NextPage

func (p *ListStagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStagesOutput, error)

NextPage retrieves the next ListStages page.

type ListStagesPaginatorOptions

type ListStagesPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStagesPaginatorOptions is the paginator options for ListStages

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the GameSparks resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tags associated with the resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service. This should be used over
	// the deprecated EndpointResolver
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type StartGeneratedCodeJobInput

type StartGeneratedCodeJobInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// Properties of the generator to use for the job.
	//
	// This member is required.
	Generator *types.Generator

	// The identifier of the snapshot for which to generate code.
	//
	// This member is required.
	SnapshotId *string
	// contains filtered or unexported fields
}

type StartGeneratedCodeJobOutput

type StartGeneratedCodeJobOutput struct {

	// The identifier of the code generation job. You can use this identifier in the
	// GetGeneratedCodeJob operation.
	GeneratedCodeJobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartStageDeploymentInput

type StartStageDeploymentInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The identifier of the snapshot to deploy.
	//
	// This member is required.
	SnapshotId *string

	// The name of the stage to deploy the snapshot onto.
	//
	// This member is required.
	StageName *string

	// A client-defined token. With an active client token in the request, this action
	// is idempotent.
	ClientToken *string
	// contains filtered or unexported fields
}

type StartStageDeploymentOutput

type StartStageDeploymentOutput struct {

	// Properties that describe the stage deployment.
	StageDeployment *types.StageDeploymentDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to add the tags to.
	//
	// This member is required.
	ResourceArn *string

	// The tags to add to the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to remove the tags from.
	//
	// This member is required.
	ResourceArn *string

	// The keys of the tags to remove.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGameConfigurationInput

type UpdateGameConfigurationInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The list of modifications to make.
	//
	// This member is required.
	Modifications []types.SectionModification
	// contains filtered or unexported fields
}

type UpdateGameConfigurationOutput

type UpdateGameConfigurationOutput struct {

	// Details about the game configuration.
	GameConfiguration *types.GameConfigurationDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGameInput

type UpdateGameInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The description of the game.
	Description *string
	// contains filtered or unexported fields
}

type UpdateGameOutput

type UpdateGameOutput struct {

	// The details of the game.
	Game *types.GameDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSnapshotInput

type UpdateSnapshotInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The identifier of the snapshot.
	//
	// This member is required.
	SnapshotId *string

	// The description of the snapshot.
	Description *string
	// contains filtered or unexported fields
}

type UpdateSnapshotOutput

type UpdateSnapshotOutput struct {

	// Properties that provide details of the updated snapshot.
	Snapshot *types.SnapshotDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateStageInput

type UpdateStageInput struct {

	// The name of the game.
	//
	// This member is required.
	GameName *string

	// The name of the stage.
	//
	// This member is required.
	StageName *string

	// The description of the stage.
	Description *string

	// The Amazon Resource Name (ARN) of the role to use for the game snapshots
	// deployed to this stage.
	Role *string
	// contains filtered or unexported fields
}

type UpdateStageOutput

type UpdateStageOutput struct {

	// Properties that provide details of the updated stage.
	Stage *types.StageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Directories

Path Synopsis
Package document implements encoding and decoding of open-content that has a JSON-like data model.
Package document implements encoding and decoding of open-content that has a JSON-like data model.
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL