gamelift

package
v1.5.10 Latest Latest
Warning

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

Go to latest
Published: Nov 22, 2016 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package gamelift provides a client for Amazon GameLift.

Index

Examples

Constants

View Source
const (
	// BuildStatusInitialized is a BuildStatus enum value
	BuildStatusInitialized = "INITIALIZED"

	// BuildStatusReady is a BuildStatus enum value
	BuildStatusReady = "READY"

	// BuildStatusFailed is a BuildStatus enum value
	BuildStatusFailed = "FAILED"
)
View Source
const (
	// ComparisonOperatorTypeGreaterThanOrEqualToThreshold is a ComparisonOperatorType enum value
	ComparisonOperatorTypeGreaterThanOrEqualToThreshold = "GreaterThanOrEqualToThreshold"

	// ComparisonOperatorTypeGreaterThanThreshold is a ComparisonOperatorType enum value
	ComparisonOperatorTypeGreaterThanThreshold = "GreaterThanThreshold"

	// ComparisonOperatorTypeLessThanThreshold is a ComparisonOperatorType enum value
	ComparisonOperatorTypeLessThanThreshold = "LessThanThreshold"

	// ComparisonOperatorTypeLessThanOrEqualToThreshold is a ComparisonOperatorType enum value
	ComparisonOperatorTypeLessThanOrEqualToThreshold = "LessThanOrEqualToThreshold"
)
View Source
const (
	// EC2InstanceTypeT2Micro is a EC2InstanceType enum value
	EC2InstanceTypeT2Micro = "t2.micro"

	// EC2InstanceTypeT2Small is a EC2InstanceType enum value
	EC2InstanceTypeT2Small = "t2.small"

	// EC2InstanceTypeT2Medium is a EC2InstanceType enum value
	EC2InstanceTypeT2Medium = "t2.medium"

	// EC2InstanceTypeT2Large is a EC2InstanceType enum value
	EC2InstanceTypeT2Large = "t2.large"

	// EC2InstanceTypeC3Large is a EC2InstanceType enum value
	EC2InstanceTypeC3Large = "c3.large"

	// EC2InstanceTypeC3Xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC3Xlarge = "c3.xlarge"

	// EC2InstanceTypeC32xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC32xlarge = "c3.2xlarge"

	// EC2InstanceTypeC34xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC34xlarge = "c3.4xlarge"

	// EC2InstanceTypeC38xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC38xlarge = "c3.8xlarge"

	// EC2InstanceTypeC4Large is a EC2InstanceType enum value
	EC2InstanceTypeC4Large = "c4.large"

	// EC2InstanceTypeC4Xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC4Xlarge = "c4.xlarge"

	// EC2InstanceTypeC42xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC42xlarge = "c4.2xlarge"

	// EC2InstanceTypeC44xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC44xlarge = "c4.4xlarge"

	// EC2InstanceTypeC48xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC48xlarge = "c4.8xlarge"

	// EC2InstanceTypeR3Large is a EC2InstanceType enum value
	EC2InstanceTypeR3Large = "r3.large"

	// EC2InstanceTypeR3Xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR3Xlarge = "r3.xlarge"

	// EC2InstanceTypeR32xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR32xlarge = "r3.2xlarge"

	// EC2InstanceTypeR34xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR34xlarge = "r3.4xlarge"

	// EC2InstanceTypeR38xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR38xlarge = "r3.8xlarge"

	// EC2InstanceTypeM3Medium is a EC2InstanceType enum value
	EC2InstanceTypeM3Medium = "m3.medium"

	// EC2InstanceTypeM3Large is a EC2InstanceType enum value
	EC2InstanceTypeM3Large = "m3.large"

	// EC2InstanceTypeM3Xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM3Xlarge = "m3.xlarge"

	// EC2InstanceTypeM32xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM32xlarge = "m3.2xlarge"

	// EC2InstanceTypeM4Large is a EC2InstanceType enum value
	EC2InstanceTypeM4Large = "m4.large"

	// EC2InstanceTypeM4Xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM4Xlarge = "m4.xlarge"

	// EC2InstanceTypeM42xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM42xlarge = "m4.2xlarge"

	// EC2InstanceTypeM44xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM44xlarge = "m4.4xlarge"

	// EC2InstanceTypeM410xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM410xlarge = "m4.10xlarge"
)
View Source
const (
	// EventCodeGenericEvent is a EventCode enum value
	EventCodeGenericEvent = "GENERIC_EVENT"

	// EventCodeFleetCreated is a EventCode enum value
	EventCodeFleetCreated = "FLEET_CREATED"

	// EventCodeFleetDeleted is a EventCode enum value
	EventCodeFleetDeleted = "FLEET_DELETED"

	// EventCodeFleetScalingEvent is a EventCode enum value
	EventCodeFleetScalingEvent = "FLEET_SCALING_EVENT"

	// EventCodeFleetStateDownloading is a EventCode enum value
	EventCodeFleetStateDownloading = "FLEET_STATE_DOWNLOADING"

	// EventCodeFleetStateValidating is a EventCode enum value
	EventCodeFleetStateValidating = "FLEET_STATE_VALIDATING"

	// EventCodeFleetStateBuilding is a EventCode enum value
	EventCodeFleetStateBuilding = "FLEET_STATE_BUILDING"

	// EventCodeFleetStateActivating is a EventCode enum value
	EventCodeFleetStateActivating = "FLEET_STATE_ACTIVATING"

	// EventCodeFleetStateActive is a EventCode enum value
	EventCodeFleetStateActive = "FLEET_STATE_ACTIVE"

	// EventCodeFleetStateError is a EventCode enum value
	EventCodeFleetStateError = "FLEET_STATE_ERROR"

	// EventCodeFleetInitializationFailed is a EventCode enum value
	EventCodeFleetInitializationFailed = "FLEET_INITIALIZATION_FAILED"

	// EventCodeFleetBinaryDownloadFailed is a EventCode enum value
	EventCodeFleetBinaryDownloadFailed = "FLEET_BINARY_DOWNLOAD_FAILED"

	// EventCodeFleetValidationLaunchPathNotFound is a EventCode enum value
	EventCodeFleetValidationLaunchPathNotFound = "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND"

	// EventCodeFleetValidationExecutableRuntimeFailure is a EventCode enum value
	EventCodeFleetValidationExecutableRuntimeFailure = "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE"

	// EventCodeFleetValidationTimedOut is a EventCode enum value
	EventCodeFleetValidationTimedOut = "FLEET_VALIDATION_TIMED_OUT"

	// EventCodeFleetActivationFailed is a EventCode enum value
	EventCodeFleetActivationFailed = "FLEET_ACTIVATION_FAILED"

	// EventCodeFleetActivationFailedNoInstances is a EventCode enum value
	EventCodeFleetActivationFailedNoInstances = "FLEET_ACTIVATION_FAILED_NO_INSTANCES"

	// EventCodeFleetNewGameSessionProtectionPolicyUpdated is a EventCode enum value
	EventCodeFleetNewGameSessionProtectionPolicyUpdated = "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED"

	// EventCodeServerProcessInvalidPath is a EventCode enum value
	EventCodeServerProcessInvalidPath = "SERVER_PROCESS_INVALID_PATH"

	// EventCodeServerProcessSdkInitializationTimeout is a EventCode enum value
	EventCodeServerProcessSdkInitializationTimeout = "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT"

	// EventCodeServerProcessProcessReadyTimeout is a EventCode enum value
	EventCodeServerProcessProcessReadyTimeout = "SERVER_PROCESS_PROCESS_READY_TIMEOUT"

	// EventCodeServerProcessCrashed is a EventCode enum value
	EventCodeServerProcessCrashed = "SERVER_PROCESS_CRASHED"

	// EventCodeServerProcessTerminatedUnhealthy is a EventCode enum value
	EventCodeServerProcessTerminatedUnhealthy = "SERVER_PROCESS_TERMINATED_UNHEALTHY"

	// EventCodeServerProcessForceTerminated is a EventCode enum value
	EventCodeServerProcessForceTerminated = "SERVER_PROCESS_FORCE_TERMINATED"

	// EventCodeServerProcessProcessExitTimeout is a EventCode enum value
	EventCodeServerProcessProcessExitTimeout = "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT"
)
View Source
const (
	// FleetStatusNew is a FleetStatus enum value
	FleetStatusNew = "NEW"

	// FleetStatusDownloading is a FleetStatus enum value
	FleetStatusDownloading = "DOWNLOADING"

	// FleetStatusValidating is a FleetStatus enum value
	FleetStatusValidating = "VALIDATING"

	// FleetStatusBuilding is a FleetStatus enum value
	FleetStatusBuilding = "BUILDING"

	// FleetStatusActivating is a FleetStatus enum value
	FleetStatusActivating = "ACTIVATING"

	// FleetStatusActive is a FleetStatus enum value
	FleetStatusActive = "ACTIVE"

	// FleetStatusDeleting is a FleetStatus enum value
	FleetStatusDeleting = "DELETING"

	// FleetStatusError is a FleetStatus enum value
	FleetStatusError = "ERROR"

	// FleetStatusTerminated is a FleetStatus enum value
	FleetStatusTerminated = "TERMINATED"
)
View Source
const (
	// GameSessionStatusActive is a GameSessionStatus enum value
	GameSessionStatusActive = "ACTIVE"

	// GameSessionStatusActivating is a GameSessionStatus enum value
	GameSessionStatusActivating = "ACTIVATING"

	// GameSessionStatusTerminated is a GameSessionStatus enum value
	GameSessionStatusTerminated = "TERMINATED"

	// GameSessionStatusTerminating is a GameSessionStatus enum value
	GameSessionStatusTerminating = "TERMINATING"

	// GameSessionStatusError is a GameSessionStatus enum value
	GameSessionStatusError = "ERROR"
)
View Source
const (
	// InstanceStatusPending is a InstanceStatus enum value
	InstanceStatusPending = "PENDING"

	// InstanceStatusActive is a InstanceStatus enum value
	InstanceStatusActive = "ACTIVE"

	// InstanceStatusTerminating is a InstanceStatus enum value
	InstanceStatusTerminating = "TERMINATING"
)
View Source
const (
	// IpProtocolTcp is a IpProtocol enum value
	IpProtocolTcp = "TCP"

	// IpProtocolUdp is a IpProtocol enum value
	IpProtocolUdp = "UDP"
)
View Source
const (
	// MetricNameActivatingGameSessions is a MetricName enum value
	MetricNameActivatingGameSessions = "ActivatingGameSessions"

	// MetricNameActiveGameSessions is a MetricName enum value
	MetricNameActiveGameSessions = "ActiveGameSessions"

	// MetricNameActiveInstances is a MetricName enum value
	MetricNameActiveInstances = "ActiveInstances"

	// MetricNameAvailablePlayerSessions is a MetricName enum value
	MetricNameAvailablePlayerSessions = "AvailablePlayerSessions"

	// MetricNameCurrentPlayerSessions is a MetricName enum value
	MetricNameCurrentPlayerSessions = "CurrentPlayerSessions"

	// MetricNameIdleInstances is a MetricName enum value
	MetricNameIdleInstances = "IdleInstances"
)
View Source
const (
	// OperatingSystemWindows2012 is a OperatingSystem enum value
	OperatingSystemWindows2012 = "WINDOWS_2012"

	// OperatingSystemAmazonLinux is a OperatingSystem enum value
	OperatingSystemAmazonLinux = "AMAZON_LINUX"
)
View Source
const (
	// PlayerSessionCreationPolicyAcceptAll is a PlayerSessionCreationPolicy enum value
	PlayerSessionCreationPolicyAcceptAll = "ACCEPT_ALL"

	// PlayerSessionCreationPolicyDenyAll is a PlayerSessionCreationPolicy enum value
	PlayerSessionCreationPolicyDenyAll = "DENY_ALL"
)
View Source
const (
	// PlayerSessionStatusReserved is a PlayerSessionStatus enum value
	PlayerSessionStatusReserved = "RESERVED"

	// PlayerSessionStatusActive is a PlayerSessionStatus enum value
	PlayerSessionStatusActive = "ACTIVE"

	// PlayerSessionStatusCompleted is a PlayerSessionStatus enum value
	PlayerSessionStatusCompleted = "COMPLETED"

	// PlayerSessionStatusTimedout is a PlayerSessionStatus enum value
	PlayerSessionStatusTimedout = "TIMEDOUT"
)
View Source
const (
	// ProtectionPolicyNoProtection is a ProtectionPolicy enum value
	ProtectionPolicyNoProtection = "NoProtection"

	// ProtectionPolicyFullProtection is a ProtectionPolicy enum value
	ProtectionPolicyFullProtection = "FullProtection"
)
View Source
const (
	// RoutingStrategyTypeSimple is a RoutingStrategyType enum value
	RoutingStrategyTypeSimple = "SIMPLE"

	// RoutingStrategyTypeTerminal is a RoutingStrategyType enum value
	RoutingStrategyTypeTerminal = "TERMINAL"
)
View Source
const (
	// ScalingAdjustmentTypeChangeInCapacity is a ScalingAdjustmentType enum value
	ScalingAdjustmentTypeChangeInCapacity = "ChangeInCapacity"

	// ScalingAdjustmentTypeExactCapacity is a ScalingAdjustmentType enum value
	ScalingAdjustmentTypeExactCapacity = "ExactCapacity"

	// ScalingAdjustmentTypePercentChangeInCapacity is a ScalingAdjustmentType enum value
	ScalingAdjustmentTypePercentChangeInCapacity = "PercentChangeInCapacity"
)
View Source
const (
	// ScalingStatusTypeActive is a ScalingStatusType enum value
	ScalingStatusTypeActive = "ACTIVE"

	// ScalingStatusTypeUpdateRequested is a ScalingStatusType enum value
	ScalingStatusTypeUpdateRequested = "UPDATE_REQUESTED"

	// ScalingStatusTypeUpdating is a ScalingStatusType enum value
	ScalingStatusTypeUpdating = "UPDATING"

	// ScalingStatusTypeDeleteRequested is a ScalingStatusType enum value
	ScalingStatusTypeDeleteRequested = "DELETE_REQUESTED"

	// ScalingStatusTypeDeleting is a ScalingStatusType enum value
	ScalingStatusTypeDeleting = "DELETING"

	// ScalingStatusTypeDeleted is a ScalingStatusType enum value
	ScalingStatusTypeDeleted = "DELETED"

	// ScalingStatusTypeError is a ScalingStatusType enum value
	ScalingStatusTypeError = "ERROR"
)
View Source
const ServiceName = "gamelift"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type Alias

type Alias struct {

	// Unique identifier for a fleet alias.
	AliasId *string `type:"string"`

	// Time stamp indicating when this data object was created. Format is a number
	// expressed in Unix time as milliseconds (ex: "1469498468.057").
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Human-readable description of an alias.
	Description *string `type:"string"`

	// Time stamp indicating when this data object was last modified. Format is
	// a number expressed in Unix time as milliseconds (ex: "1469498468.057").
	LastUpdatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Descriptive label associated with an alias. Alias names do not need to be
	// unique.
	Name *string `min:"1" type:"string"`

	// Routing configuration for a fleet alias.
	RoutingStrategy *RoutingStrategy `type:"structure"`
	// contains filtered or unexported fields
}

Properties describing a fleet alias.

func (Alias) GoString

func (s Alias) GoString() string

GoString returns the string representation

func (*Alias) SetAliasId added in v1.5.0

func (s *Alias) SetAliasId(v string) *Alias

SetAliasId sets the AliasId field's value.

func (*Alias) SetCreationTime added in v1.5.0

func (s *Alias) SetCreationTime(v time.Time) *Alias

SetCreationTime sets the CreationTime field's value.

func (*Alias) SetDescription added in v1.5.0

func (s *Alias) SetDescription(v string) *Alias

SetDescription sets the Description field's value.

func (*Alias) SetLastUpdatedTime added in v1.5.0

func (s *Alias) SetLastUpdatedTime(v time.Time) *Alias

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*Alias) SetName added in v1.5.0

func (s *Alias) SetName(v string) *Alias

SetName sets the Name field's value.

func (*Alias) SetRoutingStrategy added in v1.5.0

func (s *Alias) SetRoutingStrategy(v *RoutingStrategy) *Alias

SetRoutingStrategy sets the RoutingStrategy field's value.

func (Alias) String

func (s Alias) String() string

String returns the string representation

type AwsCredentials

type AwsCredentials struct {

	// Access key for an AWS account.
	AccessKeyId *string `min:"1" type:"string"`

	// Secret key for an AWS account.
	SecretAccessKey *string `min:"1" type:"string"`

	// Token specific to a build ID.
	SessionToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

AWS access credentials required to upload game build files to Amazon GameLift. These credentials are generated with CreateBuild, and are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.

func (AwsCredentials) GoString

func (s AwsCredentials) GoString() string

GoString returns the string representation

func (*AwsCredentials) SetAccessKeyId added in v1.5.0

func (s *AwsCredentials) SetAccessKeyId(v string) *AwsCredentials

SetAccessKeyId sets the AccessKeyId field's value.

func (*AwsCredentials) SetSecretAccessKey added in v1.5.0

func (s *AwsCredentials) SetSecretAccessKey(v string) *AwsCredentials

SetSecretAccessKey sets the SecretAccessKey field's value.

func (*AwsCredentials) SetSessionToken added in v1.5.0

func (s *AwsCredentials) SetSessionToken(v string) *AwsCredentials

SetSessionToken sets the SessionToken field's value.

func (AwsCredentials) String

func (s AwsCredentials) String() string

String returns the string representation

type Build

type Build struct {

	// Unique identifier for a build.
	BuildId *string `type:"string"`

	// Time stamp indicating when this data object was created. Format is a number
	// expressed in Unix time as milliseconds (ex: "1469498468.057").
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Descriptive label associated with a build. Build names do not need to be
	// unique. It can be set using CreateBuild or UpdateBuild.
	Name *string `type:"string"`

	// Operating system that the game server binaries are built to run on. This
	// value determines the type of fleet resources that you can use for this build.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// File size of the uploaded game build, expressed in bytes. When the build
	// status is INITIALIZED, this value is 0.
	SizeOnDisk *int64 `min:"1" type:"long"`

	// Current status of the build.
	//
	// Possible build statuses include the following:
	//
	//    * INITIALIZED – A new build has been defined, but no files have been uploaded.
	//    You cannot create fleets for builds that are in this status. When a build
	//    is successfully created, the build status is set to this value.
	//
	//    * READY – The game build has been successfully uploaded. You can now create
	//    new fleets for this build.
	//
	//    * FAILED – The game build upload failed. You cannot create new fleets
	//    for this build.
	Status *string `type:"string" enum:"BuildStatus"`

	// Version associated with this build. Version strings do not need to be unique
	// to a build. This value can be set using CreateBuild or UpdateBuild.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Properties describing a game build.

func (Build) GoString

func (s Build) GoString() string

GoString returns the string representation

func (*Build) SetBuildId added in v1.5.0

func (s *Build) SetBuildId(v string) *Build

SetBuildId sets the BuildId field's value.

func (*Build) SetCreationTime added in v1.5.0

func (s *Build) SetCreationTime(v time.Time) *Build

SetCreationTime sets the CreationTime field's value.

func (*Build) SetName added in v1.5.0

func (s *Build) SetName(v string) *Build

SetName sets the Name field's value.

func (*Build) SetOperatingSystem added in v1.5.0

func (s *Build) SetOperatingSystem(v string) *Build

SetOperatingSystem sets the OperatingSystem field's value.

func (*Build) SetSizeOnDisk added in v1.5.0

func (s *Build) SetSizeOnDisk(v int64) *Build

SetSizeOnDisk sets the SizeOnDisk field's value.

func (*Build) SetStatus added in v1.5.0

func (s *Build) SetStatus(v string) *Build

SetStatus sets the Status field's value.

func (*Build) SetVersion added in v1.5.0

func (s *Build) SetVersion(v string) *Build

SetVersion sets the Version field's value.

func (Build) String

func (s Build) String() string

String returns the string representation

type CreateAliasInput

type CreateAliasInput struct {

	// Human-readable description of an alias.
	Description *string `min:"1" type:"string"`

	// Descriptive label associated with an alias. Alias names do not need to be
	// unique.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Object specifying the fleet and routing type to use for the alias.
	//
	// RoutingStrategy is a required field
	RoutingStrategy *RoutingStrategy `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (CreateAliasInput) GoString

func (s CreateAliasInput) GoString() string

GoString returns the string representation

func (*CreateAliasInput) SetDescription added in v1.5.0

func (s *CreateAliasInput) SetDescription(v string) *CreateAliasInput

SetDescription sets the Description field's value.

func (*CreateAliasInput) SetName added in v1.5.0

func (s *CreateAliasInput) SetName(v string) *CreateAliasInput

SetName sets the Name field's value.

func (*CreateAliasInput) SetRoutingStrategy added in v1.5.0

func (s *CreateAliasInput) SetRoutingStrategy(v *RoutingStrategy) *CreateAliasInput

SetRoutingStrategy sets the RoutingStrategy field's value.

func (CreateAliasInput) String

func (s CreateAliasInput) String() string

String returns the string representation

func (*CreateAliasInput) Validate added in v1.1.21

func (s *CreateAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAliasOutput

type CreateAliasOutput struct {

	// Object containing the newly created alias record.
	Alias *Alias `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (CreateAliasOutput) GoString

func (s CreateAliasOutput) GoString() string

GoString returns the string representation

func (*CreateAliasOutput) SetAlias added in v1.5.0

func (s *CreateAliasOutput) SetAlias(v *Alias) *CreateAliasOutput

SetAlias sets the Alias field's value.

func (CreateAliasOutput) String

func (s CreateAliasOutput) String() string

String returns the string representation

type CreateBuildInput

type CreateBuildInput struct {

	// Descriptive label associated with a build. Build names do not need to be
	// unique. A build name can be changed later usingUpdateBuild.
	Name *string `min:"1" type:"string"`

	// Operating system that the game server binaries are built to run on. This
	// value determines the type of fleet resources that you can use for this build.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// Location in Amazon Simple Storage Service (Amazon S3) where a build's files
	// are stored. This location is assigned in response to a CreateBuild call,
	// and is always in the same region as the service used to create the build.
	// For more details see the Amazon S3 documentation (http://aws.amazon.com/documentation/s3/).
	StorageLocation *S3Location `type:"structure"`

	// Version associated with this build. Version strings do not need to be unique
	// to a build. A build version can be changed later usingUpdateBuild.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (CreateBuildInput) GoString

func (s CreateBuildInput) GoString() string

GoString returns the string representation

func (*CreateBuildInput) SetName added in v1.5.0

func (s *CreateBuildInput) SetName(v string) *CreateBuildInput

SetName sets the Name field's value.

func (*CreateBuildInput) SetOperatingSystem added in v1.5.0

func (s *CreateBuildInput) SetOperatingSystem(v string) *CreateBuildInput

SetOperatingSystem sets the OperatingSystem field's value.

func (*CreateBuildInput) SetStorageLocation added in v1.5.0

func (s *CreateBuildInput) SetStorageLocation(v *S3Location) *CreateBuildInput

SetStorageLocation sets the StorageLocation field's value.

func (*CreateBuildInput) SetVersion added in v1.5.0

func (s *CreateBuildInput) SetVersion(v string) *CreateBuildInput

SetVersion sets the Version field's value.

func (CreateBuildInput) String

func (s CreateBuildInput) String() string

String returns the string representation

func (*CreateBuildInput) Validate added in v1.1.21

func (s *CreateBuildInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBuildOutput

type CreateBuildOutput struct {

	// Set of properties for the newly created build.
	Build *Build `type:"structure"`

	// Amazon S3 path and key, identifying where the game build files are stored.
	StorageLocation *S3Location `type:"structure"`

	// AWS credentials required when uploading a game build to the storage location.
	// These credentials have a limited lifespan and are valid only for the build
	// they were issued for. If you need to get fresh credentials, callRequestUploadCredentials.
	UploadCredentials *AwsCredentials `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (CreateBuildOutput) GoString

func (s CreateBuildOutput) GoString() string

GoString returns the string representation

func (*CreateBuildOutput) SetBuild added in v1.5.0

func (s *CreateBuildOutput) SetBuild(v *Build) *CreateBuildOutput

SetBuild sets the Build field's value.

func (*CreateBuildOutput) SetStorageLocation added in v1.5.0

func (s *CreateBuildOutput) SetStorageLocation(v *S3Location) *CreateBuildOutput

SetStorageLocation sets the StorageLocation field's value.

func (*CreateBuildOutput) SetUploadCredentials added in v1.5.0

func (s *CreateBuildOutput) SetUploadCredentials(v *AwsCredentials) *CreateBuildOutput

SetUploadCredentials sets the UploadCredentials field's value.

func (CreateBuildOutput) String

func (s CreateBuildOutput) String() string

String returns the string representation

type CreateFleetInput

type CreateFleetInput struct {

	// Unique identifier of the build to be deployed on the new fleet. The build
	// must have been successfully uploaded to GameLift and be in a READY status.
	// This fleet setting cannot be changed once the fleet is created.
	//
	// BuildId is a required field
	BuildId *string `type:"string" required:"true"`

	// Human-readable description of a fleet.
	Description *string `min:"1" type:"string"`

	// Range of IP addresses and port settings that permit inbound traffic to access
	// server processes running on the fleet. If no inbound permissions are set,
	// including both IP address range and port range, the server processes in the
	// fleet cannot accept connections. You can specify one or more sets of permissions
	// for a fleet.
	EC2InboundPermissions []*IpPermission `type:"list"`

	// Name of an EC2 instance type that is supported in Amazon GameLift. A fleet
	// instance type determines the computing resources of each instance in the
	// fleet, including CPU, memory, storage, and networking capacity. GameLift
	// supports the following EC2 instance types. See Amazon EC2 Instance Types
	// (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions.
	//
	// EC2InstanceType is a required field
	EC2InstanceType *string `type:"string" required:"true" enum:"EC2InstanceType"`

	// Location of default log files. When a server process is shut down, Amazon
	// GameLift captures and stores any log files in this location. These logs are
	// in addition to game session logs; see more on game session logs in the Amazon
	// GameLift Developer Guide (http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-api-server-code).
	// If no default log path for a fleet is specified, GameLift will automatically
	// upload logs stored on each instance at C:\game\logs (for Windows) or /local/game/logs
	// (for Linux). Use the GameLift console to access stored logs.
	LogPaths []*string `type:"list"`

	// Descriptive label associated with a fleet. Fleet names do not need to be
	// unique.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Game session protection policy to apply to all instances in this fleet. If
	// this parameter is not set, instances in this fleet default to no protection.
	// You can change a fleet's protection policy using UpdateFleetAttributes, but
	// this change will only affect sessions created after the policy change. You
	// can also set protection for individual instances using UpdateGameSession.
	//
	//    * NoProtection – The game session can be terminated during a scale-down
	//    event.
	//
	//    * FullProtection – If the game session is in an ACTIVE status, it cannot
	//    be terminated during a scale-down event.
	NewGameSessionProtectionPolicy *string `type:"string" enum:"ProtectionPolicy"`

	// Policy that limits the number of game sessions an individual player can create
	// over a span of time for this fleet.
	ResourceCreationLimitPolicy *ResourceCreationLimitPolicy `type:"structure"`

	// Instructions for launching server processes on each instance in the fleet.
	// The runtime configuration for a fleet has a collection of server process
	// configurations, one for each type of server process to run on an instance.
	// A server process configuration specifies the location of the server executable,
	// launch parameters, and the number of concurrent processes with that configuration
	// to maintain on each instance. A CreateFleet request must include a runtime
	// configuration with at least one server process configuration; otherwise the
	// request will fail with an invalid request exception. (This parameter replaces
	// the parameters ServerLaunchPath and ServerLaunchParameters; requests that
	// contain values for these parameters instead of a runtime configuration will
	// continue to work.)
	RuntimeConfiguration *RuntimeConfiguration `type:"structure"`

	// This parameter is no longer used. Instead, specify server launch parameters
	// in the RuntimeConfiguration parameter. (Requests that specify a server launch
	// path and launch parameters instead of a runtime configuration will continue
	// to work.)
	ServerLaunchParameters *string `min:"1" type:"string"`

	// This parameter is no longer used. Instead, specify a server launch path using
	// the RuntimeConfiguration parameter. (Requests that specify a server launch
	// path and launch parameters instead of a runtime configuration will continue
	// to work.)
	ServerLaunchPath *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (CreateFleetInput) GoString

func (s CreateFleetInput) GoString() string

GoString returns the string representation

func (*CreateFleetInput) SetBuildId added in v1.5.0

func (s *CreateFleetInput) SetBuildId(v string) *CreateFleetInput

SetBuildId sets the BuildId field's value.

func (*CreateFleetInput) SetDescription added in v1.5.0

func (s *CreateFleetInput) SetDescription(v string) *CreateFleetInput

SetDescription sets the Description field's value.

func (*CreateFleetInput) SetEC2InboundPermissions added in v1.5.0

func (s *CreateFleetInput) SetEC2InboundPermissions(v []*IpPermission) *CreateFleetInput

SetEC2InboundPermissions sets the EC2InboundPermissions field's value.

func (*CreateFleetInput) SetEC2InstanceType added in v1.5.0

func (s *CreateFleetInput) SetEC2InstanceType(v string) *CreateFleetInput

SetEC2InstanceType sets the EC2InstanceType field's value.

func (*CreateFleetInput) SetLogPaths added in v1.5.0

func (s *CreateFleetInput) SetLogPaths(v []*string) *CreateFleetInput

SetLogPaths sets the LogPaths field's value.

func (*CreateFleetInput) SetName added in v1.5.0

func (s *CreateFleetInput) SetName(v string) *CreateFleetInput

SetName sets the Name field's value.

func (*CreateFleetInput) SetNewGameSessionProtectionPolicy added in v1.5.0

func (s *CreateFleetInput) SetNewGameSessionProtectionPolicy(v string) *CreateFleetInput

SetNewGameSessionProtectionPolicy sets the NewGameSessionProtectionPolicy field's value.

func (*CreateFleetInput) SetResourceCreationLimitPolicy added in v1.5.0

func (s *CreateFleetInput) SetResourceCreationLimitPolicy(v *ResourceCreationLimitPolicy) *CreateFleetInput

SetResourceCreationLimitPolicy sets the ResourceCreationLimitPolicy field's value.

func (*CreateFleetInput) SetRuntimeConfiguration added in v1.5.0

func (s *CreateFleetInput) SetRuntimeConfiguration(v *RuntimeConfiguration) *CreateFleetInput

SetRuntimeConfiguration sets the RuntimeConfiguration field's value.

func (*CreateFleetInput) SetServerLaunchParameters added in v1.5.0

func (s *CreateFleetInput) SetServerLaunchParameters(v string) *CreateFleetInput

SetServerLaunchParameters sets the ServerLaunchParameters field's value.

func (*CreateFleetInput) SetServerLaunchPath added in v1.5.0

func (s *CreateFleetInput) SetServerLaunchPath(v string) *CreateFleetInput

SetServerLaunchPath sets the ServerLaunchPath field's value.

func (CreateFleetInput) String

func (s CreateFleetInput) String() string

String returns the string representation

func (*CreateFleetInput) Validate added in v1.1.21

func (s *CreateFleetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFleetOutput

type CreateFleetOutput struct {

	// Properties for the newly created fleet.
	FleetAttributes *FleetAttributes `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (CreateFleetOutput) GoString

func (s CreateFleetOutput) GoString() string

GoString returns the string representation

func (*CreateFleetOutput) SetFleetAttributes added in v1.5.0

func (s *CreateFleetOutput) SetFleetAttributes(v *FleetAttributes) *CreateFleetOutput

SetFleetAttributes sets the FleetAttributes field's value.

func (CreateFleetOutput) String

func (s CreateFleetOutput) String() string

String returns the string representation

type CreateGameSessionInput

type CreateGameSessionInput struct {

	// Unique identifier for a fleet alias. Each request must reference either a
	// fleet ID or alias ID, but not both.
	AliasId *string `type:"string"`

	// Player ID identifying the person or entity creating the game session. This
	// ID is used to enforce a resource protection policy (if one exists) that limits
	// the number of concurrent active game sessions one player can have.
	CreatorId *string `min:"1" type:"string"`

	// Unique identifier for a fleet. Each request must reference either a fleet
	// ID or alias ID, but not both.
	FleetId *string `type:"string"`

	// Set of properties used to administer a game session. These properties are
	// passed to the server process hosting it.
	GameProperties []*GameProperty `type:"list"`

	// Custom string to include in the game session ID, with a maximum length of
	// 48 characters. If this parameter is set, GameLift creates a game session
	// ID in the following format: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet
	// ID>/<custom ID string>". For example, this full game session ID: "arn:aws:gamelift:us-west-2::gamesession/fleet-2ec2aae5-c2c7-43ca-b19d-8249fe5fddf2/my-game-session"
	// includes the custom ID string "my-game-session". If this parameter is not
	// set, GameLift creates a game session ID in the same format with an autogenerated
	// ID string.
	GameSessionId *string `min:"1" type:"string"`

	// Maximum number of players that can be connected simultaneously to the game
	// session.
	//
	// MaximumPlayerSessionCount is a required field
	MaximumPlayerSessionCount *int64 `type:"integer" required:"true"`

	// Descriptive label associated with a game session. Session names do not need
	// to be unique.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (CreateGameSessionInput) GoString

func (s CreateGameSessionInput) GoString() string

GoString returns the string representation

func (*CreateGameSessionInput) SetAliasId added in v1.5.0

SetAliasId sets the AliasId field's value.

func (*CreateGameSessionInput) SetCreatorId added in v1.5.0

SetCreatorId sets the CreatorId field's value.

func (*CreateGameSessionInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*CreateGameSessionInput) SetGameProperties added in v1.5.0

func (s *CreateGameSessionInput) SetGameProperties(v []*GameProperty) *CreateGameSessionInput

SetGameProperties sets the GameProperties field's value.

func (*CreateGameSessionInput) SetGameSessionId added in v1.5.0

func (s *CreateGameSessionInput) SetGameSessionId(v string) *CreateGameSessionInput

SetGameSessionId sets the GameSessionId field's value.

func (*CreateGameSessionInput) SetMaximumPlayerSessionCount added in v1.5.0

func (s *CreateGameSessionInput) SetMaximumPlayerSessionCount(v int64) *CreateGameSessionInput

SetMaximumPlayerSessionCount sets the MaximumPlayerSessionCount field's value.

func (*CreateGameSessionInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (CreateGameSessionInput) String

func (s CreateGameSessionInput) String() string

String returns the string representation

func (*CreateGameSessionInput) Validate added in v1.1.21

func (s *CreateGameSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateGameSessionOutput

type CreateGameSessionOutput struct {

	// Object containing the newly created game session record.
	GameSession *GameSession `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (CreateGameSessionOutput) GoString

func (s CreateGameSessionOutput) GoString() string

GoString returns the string representation

func (*CreateGameSessionOutput) SetGameSession added in v1.5.0

SetGameSession sets the GameSession field's value.

func (CreateGameSessionOutput) String

func (s CreateGameSessionOutput) String() string

String returns the string representation

type CreatePlayerSessionInput

type CreatePlayerSessionInput struct {

	// Unique identifier for the game session to add a player to. Game session ID
	// format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet
	// ID>/<ID string>". The value of <ID string> is either a custom ID string (if
	// one was specified when the game session was created) an autogenerated string.
	//
	// GameSessionId is a required field
	GameSessionId *string `min:"1" type:"string" required:"true"`

	// Unique identifier for the player to be added.
	//
	// PlayerId is a required field
	PlayerId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (CreatePlayerSessionInput) GoString

func (s CreatePlayerSessionInput) GoString() string

GoString returns the string representation

func (*CreatePlayerSessionInput) SetGameSessionId added in v1.5.0

SetGameSessionId sets the GameSessionId field's value.

func (*CreatePlayerSessionInput) SetPlayerId added in v1.5.0

SetPlayerId sets the PlayerId field's value.

func (CreatePlayerSessionInput) String

func (s CreatePlayerSessionInput) String() string

String returns the string representation

func (*CreatePlayerSessionInput) Validate added in v1.1.21

func (s *CreatePlayerSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePlayerSessionOutput

type CreatePlayerSessionOutput struct {

	// Object containing the newly created player session record.
	PlayerSession *PlayerSession `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (CreatePlayerSessionOutput) GoString

func (s CreatePlayerSessionOutput) GoString() string

GoString returns the string representation

func (*CreatePlayerSessionOutput) SetPlayerSession added in v1.5.0

SetPlayerSession sets the PlayerSession field's value.

func (CreatePlayerSessionOutput) String

func (s CreatePlayerSessionOutput) String() string

String returns the string representation

type CreatePlayerSessionsInput

type CreatePlayerSessionsInput struct {

	// Unique identifier for the game session to add players to. Game session ID
	// format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet
	// ID>/<ID string>". The value of <ID string> is either a custom ID string (if
	// one was specified when the game session was created) an autogenerated string.
	//
	// GameSessionId is a required field
	GameSessionId *string `min:"1" type:"string" required:"true"`

	// List of unique identifiers for the players to be added.
	//
	// PlayerIds is a required field
	PlayerIds []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (CreatePlayerSessionsInput) GoString

func (s CreatePlayerSessionsInput) GoString() string

GoString returns the string representation

func (*CreatePlayerSessionsInput) SetGameSessionId added in v1.5.0

SetGameSessionId sets the GameSessionId field's value.

func (*CreatePlayerSessionsInput) SetPlayerIds added in v1.5.0

SetPlayerIds sets the PlayerIds field's value.

func (CreatePlayerSessionsInput) String

func (s CreatePlayerSessionsInput) String() string

String returns the string representation

func (*CreatePlayerSessionsInput) Validate added in v1.1.21

func (s *CreatePlayerSessionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePlayerSessionsOutput

type CreatePlayerSessionsOutput struct {

	// Collection of player session objects created for the added players.
	PlayerSessions []*PlayerSession `type:"list"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (CreatePlayerSessionsOutput) GoString

func (s CreatePlayerSessionsOutput) GoString() string

GoString returns the string representation

func (*CreatePlayerSessionsOutput) SetPlayerSessions added in v1.5.0

SetPlayerSessions sets the PlayerSessions field's value.

func (CreatePlayerSessionsOutput) String

String returns the string representation

type DeleteAliasInput

type DeleteAliasInput struct {

	// Unique identifier for a fleet alias. Specify the alias you want to delete.
	//
	// AliasId is a required field
	AliasId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DeleteAliasInput) GoString

func (s DeleteAliasInput) GoString() string

GoString returns the string representation

func (*DeleteAliasInput) SetAliasId added in v1.5.0

func (s *DeleteAliasInput) SetAliasId(v string) *DeleteAliasInput

SetAliasId sets the AliasId field's value.

func (DeleteAliasInput) String

func (s DeleteAliasInput) String() string

String returns the string representation

func (*DeleteAliasInput) Validate added in v1.1.21

func (s *DeleteAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAliasOutput

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

func (DeleteAliasOutput) GoString

func (s DeleteAliasOutput) GoString() string

GoString returns the string representation

func (DeleteAliasOutput) String

func (s DeleteAliasOutput) String() string

String returns the string representation

type DeleteBuildInput

type DeleteBuildInput struct {

	// Unique identifier for the build you want to delete.
	//
	// BuildId is a required field
	BuildId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DeleteBuildInput) GoString

func (s DeleteBuildInput) GoString() string

GoString returns the string representation

func (*DeleteBuildInput) SetBuildId added in v1.5.0

func (s *DeleteBuildInput) SetBuildId(v string) *DeleteBuildInput

SetBuildId sets the BuildId field's value.

func (DeleteBuildInput) String

func (s DeleteBuildInput) String() string

String returns the string representation

func (*DeleteBuildInput) Validate added in v1.1.21

func (s *DeleteBuildInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBuildOutput

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

func (DeleteBuildOutput) GoString

func (s DeleteBuildOutput) GoString() string

GoString returns the string representation

func (DeleteBuildOutput) String

func (s DeleteBuildOutput) String() string

String returns the string representation

type DeleteFleetInput

type DeleteFleetInput struct {

	// Unique identifier for the fleet you want to delete.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DeleteFleetInput) GoString

func (s DeleteFleetInput) GoString() string

GoString returns the string representation

func (*DeleteFleetInput) SetFleetId added in v1.5.0

func (s *DeleteFleetInput) SetFleetId(v string) *DeleteFleetInput

SetFleetId sets the FleetId field's value.

func (DeleteFleetInput) String

func (s DeleteFleetInput) String() string

String returns the string representation

func (*DeleteFleetInput) Validate added in v1.1.21

func (s *DeleteFleetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFleetOutput

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

func (DeleteFleetOutput) GoString

func (s DeleteFleetOutput) GoString() string

GoString returns the string representation

func (DeleteFleetOutput) String

func (s DeleteFleetOutput) String() string

String returns the string representation

type DeleteScalingPolicyInput added in v1.1.10

type DeleteScalingPolicyInput struct {

	// Unique identifier for a fleet.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Descriptive label associated with a scaling policy. Policy names do not need
	// to be unique.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DeleteScalingPolicyInput) GoString added in v1.1.10

func (s DeleteScalingPolicyInput) GoString() string

GoString returns the string representation

func (*DeleteScalingPolicyInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*DeleteScalingPolicyInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (DeleteScalingPolicyInput) String added in v1.1.10

func (s DeleteScalingPolicyInput) String() string

String returns the string representation

func (*DeleteScalingPolicyInput) Validate added in v1.1.21

func (s *DeleteScalingPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteScalingPolicyOutput added in v1.1.10

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

func (DeleteScalingPolicyOutput) GoString added in v1.1.10

func (s DeleteScalingPolicyOutput) GoString() string

GoString returns the string representation

func (DeleteScalingPolicyOutput) String added in v1.1.10

func (s DeleteScalingPolicyOutput) String() string

String returns the string representation

type DescribeAliasInput

type DescribeAliasInput struct {

	// Unique identifier for a fleet alias. Specify the alias you want to retrieve.
	//
	// AliasId is a required field
	AliasId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeAliasInput) GoString

func (s DescribeAliasInput) GoString() string

GoString returns the string representation

func (*DescribeAliasInput) SetAliasId added in v1.5.0

func (s *DescribeAliasInput) SetAliasId(v string) *DescribeAliasInput

SetAliasId sets the AliasId field's value.

func (DescribeAliasInput) String

func (s DescribeAliasInput) String() string

String returns the string representation

func (*DescribeAliasInput) Validate added in v1.1.21

func (s *DescribeAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAliasOutput

type DescribeAliasOutput struct {

	// Object containing the requested alias.
	Alias *Alias `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeAliasOutput) GoString

func (s DescribeAliasOutput) GoString() string

GoString returns the string representation

func (*DescribeAliasOutput) SetAlias added in v1.5.0

SetAlias sets the Alias field's value.

func (DescribeAliasOutput) String

func (s DescribeAliasOutput) String() string

String returns the string representation

type DescribeBuildInput

type DescribeBuildInput struct {

	// Unique identifier of the build that you want to retrieve properties for.
	//
	// BuildId is a required field
	BuildId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeBuildInput) GoString

func (s DescribeBuildInput) GoString() string

GoString returns the string representation

func (*DescribeBuildInput) SetBuildId added in v1.5.0

func (s *DescribeBuildInput) SetBuildId(v string) *DescribeBuildInput

SetBuildId sets the BuildId field's value.

func (DescribeBuildInput) String

func (s DescribeBuildInput) String() string

String returns the string representation

func (*DescribeBuildInput) Validate added in v1.1.21

func (s *DescribeBuildInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBuildOutput

type DescribeBuildOutput struct {

	// Set of properties describing the requested build.
	Build *Build `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeBuildOutput) GoString

func (s DescribeBuildOutput) GoString() string

GoString returns the string representation

func (*DescribeBuildOutput) SetBuild added in v1.5.0

SetBuild sets the Build field's value.

func (DescribeBuildOutput) String

func (s DescribeBuildOutput) String() string

String returns the string representation

type DescribeEC2InstanceLimitsInput

type DescribeEC2InstanceLimitsInput struct {

	// Name of an EC2 instance type that is supported in Amazon GameLift. A fleet
	// instance type determines the computing resources of each instance in the
	// fleet, including CPU, memory, storage, and networking capacity. GameLift
	// supports the following EC2 instance types. See Amazon EC2 Instance Types
	// (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions. Leave
	// this parameter blank to retrieve limits for all types.
	EC2InstanceType *string `type:"string" enum:"EC2InstanceType"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeEC2InstanceLimitsInput) GoString

GoString returns the string representation

func (*DescribeEC2InstanceLimitsInput) SetEC2InstanceType added in v1.5.0

SetEC2InstanceType sets the EC2InstanceType field's value.

func (DescribeEC2InstanceLimitsInput) String

String returns the string representation

type DescribeEC2InstanceLimitsOutput

type DescribeEC2InstanceLimitsOutput struct {

	// Object containing the maximum number of instances for the specified instance
	// type.
	EC2InstanceLimits []*EC2InstanceLimit `type:"list"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeEC2InstanceLimitsOutput) GoString

GoString returns the string representation

func (*DescribeEC2InstanceLimitsOutput) SetEC2InstanceLimits added in v1.5.0

SetEC2InstanceLimits sets the EC2InstanceLimits field's value.

func (DescribeEC2InstanceLimitsOutput) String

String returns the string representation

type DescribeFleetAttributesInput

type DescribeFleetAttributesInput struct {

	// Unique identifiers for the fleet(s) that you want to retrieve attributes
	// for. To request attributes for all fleets, leave this parameter empty.
	FleetIds []*string `min:"1" type:"list"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages. This parameter is ignored when
	// the request specifies one or a list of fleet IDs.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value. This parameter is ignored
	// when the request specifies one or a list of fleet IDs.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeFleetAttributesInput) GoString

func (s DescribeFleetAttributesInput) GoString() string

GoString returns the string representation

func (*DescribeFleetAttributesInput) SetFleetIds added in v1.5.0

SetFleetIds sets the FleetIds field's value.

func (*DescribeFleetAttributesInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeFleetAttributesInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeFleetAttributesInput) String

String returns the string representation

func (*DescribeFleetAttributesInput) Validate added in v1.1.21

func (s *DescribeFleetAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFleetAttributesOutput

type DescribeFleetAttributesOutput struct {

	// Collection of objects containing attribute metadata for each requested fleet
	// ID.
	FleetAttributes []*FleetAttributes `type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeFleetAttributesOutput) GoString

GoString returns the string representation

func (*DescribeFleetAttributesOutput) SetFleetAttributes added in v1.5.0

SetFleetAttributes sets the FleetAttributes field's value.

func (*DescribeFleetAttributesOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeFleetAttributesOutput) String

String returns the string representation

type DescribeFleetCapacityInput

type DescribeFleetCapacityInput struct {

	// Unique identifier for the fleet(s) you want to retrieve capacity information
	// for. To request capacity information for all fleets, leave this parameter
	// empty.
	FleetIds []*string `min:"1" type:"list"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages. This parameter is ignored when
	// the request specifies one or a list of fleet IDs.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value. This parameter is ignored
	// when the request specifies one or a list of fleet IDs.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeFleetCapacityInput) GoString

func (s DescribeFleetCapacityInput) GoString() string

GoString returns the string representation

func (*DescribeFleetCapacityInput) SetFleetIds added in v1.5.0

SetFleetIds sets the FleetIds field's value.

func (*DescribeFleetCapacityInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeFleetCapacityInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeFleetCapacityInput) String

String returns the string representation

func (*DescribeFleetCapacityInput) Validate added in v1.1.21

func (s *DescribeFleetCapacityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFleetCapacityOutput

type DescribeFleetCapacityOutput struct {

	// Collection of objects containing capacity information for each requested
	// fleet ID. Leave this parameter empty to retrieve capacity information for
	// all fleets.
	FleetCapacity []*FleetCapacity `type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeFleetCapacityOutput) GoString

func (s DescribeFleetCapacityOutput) GoString() string

GoString returns the string representation

func (*DescribeFleetCapacityOutput) SetFleetCapacity added in v1.5.0

SetFleetCapacity sets the FleetCapacity field's value.

func (*DescribeFleetCapacityOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeFleetCapacityOutput) String

String returns the string representation

type DescribeFleetEventsInput

type DescribeFleetEventsInput struct {

	// Most recent date to retrieve event logs for. If no end time is specified,
	// this call returns entries from the specified start time up to the present.
	// Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
	EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Unique identifier for the fleet to get event logs for.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value.
	NextToken *string `min:"1" type:"string"`

	// Earliest date to retrieve event logs for. If no start time is specified,
	// this call returns entries starting from when the fleet was created to the
	// specified end time. Format is a number expressed in Unix time as milliseconds
	// (ex: "1469498468.057").
	StartTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeFleetEventsInput) GoString

func (s DescribeFleetEventsInput) GoString() string

GoString returns the string representation

func (*DescribeFleetEventsInput) SetEndTime added in v1.5.0

SetEndTime sets the EndTime field's value.

func (*DescribeFleetEventsInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*DescribeFleetEventsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeFleetEventsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeFleetEventsInput) SetStartTime added in v1.5.0

SetStartTime sets the StartTime field's value.

func (DescribeFleetEventsInput) String

func (s DescribeFleetEventsInput) String() string

String returns the string representation

func (*DescribeFleetEventsInput) Validate added in v1.1.21

func (s *DescribeFleetEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFleetEventsOutput

type DescribeFleetEventsOutput struct {

	// Collection of objects containing event log entries for the specified fleet.
	Events []*Event `type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeFleetEventsOutput) GoString

func (s DescribeFleetEventsOutput) GoString() string

GoString returns the string representation

func (*DescribeFleetEventsOutput) SetEvents added in v1.5.0

SetEvents sets the Events field's value.

func (*DescribeFleetEventsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeFleetEventsOutput) String

func (s DescribeFleetEventsOutput) String() string

String returns the string representation

type DescribeFleetPortSettingsInput

type DescribeFleetPortSettingsInput struct {

	// Unique identifier for the fleet you want to retrieve port settings for.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeFleetPortSettingsInput) GoString

GoString returns the string representation

func (*DescribeFleetPortSettingsInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (DescribeFleetPortSettingsInput) String

String returns the string representation

func (*DescribeFleetPortSettingsInput) Validate added in v1.1.21

func (s *DescribeFleetPortSettingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFleetPortSettingsOutput

type DescribeFleetPortSettingsOutput struct {

	// Object containing port settings for the requested fleet ID.
	InboundPermissions []*IpPermission `type:"list"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeFleetPortSettingsOutput) GoString

GoString returns the string representation

func (*DescribeFleetPortSettingsOutput) SetInboundPermissions added in v1.5.0

SetInboundPermissions sets the InboundPermissions field's value.

func (DescribeFleetPortSettingsOutput) String

String returns the string representation

type DescribeFleetUtilizationInput

type DescribeFleetUtilizationInput struct {

	// Unique identifier for the fleet(s) you want to retrieve utilization data
	// for. To request utilization data for all fleets, leave this parameter empty.
	FleetIds []*string `min:"1" type:"list"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages. This parameter is ignored when
	// the request specifies one or a list of fleet IDs.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value. This parameter is ignored
	// when the request specifies one or a list of fleet IDs.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeFleetUtilizationInput) GoString

GoString returns the string representation

func (*DescribeFleetUtilizationInput) SetFleetIds added in v1.5.0

SetFleetIds sets the FleetIds field's value.

func (*DescribeFleetUtilizationInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeFleetUtilizationInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeFleetUtilizationInput) String

String returns the string representation

func (*DescribeFleetUtilizationInput) Validate added in v1.1.21

func (s *DescribeFleetUtilizationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFleetUtilizationOutput

type DescribeFleetUtilizationOutput struct {

	// Collection of objects containing utilization information for each requested
	// fleet ID.
	FleetUtilization []*FleetUtilization `type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeFleetUtilizationOutput) GoString

GoString returns the string representation

func (*DescribeFleetUtilizationOutput) SetFleetUtilization added in v1.5.0

SetFleetUtilization sets the FleetUtilization field's value.

func (*DescribeFleetUtilizationOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeFleetUtilizationOutput) String

String returns the string representation

type DescribeGameSessionDetailsInput added in v1.1.10

type DescribeGameSessionDetailsInput struct {

	// Unique identifier for a fleet alias. Specify an alias to retrieve information
	// on all game sessions active on the fleet.
	AliasId *string `type:"string"`

	// Unique identifier for a fleet. Specify a fleet to retrieve information on
	// all game sessions active on the fleet.
	FleetId *string `type:"string"`

	// Unique identifier for the game session to retrieve information on. Game session
	// ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet
	// ID>/<ID string>". The value of <ID string> is either a custom ID string (if
	// one was specified when the game session was created) an autogenerated string.
	GameSessionId *string `min:"1" type:"string"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value.
	NextToken *string `min:"1" type:"string"`

	// Game session status to filter results on. Possible game session statuses
	// include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are
	// transitory).
	StatusFilter *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeGameSessionDetailsInput) GoString added in v1.1.10

GoString returns the string representation

func (*DescribeGameSessionDetailsInput) SetAliasId added in v1.5.0

SetAliasId sets the AliasId field's value.

func (*DescribeGameSessionDetailsInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*DescribeGameSessionDetailsInput) SetGameSessionId added in v1.5.0

SetGameSessionId sets the GameSessionId field's value.

func (*DescribeGameSessionDetailsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeGameSessionDetailsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeGameSessionDetailsInput) SetStatusFilter added in v1.5.0

SetStatusFilter sets the StatusFilter field's value.

func (DescribeGameSessionDetailsInput) String added in v1.1.10

String returns the string representation

func (*DescribeGameSessionDetailsInput) Validate added in v1.1.21

func (s *DescribeGameSessionDetailsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeGameSessionDetailsOutput added in v1.1.10

type DescribeGameSessionDetailsOutput struct {

	// Collection of objects containing game session properties and the protection
	// policy currently in force for each session matching the request.
	GameSessionDetails []*GameSessionDetail `type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeGameSessionDetailsOutput) GoString added in v1.1.10

GoString returns the string representation

func (*DescribeGameSessionDetailsOutput) SetGameSessionDetails added in v1.5.0

SetGameSessionDetails sets the GameSessionDetails field's value.

func (*DescribeGameSessionDetailsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeGameSessionDetailsOutput) String added in v1.1.10

String returns the string representation

type DescribeGameSessionsInput

type DescribeGameSessionsInput struct {

	// Unique identifier for a fleet alias. Specify an alias to retrieve information
	// on all game sessions active on the fleet.
	AliasId *string `type:"string"`

	// Unique identifier for a fleet. Specify a fleet to retrieve information on
	// all game sessions active on the fleet.
	FleetId *string `type:"string"`

	// Unique identifier for the game session to retrieve information on. Game session
	// ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet
	// ID>/<ID string>". The value of <ID string> is either a custom ID string (if
	// one was specified when the game session was created) an autogenerated string.
	GameSessionId *string `min:"1" type:"string"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value.
	NextToken *string `min:"1" type:"string"`

	// Game session status to filter results on. Possible game session statuses
	// include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are
	// transitory).
	StatusFilter *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeGameSessionsInput) GoString

func (s DescribeGameSessionsInput) GoString() string

GoString returns the string representation

func (*DescribeGameSessionsInput) SetAliasId added in v1.5.0

SetAliasId sets the AliasId field's value.

func (*DescribeGameSessionsInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*DescribeGameSessionsInput) SetGameSessionId added in v1.5.0

SetGameSessionId sets the GameSessionId field's value.

func (*DescribeGameSessionsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeGameSessionsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeGameSessionsInput) SetStatusFilter added in v1.5.0

SetStatusFilter sets the StatusFilter field's value.

func (DescribeGameSessionsInput) String

func (s DescribeGameSessionsInput) String() string

String returns the string representation

func (*DescribeGameSessionsInput) Validate added in v1.1.21

func (s *DescribeGameSessionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeGameSessionsOutput

type DescribeGameSessionsOutput struct {

	// Collection of objects containing game session properties for each session
	// matching the request.
	GameSessions []*GameSession `type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeGameSessionsOutput) GoString

func (s DescribeGameSessionsOutput) GoString() string

GoString returns the string representation

func (*DescribeGameSessionsOutput) SetGameSessions added in v1.5.0

SetGameSessions sets the GameSessions field's value.

func (*DescribeGameSessionsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeGameSessionsOutput) String

String returns the string representation

type DescribeInstancesInput added in v1.4.18

type DescribeInstancesInput struct {

	// Unique identifier for a fleet. Specify the fleet to retrieve instance information
	// for.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Unique identifier for an instance. Specify an instance to retrieve information
	// for or leave blank to get information on all instances in the fleet.
	InstanceId *string `type:"string"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeInstancesInput) GoString added in v1.4.18

func (s DescribeInstancesInput) GoString() string

GoString returns the string representation

func (*DescribeInstancesInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*DescribeInstancesInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*DescribeInstancesInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeInstancesInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeInstancesInput) String added in v1.4.18

func (s DescribeInstancesInput) String() string

String returns the string representation

func (*DescribeInstancesInput) Validate added in v1.4.18

func (s *DescribeInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeInstancesOutput added in v1.4.18

type DescribeInstancesOutput struct {

	// Collection of objects containing properties for each instance returned.
	Instances []*Instance `type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeInstancesOutput) GoString added in v1.4.18

func (s DescribeInstancesOutput) GoString() string

GoString returns the string representation

func (*DescribeInstancesOutput) SetInstances added in v1.5.0

SetInstances sets the Instances field's value.

func (*DescribeInstancesOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeInstancesOutput) String added in v1.4.18

func (s DescribeInstancesOutput) String() string

String returns the string representation

type DescribePlayerSessionsInput

type DescribePlayerSessionsInput struct {

	// Unique identifier for the game session to get player sessions for. Game session
	// ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet
	// ID>/<ID string>". The value of <ID string> is either a custom ID string (if
	// one was specified when the game session was created) an autogenerated string.
	GameSessionId *string `min:"1" type:"string"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages. If a player session ID is specified,
	// this parameter is ignored.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value. If a player session ID is
	// specified, this parameter is ignored.
	NextToken *string `min:"1" type:"string"`

	// Unique identifier for a player.
	PlayerId *string `min:"1" type:"string"`

	// Unique identifier for a player session.
	PlayerSessionId *string `type:"string"`

	// Player session status to filter results on.
	//
	// Possible player session statuses include the following:
	//
	//    * RESERVED – The player session request has been received, but the player
	//    has not yet connected to the server process and/or been validated.
	//
	//    * ACTIVE – The player has been validated by the server process and is
	//    currently connected.
	//
	//    * COMPLETED – The player connection has been dropped.
	//
	//    * TIMEDOUT – A player session request was received, but the player did
	//    not connect and/or was not validated within the time-out limit (60 seconds).
	PlayerSessionStatusFilter *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribePlayerSessionsInput) GoString

func (s DescribePlayerSessionsInput) GoString() string

GoString returns the string representation

func (*DescribePlayerSessionsInput) SetGameSessionId added in v1.5.0

SetGameSessionId sets the GameSessionId field's value.

func (*DescribePlayerSessionsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribePlayerSessionsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribePlayerSessionsInput) SetPlayerId added in v1.5.0

SetPlayerId sets the PlayerId field's value.

func (*DescribePlayerSessionsInput) SetPlayerSessionId added in v1.5.0

SetPlayerSessionId sets the PlayerSessionId field's value.

func (*DescribePlayerSessionsInput) SetPlayerSessionStatusFilter added in v1.5.0

func (s *DescribePlayerSessionsInput) SetPlayerSessionStatusFilter(v string) *DescribePlayerSessionsInput

SetPlayerSessionStatusFilter sets the PlayerSessionStatusFilter field's value.

func (DescribePlayerSessionsInput) String

String returns the string representation

func (*DescribePlayerSessionsInput) Validate added in v1.1.21

func (s *DescribePlayerSessionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePlayerSessionsOutput

type DescribePlayerSessionsOutput struct {

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`

	// Collection of objects containing properties for each player session that
	// matches the request.
	PlayerSessions []*PlayerSession `type:"list"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribePlayerSessionsOutput) GoString

func (s DescribePlayerSessionsOutput) GoString() string

GoString returns the string representation

func (*DescribePlayerSessionsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribePlayerSessionsOutput) SetPlayerSessions added in v1.5.0

SetPlayerSessions sets the PlayerSessions field's value.

func (DescribePlayerSessionsOutput) String

String returns the string representation

type DescribeRuntimeConfigurationInput added in v1.2.1

type DescribeRuntimeConfigurationInput struct {

	// Unique identifier of the fleet to get the runtime configuration for.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeRuntimeConfigurationInput) GoString added in v1.2.1

GoString returns the string representation

func (*DescribeRuntimeConfigurationInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (DescribeRuntimeConfigurationInput) String added in v1.2.1

String returns the string representation

func (*DescribeRuntimeConfigurationInput) Validate added in v1.2.1

Validate inspects the fields of the type to determine if they are valid.

type DescribeRuntimeConfigurationOutput added in v1.2.1

type DescribeRuntimeConfigurationOutput struct {

	// Instructions describing how server processes should be launched and maintained
	// on each instance in the fleet.
	RuntimeConfiguration *RuntimeConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeRuntimeConfigurationOutput) GoString added in v1.2.1

GoString returns the string representation

func (*DescribeRuntimeConfigurationOutput) SetRuntimeConfiguration added in v1.5.0

SetRuntimeConfiguration sets the RuntimeConfiguration field's value.

func (DescribeRuntimeConfigurationOutput) String added in v1.2.1

String returns the string representation

type DescribeScalingPoliciesInput added in v1.1.10

type DescribeScalingPoliciesInput struct {

	// Unique identifier for a fleet. Specify the fleet to retrieve scaling policies
	// for.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value.
	NextToken *string `min:"1" type:"string"`

	// Scaling policy status to filter results on. A scaling policy is only in force
	// when in an ACTIVE status.
	//
	//    * ACTIVE – The scaling policy is currently in force.
	//
	//    * UPDATEREQUESTED – A request to update the scaling policy has been received.
	//
	//    * UPDATING – A change is being made to the scaling policy.
	//
	//    * DELETEREQUESTED – A request to delete the scaling policy has been received.
	//
	//    * DELETING – The scaling policy is being deleted.
	//
	//    * DELETED – The scaling policy has been deleted.
	//
	//    * ERROR – An error occurred in creating the policy. It should be removed
	//    and recreated.
	StatusFilter *string `type:"string" enum:"ScalingStatusType"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (DescribeScalingPoliciesInput) GoString added in v1.1.10

func (s DescribeScalingPoliciesInput) GoString() string

GoString returns the string representation

func (*DescribeScalingPoliciesInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*DescribeScalingPoliciesInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeScalingPoliciesInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeScalingPoliciesInput) SetStatusFilter added in v1.5.0

SetStatusFilter sets the StatusFilter field's value.

func (DescribeScalingPoliciesInput) String added in v1.1.10

String returns the string representation

func (*DescribeScalingPoliciesInput) Validate added in v1.1.21

func (s *DescribeScalingPoliciesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeScalingPoliciesOutput added in v1.1.10

type DescribeScalingPoliciesOutput struct {

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`

	// Collection of objects containing the scaling policies matching the request.
	ScalingPolicies []*ScalingPolicy `type:"list"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (DescribeScalingPoliciesOutput) GoString added in v1.1.10

GoString returns the string representation

func (*DescribeScalingPoliciesOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeScalingPoliciesOutput) SetScalingPolicies added in v1.5.0

SetScalingPolicies sets the ScalingPolicies field's value.

func (DescribeScalingPoliciesOutput) String added in v1.1.10

String returns the string representation

type EC2InstanceCounts

type EC2InstanceCounts struct {

	// Actual number of active instances in the fleet.
	ACTIVE *int64 `type:"integer"`

	// Ideal number of active instances in the fleet.
	DESIRED *int64 `type:"integer"`

	// Number of active instances in the fleet that are not currently hosting a
	// game session.
	IDLE *int64 `type:"integer"`

	// Maximum value allowed for the fleet's instance count.
	MAXIMUM *int64 `type:"integer"`

	// Minimum value allowed for the fleet's instance count.
	MINIMUM *int64 `type:"integer"`

	// Number of instances in the fleet that are starting but not yet active.
	PENDING *int64 `type:"integer"`

	// Number of instances in the fleet that are no longer active but haven't yet
	// been terminated.
	TERMINATING *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.

func (EC2InstanceCounts) GoString

func (s EC2InstanceCounts) GoString() string

GoString returns the string representation

func (*EC2InstanceCounts) SetACTIVE added in v1.5.0

func (s *EC2InstanceCounts) SetACTIVE(v int64) *EC2InstanceCounts

SetACTIVE sets the ACTIVE field's value.

func (*EC2InstanceCounts) SetDESIRED added in v1.5.0

func (s *EC2InstanceCounts) SetDESIRED(v int64) *EC2InstanceCounts

SetDESIRED sets the DESIRED field's value.

func (*EC2InstanceCounts) SetIDLE added in v1.5.0

func (s *EC2InstanceCounts) SetIDLE(v int64) *EC2InstanceCounts

SetIDLE sets the IDLE field's value.

func (*EC2InstanceCounts) SetMAXIMUM added in v1.5.0

func (s *EC2InstanceCounts) SetMAXIMUM(v int64) *EC2InstanceCounts

SetMAXIMUM sets the MAXIMUM field's value.

func (*EC2InstanceCounts) SetMINIMUM added in v1.5.0

func (s *EC2InstanceCounts) SetMINIMUM(v int64) *EC2InstanceCounts

SetMINIMUM sets the MINIMUM field's value.

func (*EC2InstanceCounts) SetPENDING added in v1.5.0

func (s *EC2InstanceCounts) SetPENDING(v int64) *EC2InstanceCounts

SetPENDING sets the PENDING field's value.

func (*EC2InstanceCounts) SetTERMINATING added in v1.5.0

func (s *EC2InstanceCounts) SetTERMINATING(v int64) *EC2InstanceCounts

SetTERMINATING sets the TERMINATING field's value.

func (EC2InstanceCounts) String

func (s EC2InstanceCounts) String() string

String returns the string representation

type EC2InstanceLimit

type EC2InstanceLimit struct {

	// Number of instances of the specified type that are currently in use by this
	// AWS account.
	CurrentInstances *int64 `type:"integer"`

	// Name of an EC2 instance type that is supported in Amazon GameLift. A fleet
	// instance type determines the computing resources of each instance in the
	// fleet, including CPU, memory, storage, and networking capacity. GameLift
	// supports the following EC2 instance types. See Amazon EC2 Instance Types
	// (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions.
	EC2InstanceType *string `type:"string" enum:"EC2InstanceType"`

	// Number of instances allowed.
	InstanceLimit *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits.

func (EC2InstanceLimit) GoString

func (s EC2InstanceLimit) GoString() string

GoString returns the string representation

func (*EC2InstanceLimit) SetCurrentInstances added in v1.5.0

func (s *EC2InstanceLimit) SetCurrentInstances(v int64) *EC2InstanceLimit

SetCurrentInstances sets the CurrentInstances field's value.

func (*EC2InstanceLimit) SetEC2InstanceType added in v1.5.0

func (s *EC2InstanceLimit) SetEC2InstanceType(v string) *EC2InstanceLimit

SetEC2InstanceType sets the EC2InstanceType field's value.

func (*EC2InstanceLimit) SetInstanceLimit added in v1.5.0

func (s *EC2InstanceLimit) SetInstanceLimit(v int64) *EC2InstanceLimit

SetInstanceLimit sets the InstanceLimit field's value.

func (EC2InstanceLimit) String

func (s EC2InstanceLimit) String() string

String returns the string representation

type Event

type Event struct {

	// Type of event being logged.
	EventCode *string `type:"string" enum:"EventCode"`

	// Unique identifier for a fleet event.
	EventId *string `min:"1" type:"string"`

	// Time stamp indicating when this event occurred. Format is a number expressed
	// in Unix time as milliseconds (ex: "1469498468.057").
	EventTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Additional information related to the event.
	Message *string `min:"1" type:"string"`

	// Unique identifier for the resource, such as a fleet ID.
	ResourceId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Log entry describing an event involving Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.

func (Event) GoString

func (s Event) GoString() string

GoString returns the string representation

func (*Event) SetEventCode added in v1.5.0

func (s *Event) SetEventCode(v string) *Event

SetEventCode sets the EventCode field's value.

func (*Event) SetEventId added in v1.5.0

func (s *Event) SetEventId(v string) *Event

SetEventId sets the EventId field's value.

func (*Event) SetEventTime added in v1.5.0

func (s *Event) SetEventTime(v time.Time) *Event

SetEventTime sets the EventTime field's value.

func (*Event) SetMessage added in v1.5.0

func (s *Event) SetMessage(v string) *Event

SetMessage sets the Message field's value.

func (*Event) SetResourceId added in v1.5.0

func (s *Event) SetResourceId(v string) *Event

SetResourceId sets the ResourceId field's value.

func (Event) String

func (s Event) String() string

String returns the string representation

type FleetAttributes

type FleetAttributes struct {

	// Unique identifier for a build.
	BuildId *string `type:"string"`

	// Time stamp indicating when this data object was created. Format is a number
	// expressed in Unix time as milliseconds (ex: "1469498468.057").
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Human-readable description of the fleet.
	Description *string `min:"1" type:"string"`

	// Unique identifier for a fleet.
	FleetId *string `type:"string"`

	// Location of default log files. When a server process is shut down, Amazon
	// GameLift captures and stores any log files in this location. These logs are
	// in addition to game session logs; see more on game session logs in the Amazon
	// GameLift Developer Guide (http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-api-server-code).
	// If no default log path for a fleet is specified, GameLift will automatically
	// upload logs that are stored on each instance at C:\game\logs (for Windows)
	// or /local/game/logs (for Linux). Use the GameLift console to access stored
	// logs.
	LogPaths []*string `type:"list"`

	// Descriptive label associated with a fleet. Fleet names do not need to be
	// unique.
	Name *string `min:"1" type:"string"`

	// Type of game session protection to set for all new instances started in the
	// fleet.
	//
	//    * NoProtection – The game session can be terminated during a scale-down
	//    event.
	//
	//    * FullProtection – If the game session is in an ACTIVE status, it cannot
	//    be terminated during a scale-down event.
	NewGameSessionProtectionPolicy *string `type:"string" enum:"ProtectionPolicy"`

	// Operating system of the fleet's computing resources. A fleet's operating
	// system depends on the OS specified for the build that is deployed on this
	// fleet.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// Fleet policy to limit the number of game sessions an individual player can
	// create over a span of time.
	ResourceCreationLimitPolicy *ResourceCreationLimitPolicy `type:"structure"`

	// Game server launch parameters specified for fleets created prior to 2016-08-04
	// (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after
	// this date are specified in the fleet's RuntimeConfiguration.
	ServerLaunchParameters *string `min:"1" type:"string"`

	// Path to a game server executable in the fleet's build, specified for fleets
	// created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths
	// for fleets created after this date are specified in the fleet's RuntimeConfiguration.
	ServerLaunchPath *string `min:"1" type:"string"`

	// Current status of the fleet.
	//
	// Possible fleet statuses include the following:
	//
	//    * NEW – A new fleet has been defined and desired instances is set to 1.
	//
	//
	//    * DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up
	//    the new fleet, creating new instances with the game build and starting
	//    server processes.
	//
	//    * ACTIVE – Hosts can now accept game sessions.
	//
	//    * ERROR – An error occurred when downloading, validating, building, or
	//    activating the fleet.
	//
	//    * DELETING – Hosts are responding to a delete fleet request.
	//
	//    * TERMINATED – The fleet no longer exists.
	Status *string `type:"string" enum:"FleetStatus"`

	// Time stamp indicating when this data object was terminated. Format is a number
	// expressed in Unix time as milliseconds (ex: "1469498468.057").
	TerminationTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

General properties describing a fleet.

func (FleetAttributes) GoString

func (s FleetAttributes) GoString() string

GoString returns the string representation

func (*FleetAttributes) SetBuildId added in v1.5.0

func (s *FleetAttributes) SetBuildId(v string) *FleetAttributes

SetBuildId sets the BuildId field's value.

func (*FleetAttributes) SetCreationTime added in v1.5.0

func (s *FleetAttributes) SetCreationTime(v time.Time) *FleetAttributes

SetCreationTime sets the CreationTime field's value.

func (*FleetAttributes) SetDescription added in v1.5.0

func (s *FleetAttributes) SetDescription(v string) *FleetAttributes

SetDescription sets the Description field's value.

func (*FleetAttributes) SetFleetId added in v1.5.0

func (s *FleetAttributes) SetFleetId(v string) *FleetAttributes

SetFleetId sets the FleetId field's value.

func (*FleetAttributes) SetLogPaths added in v1.5.0

func (s *FleetAttributes) SetLogPaths(v []*string) *FleetAttributes

SetLogPaths sets the LogPaths field's value.

func (*FleetAttributes) SetName added in v1.5.0

func (s *FleetAttributes) SetName(v string) *FleetAttributes

SetName sets the Name field's value.

func (*FleetAttributes) SetNewGameSessionProtectionPolicy added in v1.5.0

func (s *FleetAttributes) SetNewGameSessionProtectionPolicy(v string) *FleetAttributes

SetNewGameSessionProtectionPolicy sets the NewGameSessionProtectionPolicy field's value.

func (*FleetAttributes) SetOperatingSystem added in v1.5.0

func (s *FleetAttributes) SetOperatingSystem(v string) *FleetAttributes

SetOperatingSystem sets the OperatingSystem field's value.

func (*FleetAttributes) SetResourceCreationLimitPolicy added in v1.5.0

func (s *FleetAttributes) SetResourceCreationLimitPolicy(v *ResourceCreationLimitPolicy) *FleetAttributes

SetResourceCreationLimitPolicy sets the ResourceCreationLimitPolicy field's value.

func (*FleetAttributes) SetServerLaunchParameters added in v1.5.0

func (s *FleetAttributes) SetServerLaunchParameters(v string) *FleetAttributes

SetServerLaunchParameters sets the ServerLaunchParameters field's value.

func (*FleetAttributes) SetServerLaunchPath added in v1.5.0

func (s *FleetAttributes) SetServerLaunchPath(v string) *FleetAttributes

SetServerLaunchPath sets the ServerLaunchPath field's value.

func (*FleetAttributes) SetStatus added in v1.5.0

func (s *FleetAttributes) SetStatus(v string) *FleetAttributes

SetStatus sets the Status field's value.

func (*FleetAttributes) SetTerminationTime added in v1.5.0

func (s *FleetAttributes) SetTerminationTime(v time.Time) *FleetAttributes

SetTerminationTime sets the TerminationTime field's value.

func (FleetAttributes) String

func (s FleetAttributes) String() string

String returns the string representation

type FleetCapacity

type FleetCapacity struct {

	// Unique identifier for a fleet.
	FleetId *string `type:"string"`

	// Current status of fleet capacity.
	InstanceCounts *EC2InstanceCounts `type:"structure"`

	// Name of an EC2 instance type that is supported in Amazon GameLift. A fleet
	// instance type determines the computing resources of each instance in the
	// fleet, including CPU, memory, storage, and networking capacity. GameLift
	// supports the following EC2 instance types. See Amazon EC2 Instance Types
	// (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions.
	InstanceType *string `type:"string" enum:"EC2InstanceType"`
	// contains filtered or unexported fields
}

Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.

func (FleetCapacity) GoString

func (s FleetCapacity) GoString() string

GoString returns the string representation

func (*FleetCapacity) SetFleetId added in v1.5.0

func (s *FleetCapacity) SetFleetId(v string) *FleetCapacity

SetFleetId sets the FleetId field's value.

func (*FleetCapacity) SetInstanceCounts added in v1.5.0

func (s *FleetCapacity) SetInstanceCounts(v *EC2InstanceCounts) *FleetCapacity

SetInstanceCounts sets the InstanceCounts field's value.

func (*FleetCapacity) SetInstanceType added in v1.5.0

func (s *FleetCapacity) SetInstanceType(v string) *FleetCapacity

SetInstanceType sets the InstanceType field's value.

func (FleetCapacity) String

func (s FleetCapacity) String() string

String returns the string representation

type FleetUtilization

type FleetUtilization struct {

	// Number of active game sessions currently being hosted on all instances in
	// the fleet.
	ActiveGameSessionCount *int64 `type:"integer"`

	// Number of server processes in an ACTIVE status currently running across all
	// instances in the fleet
	ActiveServerProcessCount *int64 `type:"integer"`

	// Number of active player sessions currently being hosted on all instances
	// in the fleet.
	CurrentPlayerSessionCount *int64 `type:"integer"`

	// Unique identifier for a fleet.
	FleetId *string `type:"string"`

	// Maximum players allowed across all game sessions currently being hosted on
	// all instances in the fleet.
	MaximumPlayerSessionCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Current status of fleet utilization, including the number of game and player sessions being hosted.

func (FleetUtilization) GoString

func (s FleetUtilization) GoString() string

GoString returns the string representation

func (*FleetUtilization) SetActiveGameSessionCount added in v1.5.0

func (s *FleetUtilization) SetActiveGameSessionCount(v int64) *FleetUtilization

SetActiveGameSessionCount sets the ActiveGameSessionCount field's value.

func (*FleetUtilization) SetActiveServerProcessCount added in v1.5.0

func (s *FleetUtilization) SetActiveServerProcessCount(v int64) *FleetUtilization

SetActiveServerProcessCount sets the ActiveServerProcessCount field's value.

func (*FleetUtilization) SetCurrentPlayerSessionCount added in v1.5.0

func (s *FleetUtilization) SetCurrentPlayerSessionCount(v int64) *FleetUtilization

SetCurrentPlayerSessionCount sets the CurrentPlayerSessionCount field's value.

func (*FleetUtilization) SetFleetId added in v1.5.0

func (s *FleetUtilization) SetFleetId(v string) *FleetUtilization

SetFleetId sets the FleetId field's value.

func (*FleetUtilization) SetMaximumPlayerSessionCount added in v1.5.0

func (s *FleetUtilization) SetMaximumPlayerSessionCount(v int64) *FleetUtilization

SetMaximumPlayerSessionCount sets the MaximumPlayerSessionCount field's value.

func (FleetUtilization) String

func (s FleetUtilization) String() string

String returns the string representation

type GameLift

type GameLift struct {
	*client.Client
}

Welcome to the Amazon GameLift API Reference. Amazon GameLift is a managed Amazon Web Services (AWS) service for developers who need a scalable, server-based solution for multiplayer games. Amazon GameLift provides setup and deployment of game servers, and handles infrastructure scaling and session management.

This reference describes the low-level service API for GameLift. You can call this API directly or use the AWS SDK (http://aws.amazon.com/tools/#sdk) for your preferred language. The AWS SDK includes a set of high-level GameLift actions multiplayer game sessions. Alternatively, you can use the AWS command-line interface (http://aws.amazon.com/cli/) (CLI) tool, which includes commands for GameLift. For administrative actions, you can also use the Amazon GameLift console.

More Resources

Manage Games and Players Through GameLift

Call these actions from your game clients and/or services to create and manage multiplayer game sessions and player sessions.

  • Game sessions:

CreateGameSession

DescribeGameSessions

DescribeGameSessionDetails

UpdateGameSession

SearchGameSessions

  • Player sessions:

CreatePlayerSession

CreatePlayerSessions

DescribePlayerSessions

  • Other actions:

GetGameSessionLogUrl

Set Up and Manage Game Servers

Use these administrative actions to configure GameLift to host your game servers. When setting up GameLift, you will need to (1) configure a build for your game and upload build files, and (2) set up one or more fleets to host game sessions. Once you've created and activated a fleet, you can assign aliases to it, scale capacity, track performance and utilization, etc.

  • Game builds:

ListBuilds

CreateBuild

DescribeBuild

UpdateBuild

DeleteBuild

RequestUploadCredentials

  • Fleets:

ListFleets

CreateFleet

Describe fleets:

DescribeFleetAttributes

DescribeFleetCapacity

DescribeFleetPortSettings

DescribeFleetUtilization

DescribeEC2InstanceLimits

DescribeFleetEvents

DescribeRuntimeConfiguration

Update fleets:

UpdateFleetAttributes

UpdateFleetCapacity

UpdateFleetPortSettings

UpdateRuntimeConfiguration

DeleteFleet

  • Manage your instances:

DescribeInstances

GetInstanceAccess

  • Manage fleet aliases:

ListAliases

CreateAlias

DescribeAlias

UpdateAlias

DeleteAlias

ResolveAlias

  • Manage autoscaling:

PutScalingPolicy

DescribeScalingPolicies

DeleteScalingPolicy

To view changes to the API, see the GameLift Document History (http://docs.aws.amazon.com/gamelift/latest/developerguide/doc-history.html) page. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *GameLift

New creates a new instance of the GameLift client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a GameLift client from just a session.
svc := gamelift.New(mySession)

// Create a GameLift client with additional configuration
svc := gamelift.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*GameLift) CreateAlias

func (c *GameLift) CreateAlias(input *CreateAliasInput) (*CreateAliasOutput, error)

CreateAlias API operation for Amazon GameLift.

Creates an alias for a fleet. You can use an alias to anonymize your fleet by referencing an alias instead of a specific fleet when you create game sessions. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. Use a simple alias to point to an active fleet. Use a terminal alias to display a message to incoming traffic instead of routing players to an active fleet. This option is useful when a game server is no longer supported but you want to provide better messaging than a standard 404 error.

To create a fleet alias, specify an alias name, routing strategy, and optional description. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation CreateAlias for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.CreateAliasInput{
		Name: aws.String("NonBlankAndLengthConstraintString"), // Required
		RoutingStrategy: &gamelift.RoutingStrategy{ // Required
			FleetId: aws.String("FleetId"),
			Message: aws.String("FreeText"),
			Type:    aws.String("RoutingStrategyType"),
		},
		Description: aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.CreateAlias(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) CreateAliasRequest

func (c *GameLift) CreateAliasRequest(input *CreateAliasInput) (req *request.Request, output *CreateAliasOutput)

CreateAliasRequest generates a "aws/request.Request" representing the client's request for the CreateAlias operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateAlias for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateAlias method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateAliasRequest method.
req, resp := client.CreateAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) CreateBuild

func (c *GameLift) CreateBuild(input *CreateBuildInput) (*CreateBuildOutput, error)

CreateBuild API operation for Amazon GameLift.

Initializes a new build record and generates information required to upload a game build to Amazon GameLift. Once the build record has been created and its status is INITIALIZED, you can upload your game build.

Do not use this API action unless you are using your own Amazon Simple Storage Service (Amazon S3) client and need to manually upload your build files. Instead, to create a build, use the CLI command upload-build, which creates a new build record and uploads the build files in one step. (See the Amazon GameLift Developer Guide (http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) help on packaging and uploading your build.)

To create a new build, identify the operating system of the game server binaries. All game servers in a build must use the same operating system. Optionally, specify a build name and version; this metadata is stored with other properties in the build record and is displayed in the GameLift console (it is not visible to players). If successful, this action returns the newly created build record along with the Amazon S3 storage location and AWS account credentials. Use the location and credentials to upload your game build.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation CreateBuild for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.CreateBuildInput{
		Name:            aws.String("NonZeroAndMaxString"),
		OperatingSystem: aws.String("OperatingSystem"),
		StorageLocation: &gamelift.S3Location{
			Bucket:  aws.String("NonEmptyString"),
			Key:     aws.String("NonEmptyString"),
			RoleArn: aws.String("NonEmptyString"),
		},
		Version: aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.CreateBuild(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) CreateBuildRequest

func (c *GameLift) CreateBuildRequest(input *CreateBuildInput) (req *request.Request, output *CreateBuildOutput)

CreateBuildRequest generates a "aws/request.Request" representing the client's request for the CreateBuild operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateBuild for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateBuild method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateBuildRequest method.
req, resp := client.CreateBuildRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) CreateFleet

func (c *GameLift) CreateFleet(input *CreateFleetInput) (*CreateFleetOutput, error)

CreateFleet API operation for Amazon GameLift.

Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You configure a fleet to create instances with certain hardware specifications (see Amazon EC2 Instance Types (http://aws.amazon.com/ec2/instance-types/) for more information), and deploy a specified game build to each instance. A newly created fleet passes through several statuses; once it reaches the ACTIVE status, it can begin hosting game sessions.

To create a new fleet, provide a fleet name, an EC2 instance type, and a build ID of the game build to deploy. You can also configure the new fleet with the following settings: (1) a runtime configuration describing what server processes to run on each instance in the fleet (required to create fleet), (2) access permissions for inbound traffic, (3) fleet-wide game session protection, and (4) the location of default log files for GameLift to upload and store.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks:

  • Creates a fleet record and sets the status to NEW (followed by other statuses as the fleet is activated).

  • Sets the fleet's capacity to 1 "desired", which causes GameLift to start one new EC2 instance.

  • Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, GameLift staggers each launch by a few seconds.

  • Begins writing events to the fleet event log, which can be accessed in the GameLift console.

  • Sets the fleet's status to ACTIVE once one server process in the fleet is ready to host a game session.

After a fleet is created, use the following actions to change fleet properties and configuration:

  • UpdateFleetAttributes -- Update fleet metadata, including name and description.

  • UpdateFleetCapacity -- Increase or decrease the number of instances you want the fleet to maintain.

  • UpdateFleetPortSettings -- Change the IP address and port ranges that allow access to incoming traffic.

  • UpdateRuntimeConfiguration -- Change how server processes are launched in the fleet, including launch path, launch parameters, and the number of concurrent processes.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation CreateFleet for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

  • LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.CreateFleetInput{
		BuildId:         aws.String("BuildId"),             // Required
		EC2InstanceType: aws.String("EC2InstanceType"),     // Required
		Name:            aws.String("NonZeroAndMaxString"), // Required
		Description:     aws.String("NonZeroAndMaxString"),
		EC2InboundPermissions: []*gamelift.IpPermission{
			{ // Required
				FromPort: aws.Int64(1),                 // Required
				IpRange:  aws.String("NonBlankString"), // Required
				Protocol: aws.String("IpProtocol"),     // Required
				ToPort:   aws.Int64(1),                 // Required
			},
			// More values...
		},
		LogPaths: []*string{
			aws.String("NonZeroAndMaxString"), // Required
			// More values...
		},
		NewGameSessionProtectionPolicy: aws.String("ProtectionPolicy"),
		ResourceCreationLimitPolicy: &gamelift.ResourceCreationLimitPolicy{
			NewGameSessionsPerCreator: aws.Int64(1),
			PolicyPeriodInMinutes:     aws.Int64(1),
		},
		RuntimeConfiguration: &gamelift.RuntimeConfiguration{
			ServerProcesses: []*gamelift.ServerProcess{
				{ // Required
					ConcurrentExecutions: aws.Int64(1),                      // Required
					LaunchPath:           aws.String("NonZeroAndMaxString"), // Required
					Parameters:           aws.String("NonZeroAndMaxString"),
				},
				// More values...
			},
		},
		ServerLaunchParameters: aws.String("NonZeroAndMaxString"),
		ServerLaunchPath:       aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.CreateFleet(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) CreateFleetRequest

func (c *GameLift) CreateFleetRequest(input *CreateFleetInput) (req *request.Request, output *CreateFleetOutput)

CreateFleetRequest generates a "aws/request.Request" representing the client's request for the CreateFleet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateFleet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateFleet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateFleetRequest method.
req, resp := client.CreateFleetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) CreateGameSession

func (c *GameLift) CreateGameSession(input *CreateGameSessionInput) (*CreateGameSessionOutput, error)

CreateGameSession API operation for Amazon GameLift.

Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must be in an ACTIVE status before a game session can be created in it.

To create a game session, specify either fleet ID or alias ID, and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing session properties, including an IP address. By default, newly created game sessions allow new players to join. Use UpdateGameSession to change the game sessions player session creation policy.

When creating a game session on a fleet with a resource limit creation policy, the request should include a creator ID. If none is provided, GameLift does not evaluate the fleet's resource limit creation policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation CreateGameSession for usage and error information.

Returned Error Codes:

  • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidFleetStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

  • TerminalRoutingStrategyException The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • FleetCapacityExceededException The specified fleet has no available instances to fulfill a CreateGameSession request. Clients can retry such requests immediately or after a waiting period.

  • LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

  • IdempotentParameterMismatchException A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.CreateGameSessionInput{
		MaximumPlayerSessionCount: aws.Int64(1), // Required
		AliasId:                   aws.String("AliasId"),
		CreatorId:                 aws.String("NonZeroAndMaxString"),
		FleetId:                   aws.String("FleetId"),
		GameProperties: []*gamelift.GameProperty{
			{ // Required
				Key:   aws.String("GamePropertyKey"),   // Required
				Value: aws.String("GamePropertyValue"), // Required
			},
			// More values...
		},
		GameSessionId: aws.String("IdStringModel"),
		Name:          aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.CreateGameSession(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) CreateGameSessionRequest

func (c *GameLift) CreateGameSessionRequest(input *CreateGameSessionInput) (req *request.Request, output *CreateGameSessionOutput)

CreateGameSessionRequest generates a "aws/request.Request" representing the client's request for the CreateGameSession operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateGameSession for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateGameSession method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateGameSessionRequest method.
req, resp := client.CreateGameSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) CreatePlayerSession

func (c *GameLift) CreatePlayerSession(input *CreatePlayerSessionInput) (*CreatePlayerSessionOutput, error)

CreatePlayerSession API operation for Amazon GameLift.

Adds a player to a game session and creates a player session record. A game session must be in an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.

To create a player session, specify a game session ID and player ID. If successful, the player is added to the game session and a new PlayerSession object is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation CreatePlayerSession for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidGameSessionStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

  • GameSessionFullException The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.

  • TerminalRoutingStrategyException The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.CreatePlayerSessionInput{
		GameSessionId: aws.String("ArnStringModel"),      // Required
		PlayerId:      aws.String("NonZeroAndMaxString"), // Required
	}
	resp, err := svc.CreatePlayerSession(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) CreatePlayerSessionRequest

func (c *GameLift) CreatePlayerSessionRequest(input *CreatePlayerSessionInput) (req *request.Request, output *CreatePlayerSessionOutput)

CreatePlayerSessionRequest generates a "aws/request.Request" representing the client's request for the CreatePlayerSession operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreatePlayerSession for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreatePlayerSession method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreatePlayerSessionRequest method.
req, resp := client.CreatePlayerSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) CreatePlayerSessions

func (c *GameLift) CreatePlayerSessions(input *CreatePlayerSessionsInput) (*CreatePlayerSessionsOutput, error)

CreatePlayerSessions API operation for Amazon GameLift.

Adds a group of players to a game session. Similar to CreatePlayerSession, this action allows you to add multiple players in a single call, which is useful for games that provide party and/or matchmaking features. A game session must be in an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.

To create player sessions, specify a game session ID and a list of player IDs. If successful, the players are added to the game session and a set of new PlayerSession objects is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation CreatePlayerSessions for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidGameSessionStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

  • GameSessionFullException The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.

  • TerminalRoutingStrategyException The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.CreatePlayerSessionsInput{
		GameSessionId: aws.String("ArnStringModel"), // Required
		PlayerIds: []*string{ // Required
			aws.String("NonZeroAndMaxString"), // Required
			// More values...
		},
	}
	resp, err := svc.CreatePlayerSessions(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) CreatePlayerSessionsRequest

func (c *GameLift) CreatePlayerSessionsRequest(input *CreatePlayerSessionsInput) (req *request.Request, output *CreatePlayerSessionsOutput)

CreatePlayerSessionsRequest generates a "aws/request.Request" representing the client's request for the CreatePlayerSessions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreatePlayerSessions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreatePlayerSessions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreatePlayerSessionsRequest method.
req, resp := client.CreatePlayerSessionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DeleteAlias

func (c *GameLift) DeleteAlias(input *DeleteAliasInput) (*DeleteAliasOutput, error)

DeleteAlias API operation for Amazon GameLift.

Deletes an alias. This action removes all record of the alias; game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DeleteAlias for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DeleteAliasInput{
		AliasId: aws.String("AliasId"), // Required
	}
	resp, err := svc.DeleteAlias(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DeleteAliasRequest

func (c *GameLift) DeleteAliasRequest(input *DeleteAliasInput) (req *request.Request, output *DeleteAliasOutput)

DeleteAliasRequest generates a "aws/request.Request" representing the client's request for the DeleteAlias operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteAlias for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteAlias method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteAliasRequest method.
req, resp := client.DeleteAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DeleteBuild

func (c *GameLift) DeleteBuild(input *DeleteBuildInput) (*DeleteBuildOutput, error)

DeleteBuild API operation for Amazon GameLift.

Deletes a build. This action permanently deletes the build record and any uploaded build files.

To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DeleteBuild for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DeleteBuildInput{
		BuildId: aws.String("BuildId"), // Required
	}
	resp, err := svc.DeleteBuild(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DeleteBuildRequest

func (c *GameLift) DeleteBuildRequest(input *DeleteBuildInput) (req *request.Request, output *DeleteBuildOutput)

DeleteBuildRequest generates a "aws/request.Request" representing the client's request for the DeleteBuild operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteBuild for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteBuild method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteBuildRequest method.
req, resp := client.DeleteBuildRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DeleteFleet

func (c *GameLift) DeleteFleet(input *DeleteFleetInput) (*DeleteFleetOutput, error)

DeleteFleet API operation for Amazon GameLift.

Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.

This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DeleteFleet for usage and error information.

Returned Error Codes:

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • InvalidFleetStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DeleteFleetInput{
		FleetId: aws.String("FleetId"), // Required
	}
	resp, err := svc.DeleteFleet(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DeleteFleetRequest

func (c *GameLift) DeleteFleetRequest(input *DeleteFleetInput) (req *request.Request, output *DeleteFleetOutput)

DeleteFleetRequest generates a "aws/request.Request" representing the client's request for the DeleteFleet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteFleet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteFleet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteFleetRequest method.
req, resp := client.DeleteFleetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DeleteScalingPolicy added in v1.1.10

func (c *GameLift) DeleteScalingPolicy(input *DeleteScalingPolicyInput) (*DeleteScalingPolicyOutput, error)

DeleteScalingPolicy API operation for Amazon GameLift.

Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DeleteScalingPolicy for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DeleteScalingPolicyInput{
		FleetId: aws.String("FleetId"),             // Required
		Name:    aws.String("NonZeroAndMaxString"), // Required
	}
	resp, err := svc.DeleteScalingPolicy(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DeleteScalingPolicyRequest added in v1.1.10

func (c *GameLift) DeleteScalingPolicyRequest(input *DeleteScalingPolicyInput) (req *request.Request, output *DeleteScalingPolicyOutput)

DeleteScalingPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteScalingPolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteScalingPolicy for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteScalingPolicy method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteScalingPolicyRequest method.
req, resp := client.DeleteScalingPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeAlias

func (c *GameLift) DescribeAlias(input *DescribeAliasInput) (*DescribeAliasOutput, error)

DescribeAlias API operation for Amazon GameLift.

Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeAlias for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeAliasInput{
		AliasId: aws.String("AliasId"), // Required
	}
	resp, err := svc.DescribeAlias(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeAliasRequest

func (c *GameLift) DescribeAliasRequest(input *DescribeAliasInput) (req *request.Request, output *DescribeAliasOutput)

DescribeAliasRequest generates a "aws/request.Request" representing the client's request for the DescribeAlias operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeAlias for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeAlias method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeAliasRequest method.
req, resp := client.DescribeAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeBuild

func (c *GameLift) DescribeBuild(input *DescribeBuildInput) (*DescribeBuildOutput, error)

DescribeBuild API operation for Amazon GameLift.

Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeBuild for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeBuildInput{
		BuildId: aws.String("BuildId"), // Required
	}
	resp, err := svc.DescribeBuild(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeBuildRequest

func (c *GameLift) DescribeBuildRequest(input *DescribeBuildInput) (req *request.Request, output *DescribeBuildOutput)

DescribeBuildRequest generates a "aws/request.Request" representing the client's request for the DescribeBuild operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeBuild for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeBuild method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeBuildRequest method.
req, resp := client.DescribeBuildRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeEC2InstanceLimits

func (c *GameLift) DescribeEC2InstanceLimits(input *DescribeEC2InstanceLimitsInput) (*DescribeEC2InstanceLimitsOutput, error)

DescribeEC2InstanceLimits API operation for Amazon GameLift.

Retrieves the following information for the specified EC2 instance type:

  • maximum number of instances allowed per AWS account (service limit)

  • current usage level for the AWS account

Service limits vary depending on region. Available regions for GameLift can be found in the AWS Management Console for GameLift (see the drop-down list in the upper right corner).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeEC2InstanceLimits for usage and error information.

Returned Error Codes:

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeEC2InstanceLimitsInput{
		EC2InstanceType: aws.String("EC2InstanceType"),
	}
	resp, err := svc.DescribeEC2InstanceLimits(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeEC2InstanceLimitsRequest

func (c *GameLift) DescribeEC2InstanceLimitsRequest(input *DescribeEC2InstanceLimitsInput) (req *request.Request, output *DescribeEC2InstanceLimitsOutput)

DescribeEC2InstanceLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeEC2InstanceLimits operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeEC2InstanceLimits for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeEC2InstanceLimits method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeEC2InstanceLimitsRequest method.
req, resp := client.DescribeEC2InstanceLimitsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeFleetAttributes

func (c *GameLift) DescribeFleetAttributes(input *DescribeFleetAttributesInput) (*DescribeFleetAttributesOutput, error)

DescribeFleetAttributes API operation for Amazon GameLift.

Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeFleetAttributes for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeFleetAttributesInput{
		FleetIds: []*string{
			aws.String("FleetId"), // Required
			// More values...
		},
		Limit:     aws.Int64(1),
		NextToken: aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.DescribeFleetAttributes(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeFleetAttributesRequest

func (c *GameLift) DescribeFleetAttributesRequest(input *DescribeFleetAttributesInput) (req *request.Request, output *DescribeFleetAttributesOutput)

DescribeFleetAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeFleetAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeFleetAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeFleetAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeFleetAttributesRequest method.
req, resp := client.DescribeFleetAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeFleetCapacity

func (c *GameLift) DescribeFleetCapacity(input *DescribeFleetCapacityInput) (*DescribeFleetCapacityOutput, error)

DescribeFleetCapacity API operation for Amazon GameLift.

Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeFleetCapacity for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeFleetCapacityInput{
		FleetIds: []*string{
			aws.String("FleetId"), // Required
			// More values...
		},
		Limit:     aws.Int64(1),
		NextToken: aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.DescribeFleetCapacity(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeFleetCapacityRequest

func (c *GameLift) DescribeFleetCapacityRequest(input *DescribeFleetCapacityInput) (req *request.Request, output *DescribeFleetCapacityOutput)

DescribeFleetCapacityRequest generates a "aws/request.Request" representing the client's request for the DescribeFleetCapacity operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeFleetCapacity for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeFleetCapacity method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeFleetCapacityRequest method.
req, resp := client.DescribeFleetCapacityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeFleetEvents

func (c *GameLift) DescribeFleetEvents(input *DescribeFleetEventsInput) (*DescribeFleetEventsOutput, error)

DescribeFleetEvents API operation for Amazon GameLift.

Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeFleetEvents for usage and error information.

Returned Error Codes:

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

Example
package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeFleetEventsInput{
		FleetId:   aws.String("FleetId"), // Required
		EndTime:   aws.Time(time.Now()),
		Limit:     aws.Int64(1),
		NextToken: aws.String("NonZeroAndMaxString"),
		StartTime: aws.Time(time.Now()),
	}
	resp, err := svc.DescribeFleetEvents(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeFleetEventsRequest

func (c *GameLift) DescribeFleetEventsRequest(input *DescribeFleetEventsInput) (req *request.Request, output *DescribeFleetEventsOutput)

DescribeFleetEventsRequest generates a "aws/request.Request" representing the client's request for the DescribeFleetEvents operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeFleetEvents for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeFleetEvents method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeFleetEventsRequest method.
req, resp := client.DescribeFleetEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeFleetPortSettings

func (c *GameLift) DescribeFleetPortSettings(input *DescribeFleetPortSettingsInput) (*DescribeFleetPortSettingsOutput, error)

DescribeFleetPortSettings API operation for Amazon GameLift.

Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeFleetPortSettings for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeFleetPortSettingsInput{
		FleetId: aws.String("FleetId"), // Required
	}
	resp, err := svc.DescribeFleetPortSettings(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeFleetPortSettingsRequest

func (c *GameLift) DescribeFleetPortSettingsRequest(input *DescribeFleetPortSettingsInput) (req *request.Request, output *DescribeFleetPortSettingsOutput)

DescribeFleetPortSettingsRequest generates a "aws/request.Request" representing the client's request for the DescribeFleetPortSettings operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeFleetPortSettings for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeFleetPortSettings method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeFleetPortSettingsRequest method.
req, resp := client.DescribeFleetPortSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeFleetUtilization

func (c *GameLift) DescribeFleetUtilization(input *DescribeFleetUtilizationInput) (*DescribeFleetUtilizationOutput, error)

DescribeFleetUtilization API operation for Amazon GameLift.

Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeFleetUtilization for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeFleetUtilizationInput{
		FleetIds: []*string{
			aws.String("FleetId"), // Required
			// More values...
		},
		Limit:     aws.Int64(1),
		NextToken: aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.DescribeFleetUtilization(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeFleetUtilizationRequest

func (c *GameLift) DescribeFleetUtilizationRequest(input *DescribeFleetUtilizationInput) (req *request.Request, output *DescribeFleetUtilizationOutput)

DescribeFleetUtilizationRequest generates a "aws/request.Request" representing the client's request for the DescribeFleetUtilization operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeFleetUtilization for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeFleetUtilization method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeFleetUtilizationRequest method.
req, resp := client.DescribeFleetUtilizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeGameSessionDetails added in v1.1.10

func (c *GameLift) DescribeGameSessionDetails(input *DescribeGameSessionDetailsInput) (*DescribeGameSessionDetailsOutput, error)

DescribeGameSessionDetails API operation for Amazon GameLift.

Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeGameSessionDetails for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • TerminalRoutingStrategyException The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeGameSessionDetailsInput{
		AliasId:       aws.String("AliasId"),
		FleetId:       aws.String("FleetId"),
		GameSessionId: aws.String("ArnStringModel"),
		Limit:         aws.Int64(1),
		NextToken:     aws.String("NonZeroAndMaxString"),
		StatusFilter:  aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.DescribeGameSessionDetails(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeGameSessionDetailsRequest added in v1.1.10

func (c *GameLift) DescribeGameSessionDetailsRequest(input *DescribeGameSessionDetailsInput) (req *request.Request, output *DescribeGameSessionDetailsOutput)

DescribeGameSessionDetailsRequest generates a "aws/request.Request" representing the client's request for the DescribeGameSessionDetails operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeGameSessionDetails for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeGameSessionDetails method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeGameSessionDetailsRequest method.
req, resp := client.DescribeGameSessionDetailsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeGameSessions

func (c *GameLift) DescribeGameSessions(input *DescribeGameSessionsInput) (*DescribeGameSessionsOutput, error)

DescribeGameSessions API operation for Amazon GameLift.

Retrieves a set of one or more game sessions and properties. This action can be used in several ways: (1) provide a GameSessionId to request properties for a specific game session; (2) provide a FleetId or an AliasId to request properties for all game sessions running on a fleet. You can also use SearchGameSessions, which allows you to retrieve all game sessions or filter on certain criteria, but only returns game sessions with a status of ACTIVE. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each session matching the request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeGameSessions for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • TerminalRoutingStrategyException The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeGameSessionsInput{
		AliasId:       aws.String("AliasId"),
		FleetId:       aws.String("FleetId"),
		GameSessionId: aws.String("ArnStringModel"),
		Limit:         aws.Int64(1),
		NextToken:     aws.String("NonZeroAndMaxString"),
		StatusFilter:  aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.DescribeGameSessions(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeGameSessionsRequest

func (c *GameLift) DescribeGameSessionsRequest(input *DescribeGameSessionsInput) (req *request.Request, output *DescribeGameSessionsOutput)

DescribeGameSessionsRequest generates a "aws/request.Request" representing the client's request for the DescribeGameSessions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeGameSessions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeGameSessions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeGameSessionsRequest method.
req, resp := client.DescribeGameSessionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeInstances added in v1.4.18

func (c *GameLift) DescribeInstances(input *DescribeInstancesInput) (*DescribeInstancesOutput, error)

DescribeInstances API operation for Amazon GameLift.

Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.

To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeInstances for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeInstancesInput{
		FleetId:    aws.String("FleetId"), // Required
		InstanceId: aws.String("InstanceId"),
		Limit:      aws.Int64(1),
		NextToken:  aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.DescribeInstances(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeInstancesRequest added in v1.4.18

func (c *GameLift) DescribeInstancesRequest(input *DescribeInstancesInput) (req *request.Request, output *DescribeInstancesOutput)

DescribeInstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeInstances operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeInstances for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeInstances method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeInstancesRequest method.
req, resp := client.DescribeInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribePlayerSessions

func (c *GameLift) DescribePlayerSessions(input *DescribePlayerSessionsInput) (*DescribePlayerSessionsOutput, error)

DescribePlayerSessions API operation for Amazon GameLift.

Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId parameter to request properties for a specific player session; (2) provide a GameSessionId parameter to request properties for all player sessions in the specified game session; (3) provide a PlayerId parameter to request properties for all player sessions of a specified player.

To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribePlayerSessions for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribePlayerSessionsInput{
		GameSessionId:             aws.String("ArnStringModel"),
		Limit:                     aws.Int64(1),
		NextToken:                 aws.String("NonZeroAndMaxString"),
		PlayerId:                  aws.String("NonZeroAndMaxString"),
		PlayerSessionId:           aws.String("PlayerSessionId"),
		PlayerSessionStatusFilter: aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.DescribePlayerSessions(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribePlayerSessionsRequest

func (c *GameLift) DescribePlayerSessionsRequest(input *DescribePlayerSessionsInput) (req *request.Request, output *DescribePlayerSessionsOutput)

DescribePlayerSessionsRequest generates a "aws/request.Request" representing the client's request for the DescribePlayerSessions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribePlayerSessions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribePlayerSessions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribePlayerSessionsRequest method.
req, resp := client.DescribePlayerSessionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeRuntimeConfiguration added in v1.2.1

func (c *GameLift) DescribeRuntimeConfiguration(input *DescribeRuntimeConfigurationInput) (*DescribeRuntimeConfigurationOutput, error)

DescribeRuntimeConfiguration API operation for Amazon GameLift.

Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells GameLift how to launch server processes on instances in the fleet.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeRuntimeConfiguration for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeRuntimeConfigurationInput{
		FleetId: aws.String("FleetId"), // Required
	}
	resp, err := svc.DescribeRuntimeConfiguration(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeRuntimeConfigurationRequest added in v1.2.1

func (c *GameLift) DescribeRuntimeConfigurationRequest(input *DescribeRuntimeConfigurationInput) (req *request.Request, output *DescribeRuntimeConfigurationOutput)

DescribeRuntimeConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeRuntimeConfiguration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeRuntimeConfiguration for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeRuntimeConfiguration method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeRuntimeConfigurationRequest method.
req, resp := client.DescribeRuntimeConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) DescribeScalingPolicies added in v1.1.10

func (c *GameLift) DescribeScalingPolicies(input *DescribeScalingPoliciesInput) (*DescribeScalingPoliciesOutput, error)

DescribeScalingPolicies API operation for Amazon GameLift.

Retrieves all scaling policies applied to a fleet.

To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation DescribeScalingPolicies for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.DescribeScalingPoliciesInput{
		FleetId:      aws.String("FleetId"), // Required
		Limit:        aws.Int64(1),
		NextToken:    aws.String("NonZeroAndMaxString"),
		StatusFilter: aws.String("ScalingStatusType"),
	}
	resp, err := svc.DescribeScalingPolicies(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) DescribeScalingPoliciesRequest added in v1.1.10

func (c *GameLift) DescribeScalingPoliciesRequest(input *DescribeScalingPoliciesInput) (req *request.Request, output *DescribeScalingPoliciesOutput)

DescribeScalingPoliciesRequest generates a "aws/request.Request" representing the client's request for the DescribeScalingPolicies operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeScalingPolicies for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeScalingPolicies method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeScalingPoliciesRequest method.
req, resp := client.DescribeScalingPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) GetGameSessionLogUrl

func (c *GameLift) GetGameSessionLogUrl(input *GetGameSessionLogUrlInput) (*GetGameSessionLogUrlOutput, error)

GetGameSessionLogUrl API operation for Amazon GameLift.

Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3. Use this URL to download the logs.

See the AWS Service Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift) page for maximum log file sizes. Log files that exceed this limit are not saved.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation GetGameSessionLogUrl for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.GetGameSessionLogUrlInput{
		GameSessionId: aws.String("ArnStringModel"), // Required
	}
	resp, err := svc.GetGameSessionLogUrl(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) GetGameSessionLogUrlRequest

func (c *GameLift) GetGameSessionLogUrlRequest(input *GetGameSessionLogUrlInput) (req *request.Request, output *GetGameSessionLogUrlOutput)

GetGameSessionLogUrlRequest generates a "aws/request.Request" representing the client's request for the GetGameSessionLogUrl operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetGameSessionLogUrl for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetGameSessionLogUrl method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the GetGameSessionLogUrlRequest method.
req, resp := client.GetGameSessionLogUrlRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) GetInstanceAccess added in v1.5.8

func (c *GameLift) GetInstanceAccess(input *GetInstanceAccessInput) (*GetInstanceAccessOutput, error)

GetInstanceAccess API operation for Amazon GameLift.

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time.

Access requires credentials that match the operating system of the instance. For a Windows instance, GameLift returns a username and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a username and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request (see the example later in this topic). For more information on remote access, see Remotely Accessing an Instance (http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-remote-access.html).

To request access to a specific instance, specify the IDs of the instance and the fleet it belongs to. If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation GetInstanceAccess for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.GetInstanceAccessInput{
		FleetId:    aws.String("FleetId"),    // Required
		InstanceId: aws.String("InstanceId"), // Required
	}
	resp, err := svc.GetInstanceAccess(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) GetInstanceAccessRequest added in v1.5.8

func (c *GameLift) GetInstanceAccessRequest(input *GetInstanceAccessInput) (req *request.Request, output *GetInstanceAccessOutput)

GetInstanceAccessRequest generates a "aws/request.Request" representing the client's request for the GetInstanceAccess operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetInstanceAccess for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetInstanceAccess method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the GetInstanceAccessRequest method.
req, resp := client.GetInstanceAccessRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) ListAliases

func (c *GameLift) ListAliases(input *ListAliasesInput) (*ListAliasesOutput, error)

ListAliases API operation for Amazon GameLift.

Retrieves a collection of alias records for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Aliases are not listed in any particular order.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation ListAliases for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.ListAliasesInput{
		Limit:               aws.Int64(1),
		Name:                aws.String("NonEmptyString"),
		NextToken:           aws.String("NonEmptyString"),
		RoutingStrategyType: aws.String("RoutingStrategyType"),
	}
	resp, err := svc.ListAliases(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) ListAliasesRequest

func (c *GameLift) ListAliasesRequest(input *ListAliasesInput) (req *request.Request, output *ListAliasesOutput)

ListAliasesRequest generates a "aws/request.Request" representing the client's request for the ListAliases operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListAliases for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListAliases method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListAliasesRequest method.
req, resp := client.ListAliasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) ListBuilds

func (c *GameLift) ListBuilds(input *ListBuildsInput) (*ListBuildsOutput, error)

ListBuilds API operation for Amazon GameLift.

Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build records are not listed in any particular order.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation ListBuilds for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.ListBuildsInput{
		Limit:     aws.Int64(1),
		NextToken: aws.String("NonEmptyString"),
		Status:    aws.String("BuildStatus"),
	}
	resp, err := svc.ListBuilds(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) ListBuildsRequest

func (c *GameLift) ListBuildsRequest(input *ListBuildsInput) (req *request.Request, output *ListBuildsOutput)

ListBuildsRequest generates a "aws/request.Request" representing the client's request for the ListBuilds operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListBuilds for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListBuilds method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListBuildsRequest method.
req, resp := client.ListBuildsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) ListFleets

func (c *GameLift) ListFleets(input *ListFleetsInput) (*ListFleetsOutput, error)

ListFleets API operation for Amazon GameLift.

Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.

Fleet records are not listed in any particular order.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation ListFleets for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.ListFleetsInput{
		BuildId:   aws.String("BuildId"),
		Limit:     aws.Int64(1),
		NextToken: aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.ListFleets(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) ListFleetsRequest

func (c *GameLift) ListFleetsRequest(input *ListFleetsInput) (req *request.Request, output *ListFleetsOutput)

ListFleetsRequest generates a "aws/request.Request" representing the client's request for the ListFleets operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListFleets for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListFleets method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListFleetsRequest method.
req, resp := client.ListFleetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) PutScalingPolicy added in v1.1.10

func (c *GameLift) PutScalingPolicy(input *PutScalingPolicyInput) (*PutScalingPolicyOutput, error)

PutScalingPolicy API operation for Amazon GameLift.

Creates or updates a scaling policy for a fleet. An active scaling policy prompts Amazon GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously.

A scaling policy rule statement has the following structure:

If [MetricName] is [ComparisonOperator][Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

For example, this policy: "If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances" could be implemented as the following rule statement:

If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation PutScalingPolicy for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.PutScalingPolicyInput{
		ComparisonOperator:    aws.String("ComparisonOperatorType"), // Required
		EvaluationPeriods:     aws.Int64(1),                         // Required
		FleetId:               aws.String("FleetId"),                // Required
		MetricName:            aws.String("MetricName"),             // Required
		Name:                  aws.String("NonZeroAndMaxString"),    // Required
		ScalingAdjustment:     aws.Int64(1),                         // Required
		ScalingAdjustmentType: aws.String("ScalingAdjustmentType"),  // Required
		Threshold:             aws.Float64(1.0),                     // Required
	}
	resp, err := svc.PutScalingPolicy(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) PutScalingPolicyRequest added in v1.1.10

func (c *GameLift) PutScalingPolicyRequest(input *PutScalingPolicyInput) (req *request.Request, output *PutScalingPolicyOutput)

PutScalingPolicyRequest generates a "aws/request.Request" representing the client's request for the PutScalingPolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See PutScalingPolicy for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutScalingPolicy method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the PutScalingPolicyRequest method.
req, resp := client.PutScalingPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) RequestUploadCredentials

func (c *GameLift) RequestUploadCredentials(input *RequestUploadCredentialsInput) (*RequestUploadCredentialsOutput, error)

RequestUploadCredentials API operation for Amazon GameLift.

Retrieves a fresh set of upload credentials and the assigned Amazon S3 storage location for a specific build. Valid credentials are required to upload your game build files to Amazon S3.

Call this action only if you need credentials for a build created withCreateBuild. This is a rare situation; in most cases, builds are created using the CLI command upload-build, which creates a build record and also uploads build files.

Upload credentials are returned when you create the build, but they have a limited lifespan. You can get fresh credentials and use them to re-upload game files until the status of that build changes to READY. Once this happens, you must create a brand new build.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation RequestUploadCredentials for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.RequestUploadCredentialsInput{
		BuildId: aws.String("BuildId"), // Required
	}
	resp, err := svc.RequestUploadCredentials(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) RequestUploadCredentialsRequest

func (c *GameLift) RequestUploadCredentialsRequest(input *RequestUploadCredentialsInput) (req *request.Request, output *RequestUploadCredentialsOutput)

RequestUploadCredentialsRequest generates a "aws/request.Request" representing the client's request for the RequestUploadCredentials operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See RequestUploadCredentials for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RequestUploadCredentials method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the RequestUploadCredentialsRequest method.
req, resp := client.RequestUploadCredentialsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) ResolveAlias

func (c *GameLift) ResolveAlias(input *ResolveAliasInput) (*ResolveAliasOutput, error)

ResolveAlias API operation for Amazon GameLift.

Retrieves the fleet ID that a specified alias is currently pointing to.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation ResolveAlias for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • TerminalRoutingStrategyException The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.ResolveAliasInput{
		AliasId: aws.String("AliasId"), // Required
	}
	resp, err := svc.ResolveAlias(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) ResolveAliasRequest

func (c *GameLift) ResolveAliasRequest(input *ResolveAliasInput) (req *request.Request, output *ResolveAliasOutput)

ResolveAliasRequest generates a "aws/request.Request" representing the client's request for the ResolveAlias operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ResolveAlias for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ResolveAlias method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ResolveAliasRequest method.
req, resp := client.ResolveAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) SearchGameSessions added in v1.3.1

func (c *GameLift) SearchGameSessions(input *SearchGameSessionsInput) (*SearchGameSessionsOutput, error)

SearchGameSessions API operation for Amazon GameLift.

Retrieves a set of game sessions that match a set of search criteria and sorts them in a specified order. Currently a game session search is limited to a single fleet. Search results include only game sessions that are in ACTIVE status. If you need to retrieve game sessions with a status other than active, use DescribeGameSessions. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails.

You can search or sort by the following game session attributes:

  • gameSessionId -- ID value assigned to a game session. This unique value is returned in a GameSession object when a new game session is created.

  • gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to a game session.

  • creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.

  • playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.

  • maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession.

  • hasAvailablePlayerSessions -- Boolean value indicating whether or not a game session has reached its maximum number of players. When searching with this attribute, the search value must be true or false. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.

To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of GameSession objects matching the request is returned.

Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation SearchGameSessions for usage and error information.

Returned Error Codes:

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • TerminalRoutingStrategyException The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.SearchGameSessionsInput{
		AliasId:          aws.String("AliasId"),
		FilterExpression: aws.String("NonZeroAndMaxString"),
		FleetId:          aws.String("FleetId"),
		Limit:            aws.Int64(1),
		NextToken:        aws.String("NonZeroAndMaxString"),
		SortExpression:   aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.SearchGameSessions(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) SearchGameSessionsRequest added in v1.3.1

func (c *GameLift) SearchGameSessionsRequest(input *SearchGameSessionsInput) (req *request.Request, output *SearchGameSessionsOutput)

SearchGameSessionsRequest generates a "aws/request.Request" representing the client's request for the SearchGameSessions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SearchGameSessions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SearchGameSessions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the SearchGameSessionsRequest method.
req, resp := client.SearchGameSessionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) UpdateAlias

func (c *GameLift) UpdateAlias(input *UpdateAliasInput) (*UpdateAliasOutput, error)

UpdateAlias API operation for Amazon GameLift.

Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation UpdateAlias for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.UpdateAliasInput{
		AliasId:     aws.String("AliasId"), // Required
		Description: aws.String("NonZeroAndMaxString"),
		Name:        aws.String("NonBlankAndLengthConstraintString"),
		RoutingStrategy: &gamelift.RoutingStrategy{
			FleetId: aws.String("FleetId"),
			Message: aws.String("FreeText"),
			Type:    aws.String("RoutingStrategyType"),
		},
	}
	resp, err := svc.UpdateAlias(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) UpdateAliasRequest

func (c *GameLift) UpdateAliasRequest(input *UpdateAliasInput) (req *request.Request, output *UpdateAliasOutput)

UpdateAliasRequest generates a "aws/request.Request" representing the client's request for the UpdateAlias operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateAlias for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateAlias method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateAliasRequest method.
req, resp := client.UpdateAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) UpdateBuild

func (c *GameLift) UpdateBuild(input *UpdateBuildInput) (*UpdateBuildOutput, error)

UpdateBuild API operation for Amazon GameLift.

Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation UpdateBuild for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.UpdateBuildInput{
		BuildId: aws.String("BuildId"), // Required
		Name:    aws.String("NonZeroAndMaxString"),
		Version: aws.String("NonZeroAndMaxString"),
	}
	resp, err := svc.UpdateBuild(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) UpdateBuildRequest

func (c *GameLift) UpdateBuildRequest(input *UpdateBuildInput) (req *request.Request, output *UpdateBuildOutput)

UpdateBuildRequest generates a "aws/request.Request" representing the client's request for the UpdateBuild operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateBuild for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateBuild method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateBuildRequest method.
req, resp := client.UpdateBuildRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) UpdateFleetAttributes

func (c *GameLift) UpdateFleetAttributes(input *UpdateFleetAttributesInput) (*UpdateFleetAttributesOutput, error)

UpdateFleetAttributes API operation for Amazon GameLift.

Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values you want to change. If successful, the fleet ID for the updated fleet is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation UpdateFleetAttributes for usage and error information.

Returned Error Codes:

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

  • InvalidFleetStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

  • LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.UpdateFleetAttributesInput{
		FleetId:                        aws.String("FleetId"), // Required
		Description:                    aws.String("NonZeroAndMaxString"),
		Name:                           aws.String("NonZeroAndMaxString"),
		NewGameSessionProtectionPolicy: aws.String("ProtectionPolicy"),
		ResourceCreationLimitPolicy: &gamelift.ResourceCreationLimitPolicy{
			NewGameSessionsPerCreator: aws.Int64(1),
			PolicyPeriodInMinutes:     aws.Int64(1),
		},
	}
	resp, err := svc.UpdateFleetAttributes(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) UpdateFleetAttributesRequest

func (c *GameLift) UpdateFleetAttributesRequest(input *UpdateFleetAttributesInput) (req *request.Request, output *UpdateFleetAttributesOutput)

UpdateFleetAttributesRequest generates a "aws/request.Request" representing the client's request for the UpdateFleetAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateFleetAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateFleetAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateFleetAttributesRequest method.
req, resp := client.UpdateFleetAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) UpdateFleetCapacity

func (c *GameLift) UpdateFleetCapacity(input *UpdateFleetCapacityInput) (*UpdateFleetCapacityOutput, error)

UpdateFleetCapacity API operation for Amazon GameLift.

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.

If you're using autoscaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift).

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the "Limit Exceeded" exception occurs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation UpdateFleetCapacity for usage and error information.

Returned Error Codes:

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

  • LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

  • InvalidFleetStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.UpdateFleetCapacityInput{
		FleetId:          aws.String("FleetId"), // Required
		DesiredInstances: aws.Int64(1),
		MaxSize:          aws.Int64(1),
		MinSize:          aws.Int64(1),
	}
	resp, err := svc.UpdateFleetCapacity(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) UpdateFleetCapacityRequest

func (c *GameLift) UpdateFleetCapacityRequest(input *UpdateFleetCapacityInput) (req *request.Request, output *UpdateFleetCapacityOutput)

UpdateFleetCapacityRequest generates a "aws/request.Request" representing the client's request for the UpdateFleetCapacity operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateFleetCapacity for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateFleetCapacity method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateFleetCapacityRequest method.
req, resp := client.UpdateFleetCapacityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) UpdateFleetPortSettings

func (c *GameLift) UpdateFleetPortSettings(input *UpdateFleetPortSettingsInput) (*UpdateFleetPortSettingsOutput, error)

UpdateFleetPortSettings API operation for Amazon GameLift.

Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation UpdateFleetPortSettings for usage and error information.

Returned Error Codes:

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

  • InvalidFleetStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

  • LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.UpdateFleetPortSettingsInput{
		FleetId: aws.String("FleetId"), // Required
		InboundPermissionAuthorizations: []*gamelift.IpPermission{
			{ // Required
				FromPort: aws.Int64(1),                 // Required
				IpRange:  aws.String("NonBlankString"), // Required
				Protocol: aws.String("IpProtocol"),     // Required
				ToPort:   aws.Int64(1),                 // Required
			},
			// More values...
		},
		InboundPermissionRevocations: []*gamelift.IpPermission{
			{ // Required
				FromPort: aws.Int64(1),                 // Required
				IpRange:  aws.String("NonBlankString"), // Required
				Protocol: aws.String("IpProtocol"),     // Required
				ToPort:   aws.Int64(1),                 // Required
			},
			// More values...
		},
	}
	resp, err := svc.UpdateFleetPortSettings(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) UpdateFleetPortSettingsRequest

func (c *GameLift) UpdateFleetPortSettingsRequest(input *UpdateFleetPortSettingsInput) (req *request.Request, output *UpdateFleetPortSettingsOutput)

UpdateFleetPortSettingsRequest generates a "aws/request.Request" representing the client's request for the UpdateFleetPortSettings operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateFleetPortSettings for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateFleetPortSettings method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateFleetPortSettingsRequest method.
req, resp := client.UpdateFleetPortSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) UpdateGameSession

func (c *GameLift) UpdateGameSession(input *UpdateGameSessionInput) (*UpdateGameSessionOutput, error)

UpdateGameSession API operation for Amazon GameLift.

Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation UpdateGameSession for usage and error information.

Returned Error Codes:

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • InvalidGameSessionStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.UpdateGameSessionInput{
		GameSessionId:               aws.String("ArnStringModel"), // Required
		MaximumPlayerSessionCount:   aws.Int64(1),
		Name:                        aws.String("NonZeroAndMaxString"),
		PlayerSessionCreationPolicy: aws.String("PlayerSessionCreationPolicy"),
		ProtectionPolicy:            aws.String("ProtectionPolicy"),
	}
	resp, err := svc.UpdateGameSession(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) UpdateGameSessionRequest

func (c *GameLift) UpdateGameSessionRequest(input *UpdateGameSessionInput) (req *request.Request, output *UpdateGameSessionOutput)

UpdateGameSessionRequest generates a "aws/request.Request" representing the client's request for the UpdateGameSession operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateGameSession for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateGameSession method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateGameSessionRequest method.
req, resp := client.UpdateGameSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*GameLift) UpdateRuntimeConfiguration added in v1.2.1

func (c *GameLift) UpdateRuntimeConfiguration(input *UpdateRuntimeConfigurationInput) (*UpdateRuntimeConfigurationOutput, error)

UpdateRuntimeConfiguration API operation for Amazon GameLift.

Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server processes on instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.

To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.

Each instance in a GameLift fleet checks regularly for an updated runtime configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while GameLift simply adds new server processes to fit the current runtime configuration. As a result, the runtime configuration changes are applied gradually as existing processes shut down and new processes are launched in GameLift's normal process recycling activity.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon GameLift's API operation UpdateRuntimeConfiguration for usage and error information.

Returned Error Codes:

  • UnauthorizedException The client failed authentication. Clients should not retry such requests.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

  • InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

  • InvalidFleetStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/gamelift"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := gamelift.New(sess)

	params := &gamelift.UpdateRuntimeConfigurationInput{
		FleetId: aws.String("FleetId"), // Required
		RuntimeConfiguration: &gamelift.RuntimeConfiguration{ // Required
			ServerProcesses: []*gamelift.ServerProcess{
				{ // Required
					ConcurrentExecutions: aws.Int64(1),                      // Required
					LaunchPath:           aws.String("NonZeroAndMaxString"), // Required
					Parameters:           aws.String("NonZeroAndMaxString"),
				},
				// More values...
			},
		},
	}
	resp, err := svc.UpdateRuntimeConfiguration(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*GameLift) UpdateRuntimeConfigurationRequest added in v1.2.1

func (c *GameLift) UpdateRuntimeConfigurationRequest(input *UpdateRuntimeConfigurationInput) (req *request.Request, output *UpdateRuntimeConfigurationOutput)

UpdateRuntimeConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateRuntimeConfiguration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateRuntimeConfiguration for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateRuntimeConfiguration method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateRuntimeConfigurationRequest method.
req, resp := client.UpdateRuntimeConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

type GameProperty

type GameProperty struct {

	// TBD
	//
	// Key is a required field
	Key *string `type:"string" required:"true"`

	// TBD
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Set of key-value pairs containing information a server process requires to set up a game session. This object allows you to pass in any set of data needed for your game. For more information, see the Amazon GameLift Developer Guide (http://docs.aws.amazon.com/gamelift/latest/developerguide/).

func (GameProperty) GoString

func (s GameProperty) GoString() string

GoString returns the string representation

func (*GameProperty) SetKey added in v1.5.0

func (s *GameProperty) SetKey(v string) *GameProperty

SetKey sets the Key field's value.

func (*GameProperty) SetValue added in v1.5.0

func (s *GameProperty) SetValue(v string) *GameProperty

SetValue sets the Value field's value.

func (GameProperty) String

func (s GameProperty) String() string

String returns the string representation

func (*GameProperty) Validate added in v1.1.21

func (s *GameProperty) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GameSession

type GameSession struct {

	// Time stamp indicating when this data object was created. Format is a number
	// expressed in Unix time as milliseconds (ex: "1469498468.057").
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Player ID of the person or entity that created the game session. This ID
	// is used to enforce a resource protection policy (if one exists) that limits
	// the number of concurrent active game sessions for a single player.
	CreatorId *string `min:"1" type:"string"`

	// Number of players currently in the game session.
	CurrentPlayerSessionCount *int64 `type:"integer"`

	// Unique identifier for a fleet.
	FleetId *string `type:"string"`

	// Set of custom properties for the game session.
	GameProperties []*GameProperty `type:"list"`

	// Unique identifier for a game session. Game session ID format is as follows:
	// "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The
	// value of <ID string> is either a custom ID string (if one was specified when
	// the game session was created) an autogenerated string.
	GameSessionId *string `min:"1" type:"string"`

	// IP address of the game session. To connect to a GameLift server process,
	// an app needs both the IP address and port number.
	IpAddress *string `type:"string"`

	// Maximum number of players allowed in the game session.
	MaximumPlayerSessionCount *int64 `type:"integer"`

	// Descriptive label associated with a game session. Session names do not need
	// to be unique.
	Name *string `min:"1" type:"string"`

	// Indicates whether or not the game session is accepting new players.
	PlayerSessionCreationPolicy *string `type:"string" enum:"PlayerSessionCreationPolicy"`

	// Port number for the game session. To connect to a GameLift server process,
	// an app needs both the IP address and port number.
	Port *int64 `min:"1" type:"integer"`

	// Current status of the game session. A game session must be in an ACTIVE status
	// to have player sessions.
	Status *string `type:"string" enum:"GameSessionStatus"`

	// Time stamp indicating when this data object was terminated. Format is a number
	// expressed in Unix time as milliseconds (ex: "1469498468.057").
	TerminationTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Properties describing a game session.

func (GameSession) GoString

func (s GameSession) GoString() string

GoString returns the string representation

func (*GameSession) SetCreationTime added in v1.5.0

func (s *GameSession) SetCreationTime(v time.Time) *GameSession

SetCreationTime sets the CreationTime field's value.

func (*GameSession) SetCreatorId added in v1.5.0

func (s *GameSession) SetCreatorId(v string) *GameSession

SetCreatorId sets the CreatorId field's value.

func (*GameSession) SetCurrentPlayerSessionCount added in v1.5.0

func (s *GameSession) SetCurrentPlayerSessionCount(v int64) *GameSession

SetCurrentPlayerSessionCount sets the CurrentPlayerSessionCount field's value.

func (*GameSession) SetFleetId added in v1.5.0

func (s *GameSession) SetFleetId(v string) *GameSession

SetFleetId sets the FleetId field's value.

func (*GameSession) SetGameProperties added in v1.5.0

func (s *GameSession) SetGameProperties(v []*GameProperty) *GameSession

SetGameProperties sets the GameProperties field's value.

func (*GameSession) SetGameSessionId added in v1.5.0

func (s *GameSession) SetGameSessionId(v string) *GameSession

SetGameSessionId sets the GameSessionId field's value.

func (*GameSession) SetIpAddress added in v1.5.0

func (s *GameSession) SetIpAddress(v string) *GameSession

SetIpAddress sets the IpAddress field's value.

func (*GameSession) SetMaximumPlayerSessionCount added in v1.5.0

func (s *GameSession) SetMaximumPlayerSessionCount(v int64) *GameSession

SetMaximumPlayerSessionCount sets the MaximumPlayerSessionCount field's value.

func (*GameSession) SetName added in v1.5.0

func (s *GameSession) SetName(v string) *GameSession

SetName sets the Name field's value.

func (*GameSession) SetPlayerSessionCreationPolicy added in v1.5.0

func (s *GameSession) SetPlayerSessionCreationPolicy(v string) *GameSession

SetPlayerSessionCreationPolicy sets the PlayerSessionCreationPolicy field's value.

func (*GameSession) SetPort added in v1.5.0

func (s *GameSession) SetPort(v int64) *GameSession

SetPort sets the Port field's value.

func (*GameSession) SetStatus added in v1.5.0

func (s *GameSession) SetStatus(v string) *GameSession

SetStatus sets the Status field's value.

func (*GameSession) SetTerminationTime added in v1.5.0

func (s *GameSession) SetTerminationTime(v time.Time) *GameSession

SetTerminationTime sets the TerminationTime field's value.

func (GameSession) String

func (s GameSession) String() string

String returns the string representation

type GameSessionDetail added in v1.1.10

type GameSessionDetail struct {

	// Properties describing a game session.
	GameSession *GameSession `type:"structure"`

	// Current status of protection for the game session.
	//
	//    * NoProtection – The game session can be terminated during a scale-down
	//    event.
	//
	//    * FullProtection – If the game session is in an ACTIVE status, it cannot
	//    be terminated during a scale-down event.
	ProtectionPolicy *string `type:"string" enum:"ProtectionPolicy"`
	// contains filtered or unexported fields
}

A game session's properties and the protection policy currently in force.

func (GameSessionDetail) GoString added in v1.1.10

func (s GameSessionDetail) GoString() string

GoString returns the string representation

func (*GameSessionDetail) SetGameSession added in v1.5.0

func (s *GameSessionDetail) SetGameSession(v *GameSession) *GameSessionDetail

SetGameSession sets the GameSession field's value.

func (*GameSessionDetail) SetProtectionPolicy added in v1.5.0

func (s *GameSessionDetail) SetProtectionPolicy(v string) *GameSessionDetail

SetProtectionPolicy sets the ProtectionPolicy field's value.

func (GameSessionDetail) String added in v1.1.10

func (s GameSessionDetail) String() string

String returns the string representation

type GetGameSessionLogUrlInput

type GetGameSessionLogUrlInput struct {

	// Unique identifier for the game session to get logs for. Game session ID format
	// is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID
	// string>". The value of <ID string> is either a custom ID string (if one was
	// specified when the game session was created) an autogenerated string.
	//
	// GameSessionId is a required field
	GameSessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (GetGameSessionLogUrlInput) GoString

func (s GetGameSessionLogUrlInput) GoString() string

GoString returns the string representation

func (*GetGameSessionLogUrlInput) SetGameSessionId added in v1.5.0

SetGameSessionId sets the GameSessionId field's value.

func (GetGameSessionLogUrlInput) String

func (s GetGameSessionLogUrlInput) String() string

String returns the string representation

func (*GetGameSessionLogUrlInput) Validate added in v1.1.21

func (s *GetGameSessionLogUrlInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetGameSessionLogUrlOutput

type GetGameSessionLogUrlOutput struct {

	// Location of the requested game session logs, available for download.
	PreSignedUrl *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (GetGameSessionLogUrlOutput) GoString

func (s GetGameSessionLogUrlOutput) GoString() string

GoString returns the string representation

func (*GetGameSessionLogUrlOutput) SetPreSignedUrl added in v1.5.0

SetPreSignedUrl sets the PreSignedUrl field's value.

func (GetGameSessionLogUrlOutput) String

String returns the string representation

type GetInstanceAccessInput added in v1.5.8

type GetInstanceAccessInput struct {

	// Unique identifier for a fleet. Specify the fleet that contain the instance
	// you want access to. The fleet can be in any of the following statuses: ACTIVATING,
	// ACTIVE, or ERROR. Fleets with an ERROR status can be accessed for a few hours
	// before being deleted.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Unique identifier for an instance. Specify the instance you want to get access
	// to. You can access an instance in any status.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInstanceAccessInput) GoString added in v1.5.8

func (s GetInstanceAccessInput) GoString() string

GoString returns the string representation

func (*GetInstanceAccessInput) SetFleetId added in v1.5.8

SetFleetId sets the FleetId field's value.

func (*GetInstanceAccessInput) SetInstanceId added in v1.5.8

SetInstanceId sets the InstanceId field's value.

func (GetInstanceAccessInput) String added in v1.5.8

func (s GetInstanceAccessInput) String() string

String returns the string representation

func (*GetInstanceAccessInput) Validate added in v1.5.8

func (s *GetInstanceAccessInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstanceAccessOutput added in v1.5.8

type GetInstanceAccessOutput struct {

	// Object containing connection information for a fleet instance, including
	// IP address and access credentials.
	InstanceAccess *InstanceAccess `type:"structure"`
	// contains filtered or unexported fields
}

func (GetInstanceAccessOutput) GoString added in v1.5.8

func (s GetInstanceAccessOutput) GoString() string

GoString returns the string representation

func (*GetInstanceAccessOutput) SetInstanceAccess added in v1.5.8

SetInstanceAccess sets the InstanceAccess field's value.

func (GetInstanceAccessOutput) String added in v1.5.8

func (s GetInstanceAccessOutput) String() string

String returns the string representation

type Instance added in v1.4.18

type Instance struct {

	// Time stamp indicating when this data object was created. Format is a number
	// expressed in Unix time as milliseconds (ex: "1469498468.057").
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Unique identifier for the fleet that the instance belongs to.
	FleetId *string `type:"string"`

	// Unique identifier for the instance.
	InstanceId *string `type:"string"`

	// IP address assigned to the instance.
	IpAddress *string `type:"string"`

	// Operating system that is running on this instance.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// Current status of the instance. Possible statuses include the following:
	//
	//    * PENDING – The instance is in the process of being created and launching
	//    server processes as defined in the fleet's runtime configuration.
	//
	//    * ACTIVE – The instance has been successfully created and at least one
	//    server process has successfully launched and reported back to GameLift
	//    that it is ready to host a game session. The instance is now considered
	//    ready to host game sessions.
	//
	//    * TERMINATING – The instance is in the process of shutting down. This
	//    may happen to reduce capacity during a scaling down event or to recycle
	//    resources in the event of a problem.
	Status *string `type:"string" enum:"InstanceStatus"`

	// EC2 instance type that defines the computing resources of this instance.
	Type *string `type:"string" enum:"EC2InstanceType"`
	// contains filtered or unexported fields
}

Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet contains zero or more instances.

func (Instance) GoString added in v1.4.18

func (s Instance) GoString() string

GoString returns the string representation

func (*Instance) SetCreationTime added in v1.5.0

func (s *Instance) SetCreationTime(v time.Time) *Instance

SetCreationTime sets the CreationTime field's value.

func (*Instance) SetFleetId added in v1.5.0

func (s *Instance) SetFleetId(v string) *Instance

SetFleetId sets the FleetId field's value.

func (*Instance) SetInstanceId added in v1.5.0

func (s *Instance) SetInstanceId(v string) *Instance

SetInstanceId sets the InstanceId field's value.

func (*Instance) SetIpAddress added in v1.5.0

func (s *Instance) SetIpAddress(v string) *Instance

SetIpAddress sets the IpAddress field's value.

func (*Instance) SetOperatingSystem added in v1.5.0

func (s *Instance) SetOperatingSystem(v string) *Instance

SetOperatingSystem sets the OperatingSystem field's value.

func (*Instance) SetStatus added in v1.5.0

func (s *Instance) SetStatus(v string) *Instance

SetStatus sets the Status field's value.

func (*Instance) SetType added in v1.5.0

func (s *Instance) SetType(v string) *Instance

SetType sets the Type field's value.

func (Instance) String added in v1.4.18

func (s Instance) String() string

String returns the string representation

type InstanceAccess added in v1.5.8

type InstanceAccess struct {

	// Credentials required to access the instance.
	Credentials *InstanceCredentials `type:"structure"`

	// Unique identifier for the fleet containing the instance being accessed.
	FleetId *string `type:"string"`

	// Unique identifier for the instance being accessed.
	InstanceId *string `type:"string"`

	// IP address assigned to the instance.
	IpAddress *string `type:"string"`

	// Operating system that is running on the instance.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`
	// contains filtered or unexported fields
}

Information required to remotely connect to a fleet instance. Access is requested by calling GetInstanceAccess.

func (InstanceAccess) GoString added in v1.5.8

func (s InstanceAccess) GoString() string

GoString returns the string representation

func (*InstanceAccess) SetCredentials added in v1.5.8

func (s *InstanceAccess) SetCredentials(v *InstanceCredentials) *InstanceAccess

SetCredentials sets the Credentials field's value.

func (*InstanceAccess) SetFleetId added in v1.5.8

func (s *InstanceAccess) SetFleetId(v string) *InstanceAccess

SetFleetId sets the FleetId field's value.

func (*InstanceAccess) SetInstanceId added in v1.5.8

func (s *InstanceAccess) SetInstanceId(v string) *InstanceAccess

SetInstanceId sets the InstanceId field's value.

func (*InstanceAccess) SetIpAddress added in v1.5.8

func (s *InstanceAccess) SetIpAddress(v string) *InstanceAccess

SetIpAddress sets the IpAddress field's value.

func (*InstanceAccess) SetOperatingSystem added in v1.5.8

func (s *InstanceAccess) SetOperatingSystem(v string) *InstanceAccess

SetOperatingSystem sets the OperatingSystem field's value.

func (InstanceAccess) String added in v1.5.8

func (s InstanceAccess) String() string

String returns the string representation

type InstanceCredentials added in v1.5.8

type InstanceCredentials struct {

	// Secret string. For Windows instances, the secret is a password. For Linux
	// instances, it is a private key.
	Secret *string `min:"1" type:"string"`

	// User login string.
	UserName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Set of credentials required to remotely access a fleet instance. Access credentials are requested by calling GetInstanceAccess and returned in an InstanceAccess object.

func (InstanceCredentials) GoString added in v1.5.8

func (s InstanceCredentials) GoString() string

GoString returns the string representation

func (*InstanceCredentials) SetSecret added in v1.5.8

SetSecret sets the Secret field's value.

func (*InstanceCredentials) SetUserName added in v1.5.8

func (s *InstanceCredentials) SetUserName(v string) *InstanceCredentials

SetUserName sets the UserName field's value.

func (InstanceCredentials) String added in v1.5.8

func (s InstanceCredentials) String() string

String returns the string representation

type IpPermission

type IpPermission struct {

	// Starting value for a range of allowed port numbers.
	//
	// FromPort is a required field
	FromPort *int64 `min:"1" type:"integer" required:"true"`

	// Range of allowed IP addresses. This value must be expressed in CIDR notation
	// (https://tools.ietf.org/id/cidr). Example: "000.000.000.000/[subnet mask]"
	// or optionally the shortened version "0.0.0.0/[subnet mask]".
	//
	// IpRange is a required field
	IpRange *string `type:"string" required:"true"`

	// Network communication protocol used by the fleet.
	//
	// Protocol is a required field
	Protocol *string `type:"string" required:"true" enum:"IpProtocol"`

	// Ending value for a range of allowed port numbers. Port numbers are end-inclusive.
	// This value must be higher than FromPort.
	//
	// ToPort is a required field
	ToPort *int64 `min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. This combination is included in the GameSession object.

func (IpPermission) GoString

func (s IpPermission) GoString() string

GoString returns the string representation

func (*IpPermission) SetFromPort added in v1.5.0

func (s *IpPermission) SetFromPort(v int64) *IpPermission

SetFromPort sets the FromPort field's value.

func (*IpPermission) SetIpRange added in v1.5.0

func (s *IpPermission) SetIpRange(v string) *IpPermission

SetIpRange sets the IpRange field's value.

func (*IpPermission) SetProtocol added in v1.5.0

func (s *IpPermission) SetProtocol(v string) *IpPermission

SetProtocol sets the Protocol field's value.

func (*IpPermission) SetToPort added in v1.5.0

func (s *IpPermission) SetToPort(v int64) *IpPermission

SetToPort sets the ToPort field's value.

func (IpPermission) String

func (s IpPermission) String() string

String returns the string representation

func (*IpPermission) Validate added in v1.1.21

func (s *IpPermission) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAliasesInput

type ListAliasesInput struct {

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit *int64 `min:"1" type:"integer"`

	// Descriptive label associated with an alias. Alias names do not need to be
	// unique.
	Name *string `min:"1" type:"string"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value.
	NextToken *string `min:"1" type:"string"`

	// Type of routing to filter results on. Use this parameter to retrieve only
	// aliases of a certain type. To retrieve all aliases, leave this parameter
	// empty.
	//
	// Possible routing types include the following:
	//
	//    * SIMPLE – The alias resolves to one specific fleet. Use this type when
	//    routing to active fleets.
	//
	//    * TERMINAL – The alias does not resolve to a fleet but instead can be
	//    used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException
	//    with the RoutingStrategy message embedded.
	RoutingStrategyType *string `type:"string" enum:"RoutingStrategyType"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (ListAliasesInput) GoString

func (s ListAliasesInput) GoString() string

GoString returns the string representation

func (*ListAliasesInput) SetLimit added in v1.5.0

func (s *ListAliasesInput) SetLimit(v int64) *ListAliasesInput

SetLimit sets the Limit field's value.

func (*ListAliasesInput) SetName added in v1.5.0

func (s *ListAliasesInput) SetName(v string) *ListAliasesInput

SetName sets the Name field's value.

func (*ListAliasesInput) SetNextToken added in v1.5.0

func (s *ListAliasesInput) SetNextToken(v string) *ListAliasesInput

SetNextToken sets the NextToken field's value.

func (*ListAliasesInput) SetRoutingStrategyType added in v1.5.0

func (s *ListAliasesInput) SetRoutingStrategyType(v string) *ListAliasesInput

SetRoutingStrategyType sets the RoutingStrategyType field's value.

func (ListAliasesInput) String

func (s ListAliasesInput) String() string

String returns the string representation

func (*ListAliasesInput) Validate added in v1.1.21

func (s *ListAliasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAliasesOutput

type ListAliasesOutput struct {

	// Collection of alias records that match the list request.
	Aliases []*Alias `type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (ListAliasesOutput) GoString

func (s ListAliasesOutput) GoString() string

GoString returns the string representation

func (*ListAliasesOutput) SetAliases added in v1.5.0

func (s *ListAliasesOutput) SetAliases(v []*Alias) *ListAliasesOutput

SetAliases sets the Aliases field's value.

func (*ListAliasesOutput) SetNextToken added in v1.5.0

func (s *ListAliasesOutput) SetNextToken(v string) *ListAliasesOutput

SetNextToken sets the NextToken field's value.

func (ListAliasesOutput) String

func (s ListAliasesOutput) String() string

String returns the string representation

type ListBuildsInput

type ListBuildsInput struct {

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value.
	NextToken *string `min:"1" type:"string"`

	// Build status to filter results by. To retrieve all builds, leave this parameter
	// empty.
	//
	// Possible build statuses include the following:
	//
	//    * INITIALIZED – A new build has been defined, but no files have been uploaded.
	//    You cannot create fleets for builds that are in this status. When a build
	//    is successfully created, the build status is set to this value.
	//
	//    * READY – The game build has been successfully uploaded. You can now create
	//    new fleets for this build.
	//
	//    * FAILED – The game build upload failed. You cannot create new fleets
	//    for this build.
	Status *string `type:"string" enum:"BuildStatus"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (ListBuildsInput) GoString

func (s ListBuildsInput) GoString() string

GoString returns the string representation

func (*ListBuildsInput) SetLimit added in v1.5.0

func (s *ListBuildsInput) SetLimit(v int64) *ListBuildsInput

SetLimit sets the Limit field's value.

func (*ListBuildsInput) SetNextToken added in v1.5.0

func (s *ListBuildsInput) SetNextToken(v string) *ListBuildsInput

SetNextToken sets the NextToken field's value.

func (*ListBuildsInput) SetStatus added in v1.5.0

func (s *ListBuildsInput) SetStatus(v string) *ListBuildsInput

SetStatus sets the Status field's value.

func (ListBuildsInput) String

func (s ListBuildsInput) String() string

String returns the string representation

func (*ListBuildsInput) Validate added in v1.1.21

func (s *ListBuildsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBuildsOutput

type ListBuildsOutput struct {

	// Collection of build records that match the request.
	Builds []*Build `type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (ListBuildsOutput) GoString

func (s ListBuildsOutput) GoString() string

GoString returns the string representation

func (*ListBuildsOutput) SetBuilds added in v1.5.0

func (s *ListBuildsOutput) SetBuilds(v []*Build) *ListBuildsOutput

SetBuilds sets the Builds field's value.

func (*ListBuildsOutput) SetNextToken added in v1.5.0

func (s *ListBuildsOutput) SetNextToken(v string) *ListBuildsOutput

SetNextToken sets the NextToken field's value.

func (ListBuildsOutput) String

func (s ListBuildsOutput) String() string

String returns the string representation

type ListFleetsInput

type ListFleetsInput struct {

	// Unique identifier of the build to return fleets for. Use this parameter to
	// return only fleets using the specified build. To retrieve all fleets, leave
	// this parameter empty.
	BuildId *string `type:"string"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (ListFleetsInput) GoString

func (s ListFleetsInput) GoString() string

GoString returns the string representation

func (*ListFleetsInput) SetBuildId added in v1.5.0

func (s *ListFleetsInput) SetBuildId(v string) *ListFleetsInput

SetBuildId sets the BuildId field's value.

func (*ListFleetsInput) SetLimit added in v1.5.0

func (s *ListFleetsInput) SetLimit(v int64) *ListFleetsInput

SetLimit sets the Limit field's value.

func (*ListFleetsInput) SetNextToken added in v1.5.0

func (s *ListFleetsInput) SetNextToken(v string) *ListFleetsInput

SetNextToken sets the NextToken field's value.

func (ListFleetsInput) String

func (s ListFleetsInput) String() string

String returns the string representation

func (*ListFleetsInput) Validate added in v1.1.21

func (s *ListFleetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFleetsOutput

type ListFleetsOutput struct {

	// Set of fleet IDs matching the list request. You can retrieve additional information
	// about all returned fleets by passing this result set to a call to DescribeFleetAttributes,
	// DescribeFleetCapacity, and DescribeFleetUtilization.
	FleetIds []*string `min:"1" type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (ListFleetsOutput) GoString

func (s ListFleetsOutput) GoString() string

GoString returns the string representation

func (*ListFleetsOutput) SetFleetIds added in v1.5.0

func (s *ListFleetsOutput) SetFleetIds(v []*string) *ListFleetsOutput

SetFleetIds sets the FleetIds field's value.

func (*ListFleetsOutput) SetNextToken added in v1.5.0

func (s *ListFleetsOutput) SetNextToken(v string) *ListFleetsOutput

SetNextToken sets the NextToken field's value.

func (ListFleetsOutput) String

func (s ListFleetsOutput) String() string

String returns the string representation

type PlayerSession

type PlayerSession struct {

	// Time stamp indicating when this data object was created. Format is a number
	// expressed in Unix time as milliseconds (ex: "1469498468.057").
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Unique identifier for a fleet.
	FleetId *string `type:"string"`

	// Unique identifier for the game session that the player session is connected
	// to.
	GameSessionId *string `min:"1" type:"string"`

	// Game session IP address. All player sessions reference the game session location.
	IpAddress *string `type:"string"`

	// Unique identifier for a player.
	PlayerId *string `min:"1" type:"string"`

	// Unique identifier for a player session.
	PlayerSessionId *string `type:"string"`

	// Port number for the game session. To connect to a GameLift server process,
	// an app needs both the IP address and port number.
	Port *int64 `min:"1" type:"integer"`

	// Current status of the player session.
	//
	// Possible player session statuses include the following:
	//
	//    * RESERVED – The player session request has been received, but the player
	//    has not yet connected to the server process and/or been validated.
	//
	//    * ACTIVE – The player has been validated by the server process and is
	//    currently connected.
	//
	//    * COMPLETED – The player connection has been dropped.
	//
	//    * TIMEDOUT – A player session request was received, but the player did
	//    not connect and/or was not validated within the time-out limit (60 seconds).
	Status *string `type:"string" enum:"PlayerSessionStatus"`

	// Time stamp indicating when this data object was terminated. Format is a number
	// expressed in Unix time as milliseconds (ex: "1469498468.057").
	TerminationTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Properties describing a player session.

func (PlayerSession) GoString

func (s PlayerSession) GoString() string

GoString returns the string representation

func (*PlayerSession) SetCreationTime added in v1.5.0

func (s *PlayerSession) SetCreationTime(v time.Time) *PlayerSession

SetCreationTime sets the CreationTime field's value.

func (*PlayerSession) SetFleetId added in v1.5.0

func (s *PlayerSession) SetFleetId(v string) *PlayerSession

SetFleetId sets the FleetId field's value.

func (*PlayerSession) SetGameSessionId added in v1.5.0

func (s *PlayerSession) SetGameSessionId(v string) *PlayerSession

SetGameSessionId sets the GameSessionId field's value.

func (*PlayerSession) SetIpAddress added in v1.5.0

func (s *PlayerSession) SetIpAddress(v string) *PlayerSession

SetIpAddress sets the IpAddress field's value.

func (*PlayerSession) SetPlayerId added in v1.5.0

func (s *PlayerSession) SetPlayerId(v string) *PlayerSession

SetPlayerId sets the PlayerId field's value.

func (*PlayerSession) SetPlayerSessionId added in v1.5.0

func (s *PlayerSession) SetPlayerSessionId(v string) *PlayerSession

SetPlayerSessionId sets the PlayerSessionId field's value.

func (*PlayerSession) SetPort added in v1.5.0

func (s *PlayerSession) SetPort(v int64) *PlayerSession

SetPort sets the Port field's value.

func (*PlayerSession) SetStatus added in v1.5.0

func (s *PlayerSession) SetStatus(v string) *PlayerSession

SetStatus sets the Status field's value.

func (*PlayerSession) SetTerminationTime added in v1.5.0

func (s *PlayerSession) SetTerminationTime(v time.Time) *PlayerSession

SetTerminationTime sets the TerminationTime field's value.

func (PlayerSession) String

func (s PlayerSession) String() string

String returns the string representation

type PutScalingPolicyInput added in v1.1.10

type PutScalingPolicyInput struct {

	// Comparison operator to use when measuring the metric against the threshold
	// value.
	//
	// ComparisonOperator is a required field
	ComparisonOperator *string `type:"string" required:"true" enum:"ComparisonOperatorType"`

	// Length of time (in minutes) the metric must be at or beyond the threshold
	// before a scaling event is triggered.
	//
	// EvaluationPeriods is a required field
	EvaluationPeriods *int64 `min:"1" type:"integer" required:"true"`

	// Unique identity for the fleet to scale with this policy.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
	//
	//    * ActivatingGameSessions – number of game sessions in the process of being
	//    created (game session status = ACTIVATING).
	//
	//    * ActiveGameSessions – number of game sessions currently running (game
	//    session status = ACTIVE).
	//
	//    * CurrentPlayerSessions – number of active or reserved player sessions
	//    (player session status = ACTIVE or RESERVED).
	//
	//    * AvailablePlayerSessions – number of player session slots currently available
	//    in active game sessions across the fleet, calculated by subtracting a
	//    game session's current player session count from its maximum player session
	//    count. This number includes game sessions that are not currently accepting
	//    players (game session PlayerSessionCreationPolicy = DENY_ALL).
	//
	//    * ActiveInstances – number of instances currently running a game session.
	//
	//    * IdleInstances – number of instances not currently running a game session.
	//
	// MetricName is a required field
	MetricName *string `type:"string" required:"true" enum:"MetricName"`

	// Descriptive label associated with a scaling policy. Policy names do not need
	// to be unique. A fleet can have only one scaling policy with the same name.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Amount of adjustment to make, based on the scaling adjustment type.
	//
	// ScalingAdjustment is a required field
	ScalingAdjustment *int64 `type:"integer" required:"true"`

	// Type of adjustment to make to a fleet's instance count (see FleetCapacity):
	//
	//    * ChangeInCapacity – add (or subtract) the scaling adjustment value from
	//    the current instance count. Positive values scale up while negative values
	//    scale down.
	//
	//    * ExactCapacity – set the instance count to the scaling adjustment value.
	//
	//    * PercentChangeInCapacity – increase or reduce the current instance count
	//    by the scaling adjustment, read as a percentage. Positive values scale
	//    up while negative values scale down; for example, a value of "-10" scales
	//    the fleet down by 10%.
	//
	// ScalingAdjustmentType is a required field
	ScalingAdjustmentType *string `type:"string" required:"true" enum:"ScalingAdjustmentType"`

	// Metric value used to trigger a scaling event.
	//
	// Threshold is a required field
	Threshold *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (PutScalingPolicyInput) GoString added in v1.1.10

func (s PutScalingPolicyInput) GoString() string

GoString returns the string representation

func (*PutScalingPolicyInput) SetComparisonOperator added in v1.5.0

func (s *PutScalingPolicyInput) SetComparisonOperator(v string) *PutScalingPolicyInput

SetComparisonOperator sets the ComparisonOperator field's value.

func (*PutScalingPolicyInput) SetEvaluationPeriods added in v1.5.0

func (s *PutScalingPolicyInput) SetEvaluationPeriods(v int64) *PutScalingPolicyInput

SetEvaluationPeriods sets the EvaluationPeriods field's value.

func (*PutScalingPolicyInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*PutScalingPolicyInput) SetMetricName added in v1.5.0

func (s *PutScalingPolicyInput) SetMetricName(v string) *PutScalingPolicyInput

SetMetricName sets the MetricName field's value.

func (*PutScalingPolicyInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*PutScalingPolicyInput) SetScalingAdjustment added in v1.5.0

func (s *PutScalingPolicyInput) SetScalingAdjustment(v int64) *PutScalingPolicyInput

SetScalingAdjustment sets the ScalingAdjustment field's value.

func (*PutScalingPolicyInput) SetScalingAdjustmentType added in v1.5.0

func (s *PutScalingPolicyInput) SetScalingAdjustmentType(v string) *PutScalingPolicyInput

SetScalingAdjustmentType sets the ScalingAdjustmentType field's value.

func (*PutScalingPolicyInput) SetThreshold added in v1.5.0

SetThreshold sets the Threshold field's value.

func (PutScalingPolicyInput) String added in v1.1.10

func (s PutScalingPolicyInput) String() string

String returns the string representation

func (*PutScalingPolicyInput) Validate added in v1.1.21

func (s *PutScalingPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutScalingPolicyOutput added in v1.1.10

type PutScalingPolicyOutput struct {

	// Descriptive label associated with a scaling policy. Policy names do not need
	// to be unique.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (PutScalingPolicyOutput) GoString added in v1.1.10

func (s PutScalingPolicyOutput) GoString() string

GoString returns the string representation

func (*PutScalingPolicyOutput) SetName added in v1.5.0

SetName sets the Name field's value.

func (PutScalingPolicyOutput) String added in v1.1.10

func (s PutScalingPolicyOutput) String() string

String returns the string representation

type RequestUploadCredentialsInput

type RequestUploadCredentialsInput struct {

	// Unique identifier for the build you want to get credentials for.
	//
	// BuildId is a required field
	BuildId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (RequestUploadCredentialsInput) GoString

GoString returns the string representation

func (*RequestUploadCredentialsInput) SetBuildId added in v1.5.0

SetBuildId sets the BuildId field's value.

func (RequestUploadCredentialsInput) String

String returns the string representation

func (*RequestUploadCredentialsInput) Validate added in v1.1.21

func (s *RequestUploadCredentialsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RequestUploadCredentialsOutput

type RequestUploadCredentialsOutput struct {

	// Amazon S3 path and key, identifying where the game build files are stored.
	StorageLocation *S3Location `type:"structure"`

	// AWS credentials required when uploading a game build to the storage location.
	// These credentials have a limited lifespan and are valid only for the build
	// they were issued for.
	UploadCredentials *AwsCredentials `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (RequestUploadCredentialsOutput) GoString

GoString returns the string representation

func (*RequestUploadCredentialsOutput) SetStorageLocation added in v1.5.0

SetStorageLocation sets the StorageLocation field's value.

func (*RequestUploadCredentialsOutput) SetUploadCredentials added in v1.5.0

SetUploadCredentials sets the UploadCredentials field's value.

func (RequestUploadCredentialsOutput) String

String returns the string representation

type ResolveAliasInput

type ResolveAliasInput struct {

	// Unique identifier for the alias you want to resolve.
	//
	// AliasId is a required field
	AliasId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (ResolveAliasInput) GoString

func (s ResolveAliasInput) GoString() string

GoString returns the string representation

func (*ResolveAliasInput) SetAliasId added in v1.5.0

func (s *ResolveAliasInput) SetAliasId(v string) *ResolveAliasInput

SetAliasId sets the AliasId field's value.

func (ResolveAliasInput) String

func (s ResolveAliasInput) String() string

String returns the string representation

func (*ResolveAliasInput) Validate added in v1.1.21

func (s *ResolveAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResolveAliasOutput

type ResolveAliasOutput struct {

	// Fleet ID associated with the requested alias.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (ResolveAliasOutput) GoString

func (s ResolveAliasOutput) GoString() string

GoString returns the string representation

func (*ResolveAliasOutput) SetFleetId added in v1.5.0

func (s *ResolveAliasOutput) SetFleetId(v string) *ResolveAliasOutput

SetFleetId sets the FleetId field's value.

func (ResolveAliasOutput) String

func (s ResolveAliasOutput) String() string

String returns the string representation

type ResourceCreationLimitPolicy added in v1.4.18

type ResourceCreationLimitPolicy struct {

	// Maximum number of game sessions that an individual can create during the
	// policy period.
	NewGameSessionsPerCreator *int64 `type:"integer"`

	// Time span used in evaluating the resource creation limit policy.
	PolicyPeriodInMinutes *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".

The policy is evaluated when a player tries to create a new game session. For example, with a policy of 10 new game sessions and a time period of 60 minutes, on receiving a CreateGameSession request, GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

func (ResourceCreationLimitPolicy) GoString added in v1.4.18

func (s ResourceCreationLimitPolicy) GoString() string

GoString returns the string representation

func (*ResourceCreationLimitPolicy) SetNewGameSessionsPerCreator added in v1.5.0

func (s *ResourceCreationLimitPolicy) SetNewGameSessionsPerCreator(v int64) *ResourceCreationLimitPolicy

SetNewGameSessionsPerCreator sets the NewGameSessionsPerCreator field's value.

func (*ResourceCreationLimitPolicy) SetPolicyPeriodInMinutes added in v1.5.0

func (s *ResourceCreationLimitPolicy) SetPolicyPeriodInMinutes(v int64) *ResourceCreationLimitPolicy

SetPolicyPeriodInMinutes sets the PolicyPeriodInMinutes field's value.

func (ResourceCreationLimitPolicy) String added in v1.4.18

String returns the string representation

type RoutingStrategy

type RoutingStrategy struct {

	// Unique identifier for a fleet.
	FleetId *string `type:"string"`

	// Message text to be used with a terminal routing strategy.
	Message *string `type:"string"`

	// Type of routing strategy.
	//
	// Possible routing types include the following:
	//
	//    * SIMPLE – The alias resolves to one specific fleet. Use this type when
	//    routing to active fleets.
	//
	//    * TERMINAL – The alias does not resolve to a fleet but instead can be
	//    used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException
	//    with the RoutingStrategy message embedded.
	Type *string `type:"string" enum:"RoutingStrategyType"`
	// contains filtered or unexported fields
}

Routing configuration for a fleet alias.

func (RoutingStrategy) GoString

func (s RoutingStrategy) GoString() string

GoString returns the string representation

func (*RoutingStrategy) SetFleetId added in v1.5.0

func (s *RoutingStrategy) SetFleetId(v string) *RoutingStrategy

SetFleetId sets the FleetId field's value.

func (*RoutingStrategy) SetMessage added in v1.5.0

func (s *RoutingStrategy) SetMessage(v string) *RoutingStrategy

SetMessage sets the Message field's value.

func (*RoutingStrategy) SetType added in v1.5.0

func (s *RoutingStrategy) SetType(v string) *RoutingStrategy

SetType sets the Type field's value.

func (RoutingStrategy) String

func (s RoutingStrategy) String() string

String returns the string representation

type RuntimeConfiguration added in v1.2.1

type RuntimeConfiguration struct {

	// Collection of server process configurations describing what server processes
	// to run on each instance in a fleet
	ServerProcesses []*ServerProcess `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Collection of server process configurations that describe what processes should be run on each instance in a fleet. An instance can launch and maintain multiple server processes based on the runtime configuration; it regularly checks for an updated runtime configuration and starts new server processes to match the latest version.

The key purpose of a runtime configuration with multiple server process configurations is to be able to run more than one kind of game server in a single fleet. You can include configurations for more than one server executable in order to run two or more different programs to run on the same instance. This option might be useful, for example, to run more than one version of your game server on the same fleet. Another option is to specify configurations for the same server executable but with different launch parameters.

A GameLift instance is limited to 50 processes running simultaneously. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration.

func (RuntimeConfiguration) GoString added in v1.2.1

func (s RuntimeConfiguration) GoString() string

GoString returns the string representation

func (*RuntimeConfiguration) SetServerProcesses added in v1.5.0

func (s *RuntimeConfiguration) SetServerProcesses(v []*ServerProcess) *RuntimeConfiguration

SetServerProcesses sets the ServerProcesses field's value.

func (RuntimeConfiguration) String added in v1.2.1

func (s RuntimeConfiguration) String() string

String returns the string representation

func (*RuntimeConfiguration) Validate added in v1.2.1

func (s *RuntimeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3Location

type S3Location struct {

	// Amazon S3 bucket identifier.
	Bucket *string `min:"1" type:"string"`

	// Amazon S3 bucket key.
	Key *string `min:"1" type:"string"`

	// Amazon resource number for the cross-account access role that allows GameLift
	// access to the S3 bucket.
	RoleArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Location in Amazon Simple Storage Service (Amazon S3) where a build's files are stored. This location is assigned in response to a CreateBuild call, and is always in the same region as the service used to create the build. For more details see the Amazon S3 documentation (http://aws.amazon.com/documentation/s3/).

func (S3Location) GoString

func (s S3Location) GoString() string

GoString returns the string representation

func (*S3Location) SetBucket added in v1.5.0

func (s *S3Location) SetBucket(v string) *S3Location

SetBucket sets the Bucket field's value.

func (*S3Location) SetKey added in v1.5.0

func (s *S3Location) SetKey(v string) *S3Location

SetKey sets the Key field's value.

func (*S3Location) SetRoleArn added in v1.5.0

func (s *S3Location) SetRoleArn(v string) *S3Location

SetRoleArn sets the RoleArn field's value.

func (S3Location) String

func (s S3Location) String() string

String returns the string representation

func (*S3Location) Validate added in v1.1.21

func (s *S3Location) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ScalingPolicy added in v1.1.10

type ScalingPolicy struct {

	// Comparison operator to use when measuring a metric against the threshold
	// value.
	ComparisonOperator *string `type:"string" enum:"ComparisonOperatorType"`

	// Length of time (in minutes) the metric must be at or beyond the threshold
	// before a scaling event is triggered.
	EvaluationPeriods *int64 `min:"1" type:"integer"`

	// Unique identity for the fleet associated with this scaling policy.
	FleetId *string `type:"string"`

	// Name of the GameLift-defined metric that is used to trigger an adjustment.
	//
	//    * ActivatingGameSessions – number of game sessions in the process of being
	//    created (game session status = ACTIVATING).
	//
	//    * ActiveGameSessions – number of game sessions currently running (game
	//    session status = ACTIVE).
	//
	//    * CurrentPlayerSessions – number of active or reserved player sessions
	//    (player session status = ACTIVE or RESERVED).
	//
	//    * AvailablePlayerSessions – number of player session slots currently available
	//    in active game sessions across the fleet, calculated by subtracting a
	//    game session's current player session count from its maximum player session
	//    count. This number does include game sessions that are not currently accepting
	//    players (game session PlayerSessionCreationPolicy = DENY_ALL).
	//
	//    * ActiveInstances – number of instances currently running a game session.
	//
	//    * IdleInstances – number of instances not currently running a game session.
	MetricName *string `type:"string" enum:"MetricName"`

	// Descriptive label associated with a scaling policy. Policy names do not need
	// to be unique.
	Name *string `min:"1" type:"string"`

	// Amount of adjustment to make, based on the scaling adjustment type.
	ScalingAdjustment *int64 `type:"integer"`

	// Type of adjustment to make to a fleet's instance count (see FleetCapacity):
	//
	//    * ChangeInCapacity – add (or subtract) the scaling adjustment value from
	//    the current instance count. Positive values scale up while negative values
	//    scale down.
	//
	//    * ExactCapacity – set the instance count to the scaling adjustment value.
	//
	//    * PercentChangeInCapacity – increase or reduce the current instance count
	//    by the scaling adjustment, read as a percentage. Positive values scale
	//    up while negative values scale down.
	ScalingAdjustmentType *string `type:"string" enum:"ScalingAdjustmentType"`

	// Current status of the scaling policy. The scaling policy is only in force
	// when in an ACTIVE status.
	//
	//    * ACTIVE – The scaling policy is currently in force.
	//
	//    * UPDATE_REQUESTED – A request to update the scaling policy has been received.
	//
	//    * UPDATING – A change is being made to the scaling policy.
	//
	//    * DELETE_REQUESTED – A request to delete the scaling policy has been received.
	//
	//    * DELETING – The scaling policy is being deleted.
	//
	//    * DELETED – The scaling policy has been deleted.
	//
	//    * ERROR – An error occurred in creating the policy. It should be removed
	//    and recreated.
	Status *string `type:"string" enum:"ScalingStatusType"`

	// Metric value used to trigger a scaling event.
	Threshold *float64 `type:"double"`
	// contains filtered or unexported fields
}

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

func (ScalingPolicy) GoString added in v1.1.10

func (s ScalingPolicy) GoString() string

GoString returns the string representation

func (*ScalingPolicy) SetComparisonOperator added in v1.5.0

func (s *ScalingPolicy) SetComparisonOperator(v string) *ScalingPolicy

SetComparisonOperator sets the ComparisonOperator field's value.

func (*ScalingPolicy) SetEvaluationPeriods added in v1.5.0

func (s *ScalingPolicy) SetEvaluationPeriods(v int64) *ScalingPolicy

SetEvaluationPeriods sets the EvaluationPeriods field's value.

func (*ScalingPolicy) SetFleetId added in v1.5.0

func (s *ScalingPolicy) SetFleetId(v string) *ScalingPolicy

SetFleetId sets the FleetId field's value.

func (*ScalingPolicy) SetMetricName added in v1.5.0

func (s *ScalingPolicy) SetMetricName(v string) *ScalingPolicy

SetMetricName sets the MetricName field's value.

func (*ScalingPolicy) SetName added in v1.5.0

func (s *ScalingPolicy) SetName(v string) *ScalingPolicy

SetName sets the Name field's value.

func (*ScalingPolicy) SetScalingAdjustment added in v1.5.0

func (s *ScalingPolicy) SetScalingAdjustment(v int64) *ScalingPolicy

SetScalingAdjustment sets the ScalingAdjustment field's value.

func (*ScalingPolicy) SetScalingAdjustmentType added in v1.5.0

func (s *ScalingPolicy) SetScalingAdjustmentType(v string) *ScalingPolicy

SetScalingAdjustmentType sets the ScalingAdjustmentType field's value.

func (*ScalingPolicy) SetStatus added in v1.5.0

func (s *ScalingPolicy) SetStatus(v string) *ScalingPolicy

SetStatus sets the Status field's value.

func (*ScalingPolicy) SetThreshold added in v1.5.0

func (s *ScalingPolicy) SetThreshold(v float64) *ScalingPolicy

SetThreshold sets the Threshold field's value.

func (ScalingPolicy) String added in v1.1.10

func (s ScalingPolicy) String() string

String returns the string representation

type SearchGameSessionsInput added in v1.3.1

type SearchGameSessionsInput struct {

	// Unique identifier for a fleet alias. Each request must reference either a
	// fleet ID or alias ID, but not both.
	AliasId *string `type:"string"`

	// String containing the search criteria for the session search. If no filter
	// expression is included, the request returns results for all game sessions
	// in the fleet that are in ACTIVE status.
	//
	// A filter expression can contain one or multiple conditions. Each condition
	// consists of the following:
	//
	//    * Operand -- Name of a game session attribute. Valid values are gameSessionName,
	//    gameSessionId, creationTimeMillis, playerSessionCount, maximumSessions,
	//    hasAvailablePlayerSessions.
	//
	//    * Comparator -- Valid comparators are: =, <>, <, >, <=, >=.
	//
	//    * Value -- Value to be searched for. Values can be numbers, boolean values
	//    (true/false) or strings. String values are case sensitive, enclosed in
	//    single quotes. Special characters must be escaped. Boolean and string
	//    values can only be used with the comparators = and <>. For example, the
	//    following filter expression searches on gameSessionName: "FilterExpression":
	//    "gameSessionName = 'Matt\\'s Awesome Game 1'".
	//
	// To chain multiple conditions in a single expression, use the logical keywords
	// AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT
	// z, NOT (x OR y).
	//
	// Session search evaluates conditions from left to right using the following
	// precedence rules:
	//
	// =, <>, <, >, <=, >=
	//
	// Parentheses
	//
	// NOT
	//
	// AND
	//
	// OR
	//
	// For example, this filter expression retrieves game sessions hosting at least
	// ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".
	FilterExpression *string `min:"1" type:"string"`

	// Unique identifier for a fleet. Each request must reference either a fleet
	// ID or alias ID, but not both.
	FleetId *string `type:"string"`

	// Maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages. The maximum number of results returned
	// is 20, even if this value is not set or is set higher than 20.
	Limit *int64 `min:"1" type:"integer"`

	// Token indicating the start of the next sequential page of results. Use the
	// token that is returned with a previous call to this action. To specify the
	// start of the result set, do not specify a value.
	NextToken *string `min:"1" type:"string"`

	// Instructions on how to sort the search results. If no sort expression is
	// included, the request returns results in random order. A sort expression
	// consists of the following elements:
	//
	//    * Operand -- Name of a game session attribute. Valid values are gameSessionName,
	//    gameSessionId, creationTimeMillis, playerSessionCount, maximumSessions,
	//    hasAvailablePlayerSessions.
	//
	//    * Order -- Valid sort orders are ASC (ascending) and DESC (descending).
	//
	// For example, this sort expression returns the oldest active sessions first:
	// "SortExpression": "creationTimeMillis ASC". Results with a null value for
	// the sort operand are returned at the end of the list.
	SortExpression *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (SearchGameSessionsInput) GoString added in v1.3.1

func (s SearchGameSessionsInput) GoString() string

GoString returns the string representation

func (*SearchGameSessionsInput) SetAliasId added in v1.5.0

SetAliasId sets the AliasId field's value.

func (*SearchGameSessionsInput) SetFilterExpression added in v1.5.0

func (s *SearchGameSessionsInput) SetFilterExpression(v string) *SearchGameSessionsInput

SetFilterExpression sets the FilterExpression field's value.

func (*SearchGameSessionsInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*SearchGameSessionsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*SearchGameSessionsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*SearchGameSessionsInput) SetSortExpression added in v1.5.0

func (s *SearchGameSessionsInput) SetSortExpression(v string) *SearchGameSessionsInput

SetSortExpression sets the SortExpression field's value.

func (SearchGameSessionsInput) String added in v1.3.1

func (s SearchGameSessionsInput) String() string

String returns the string representation

func (*SearchGameSessionsInput) Validate added in v1.3.1

func (s *SearchGameSessionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchGameSessionsOutput added in v1.3.1

type SearchGameSessionsOutput struct {

	// Collection of objects containing game session properties for each session
	// matching the request.
	GameSessions []*GameSession `type:"list"`

	// Token indicating where to resume retrieving results on the next call to this
	// action. If no token is returned, these results represent the end of the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (SearchGameSessionsOutput) GoString added in v1.3.1

func (s SearchGameSessionsOutput) GoString() string

GoString returns the string representation

func (*SearchGameSessionsOutput) SetGameSessions added in v1.5.0

SetGameSessions sets the GameSessions field's value.

func (*SearchGameSessionsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (SearchGameSessionsOutput) String added in v1.3.1

func (s SearchGameSessionsOutput) String() string

String returns the string representation

type ServerProcess added in v1.2.1

type ServerProcess struct {

	// Number of server processes using this configuration to run concurrently on
	// an instance.
	//
	// ConcurrentExecutions is a required field
	ConcurrentExecutions *int64 `min:"1" type:"integer" required:"true"`

	// Location of the server executable in a game build. All game builds are installed
	// on instances at the root : for Windows instances C:\game, and for Linux instances
	// /local/game. A Windows game build with an executable file located at MyGame\latest\server.exe
	// must have a launch path of "C:\game\MyGame\latest\server.exe". A Linux game
	// build with an executable file located at MyGame/latest/server.exe must have
	// a launch path of "/local/game/MyGame/latest/server.exe".
	//
	// LaunchPath is a required field
	LaunchPath *string `min:"1" type:"string" required:"true"`

	// Optional list of parameters to pass to the server executable on launch.
	Parameters *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration.

func (ServerProcess) GoString added in v1.2.1

func (s ServerProcess) GoString() string

GoString returns the string representation

func (*ServerProcess) SetConcurrentExecutions added in v1.5.0

func (s *ServerProcess) SetConcurrentExecutions(v int64) *ServerProcess

SetConcurrentExecutions sets the ConcurrentExecutions field's value.

func (*ServerProcess) SetLaunchPath added in v1.5.0

func (s *ServerProcess) SetLaunchPath(v string) *ServerProcess

SetLaunchPath sets the LaunchPath field's value.

func (*ServerProcess) SetParameters added in v1.5.0

func (s *ServerProcess) SetParameters(v string) *ServerProcess

SetParameters sets the Parameters field's value.

func (ServerProcess) String added in v1.2.1

func (s ServerProcess) String() string

String returns the string representation

func (*ServerProcess) Validate added in v1.2.1

func (s *ServerProcess) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAliasInput

type UpdateAliasInput struct {

	// Unique identifier for a fleet alias. Specify the alias you want to update.
	//
	// AliasId is a required field
	AliasId *string `type:"string" required:"true"`

	// Human-readable description of an alias.
	Description *string `min:"1" type:"string"`

	// Descriptive label associated with an alias. Alias names do not need to be
	// unique.
	Name *string `min:"1" type:"string"`

	// Object specifying the fleet and routing type to use for the alias.
	RoutingStrategy *RoutingStrategy `type:"structure"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (UpdateAliasInput) GoString

func (s UpdateAliasInput) GoString() string

GoString returns the string representation

func (*UpdateAliasInput) SetAliasId added in v1.5.0

func (s *UpdateAliasInput) SetAliasId(v string) *UpdateAliasInput

SetAliasId sets the AliasId field's value.

func (*UpdateAliasInput) SetDescription added in v1.5.0

func (s *UpdateAliasInput) SetDescription(v string) *UpdateAliasInput

SetDescription sets the Description field's value.

func (*UpdateAliasInput) SetName added in v1.5.0

func (s *UpdateAliasInput) SetName(v string) *UpdateAliasInput

SetName sets the Name field's value.

func (*UpdateAliasInput) SetRoutingStrategy added in v1.5.0

func (s *UpdateAliasInput) SetRoutingStrategy(v *RoutingStrategy) *UpdateAliasInput

SetRoutingStrategy sets the RoutingStrategy field's value.

func (UpdateAliasInput) String

func (s UpdateAliasInput) String() string

String returns the string representation

func (*UpdateAliasInput) Validate added in v1.1.21

func (s *UpdateAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAliasOutput

type UpdateAliasOutput struct {

	// Object containing the updated alias configuration.
	Alias *Alias `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (UpdateAliasOutput) GoString

func (s UpdateAliasOutput) GoString() string

GoString returns the string representation

func (*UpdateAliasOutput) SetAlias added in v1.5.0

func (s *UpdateAliasOutput) SetAlias(v *Alias) *UpdateAliasOutput

SetAlias sets the Alias field's value.

func (UpdateAliasOutput) String

func (s UpdateAliasOutput) String() string

String returns the string representation

type UpdateBuildInput

type UpdateBuildInput struct {

	// Unique identifier of the build you want to update.
	//
	// BuildId is a required field
	BuildId *string `type:"string" required:"true"`

	// Descriptive label associated with a build. Build names do not need to be
	// unique.
	Name *string `min:"1" type:"string"`

	// Version associated with this build. Version strings do not need to be unique
	// to a build.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (UpdateBuildInput) GoString

func (s UpdateBuildInput) GoString() string

GoString returns the string representation

func (*UpdateBuildInput) SetBuildId added in v1.5.0

func (s *UpdateBuildInput) SetBuildId(v string) *UpdateBuildInput

SetBuildId sets the BuildId field's value.

func (*UpdateBuildInput) SetName added in v1.5.0

func (s *UpdateBuildInput) SetName(v string) *UpdateBuildInput

SetName sets the Name field's value.

func (*UpdateBuildInput) SetVersion added in v1.5.0

func (s *UpdateBuildInput) SetVersion(v string) *UpdateBuildInput

SetVersion sets the Version field's value.

func (UpdateBuildInput) String

func (s UpdateBuildInput) String() string

String returns the string representation

func (*UpdateBuildInput) Validate added in v1.1.21

func (s *UpdateBuildInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateBuildOutput

type UpdateBuildOutput struct {

	// Object containing the updated build record.
	Build *Build `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (UpdateBuildOutput) GoString

func (s UpdateBuildOutput) GoString() string

GoString returns the string representation

func (*UpdateBuildOutput) SetBuild added in v1.5.0

func (s *UpdateBuildOutput) SetBuild(v *Build) *UpdateBuildOutput

SetBuild sets the Build field's value.

func (UpdateBuildOutput) String

func (s UpdateBuildOutput) String() string

String returns the string representation

type UpdateFleetAttributesInput

type UpdateFleetAttributesInput struct {

	// Human-readable description of a fleet.
	Description *string `min:"1" type:"string"`

	// Unique identifier for the fleet you want to update attribute metadata for.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Descriptive label associated with a fleet. Fleet names do not need to be
	// unique.
	Name *string `min:"1" type:"string"`

	// Game session protection policy to apply to all new instances created in this
	// fleet. Instances that already exist are not affected. You can set protection
	// for individual instances using UpdateGameSession.
	//
	//    * NoProtection – The game session can be terminated during a scale-down
	//    event.
	//
	//    * FullProtection – If the game session is in an ACTIVE status, it cannot
	//    be terminated during a scale-down event.
	NewGameSessionProtectionPolicy *string `type:"string" enum:"ProtectionPolicy"`

	// Policy that limits the number of game sessions an individual player can create
	// over a span of time.
	ResourceCreationLimitPolicy *ResourceCreationLimitPolicy `type:"structure"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (UpdateFleetAttributesInput) GoString

func (s UpdateFleetAttributesInput) GoString() string

GoString returns the string representation

func (*UpdateFleetAttributesInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*UpdateFleetAttributesInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*UpdateFleetAttributesInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*UpdateFleetAttributesInput) SetNewGameSessionProtectionPolicy added in v1.5.0

func (s *UpdateFleetAttributesInput) SetNewGameSessionProtectionPolicy(v string) *UpdateFleetAttributesInput

SetNewGameSessionProtectionPolicy sets the NewGameSessionProtectionPolicy field's value.

func (*UpdateFleetAttributesInput) SetResourceCreationLimitPolicy added in v1.5.0

SetResourceCreationLimitPolicy sets the ResourceCreationLimitPolicy field's value.

func (UpdateFleetAttributesInput) String

String returns the string representation

func (*UpdateFleetAttributesInput) Validate added in v1.1.21

func (s *UpdateFleetAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFleetAttributesOutput

type UpdateFleetAttributesOutput struct {

	// Unique identifier for the updated fleet.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (UpdateFleetAttributesOutput) GoString

func (s UpdateFleetAttributesOutput) GoString() string

GoString returns the string representation

func (*UpdateFleetAttributesOutput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (UpdateFleetAttributesOutput) String

String returns the string representation

type UpdateFleetCapacityInput

type UpdateFleetCapacityInput struct {

	// Number of EC2 instances you want this fleet to host.
	DesiredInstances *int64 `type:"integer"`

	// Unique identifier for the fleet you want to update capacity for.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Maximum value allowed for the fleet's instance count. Default if not set
	// is 1.
	MaxSize *int64 `type:"integer"`

	// Minimum value allowed for the fleet's instance count. Default if not set
	// is 0.
	MinSize *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (UpdateFleetCapacityInput) GoString

func (s UpdateFleetCapacityInput) GoString() string

GoString returns the string representation

func (*UpdateFleetCapacityInput) SetDesiredInstances added in v1.5.0

func (s *UpdateFleetCapacityInput) SetDesiredInstances(v int64) *UpdateFleetCapacityInput

SetDesiredInstances sets the DesiredInstances field's value.

func (*UpdateFleetCapacityInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*UpdateFleetCapacityInput) SetMaxSize added in v1.5.0

SetMaxSize sets the MaxSize field's value.

func (*UpdateFleetCapacityInput) SetMinSize added in v1.5.0

SetMinSize sets the MinSize field's value.

func (UpdateFleetCapacityInput) String

func (s UpdateFleetCapacityInput) String() string

String returns the string representation

func (*UpdateFleetCapacityInput) Validate added in v1.1.21

func (s *UpdateFleetCapacityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFleetCapacityOutput

type UpdateFleetCapacityOutput struct {

	// Unique identifier for the updated fleet.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (UpdateFleetCapacityOutput) GoString

func (s UpdateFleetCapacityOutput) GoString() string

GoString returns the string representation

func (*UpdateFleetCapacityOutput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (UpdateFleetCapacityOutput) String

func (s UpdateFleetCapacityOutput) String() string

String returns the string representation

type UpdateFleetPortSettingsInput

type UpdateFleetPortSettingsInput struct {

	// Unique identifier for the fleet you want to update port settings for.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Collection of port settings to be added to the fleet record.
	InboundPermissionAuthorizations []*IpPermission `type:"list"`

	// Collection of port settings to be removed from the fleet record.
	InboundPermissionRevocations []*IpPermission `type:"list"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (UpdateFleetPortSettingsInput) GoString

func (s UpdateFleetPortSettingsInput) GoString() string

GoString returns the string representation

func (*UpdateFleetPortSettingsInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*UpdateFleetPortSettingsInput) SetInboundPermissionAuthorizations added in v1.5.0

func (s *UpdateFleetPortSettingsInput) SetInboundPermissionAuthorizations(v []*IpPermission) *UpdateFleetPortSettingsInput

SetInboundPermissionAuthorizations sets the InboundPermissionAuthorizations field's value.

func (*UpdateFleetPortSettingsInput) SetInboundPermissionRevocations added in v1.5.0

func (s *UpdateFleetPortSettingsInput) SetInboundPermissionRevocations(v []*IpPermission) *UpdateFleetPortSettingsInput

SetInboundPermissionRevocations sets the InboundPermissionRevocations field's value.

func (UpdateFleetPortSettingsInput) String

String returns the string representation

func (*UpdateFleetPortSettingsInput) Validate added in v1.1.21

func (s *UpdateFleetPortSettingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFleetPortSettingsOutput

type UpdateFleetPortSettingsOutput struct {

	// Unique identifier for the updated fleet.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (UpdateFleetPortSettingsOutput) GoString

GoString returns the string representation

func (*UpdateFleetPortSettingsOutput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (UpdateFleetPortSettingsOutput) String

String returns the string representation

type UpdateGameSessionInput

type UpdateGameSessionInput struct {

	// Unique identifier for the game session to update. Game session ID format
	// is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID
	// string>". The value of <ID string> is either a custom ID string (if one was
	// specified when the game session was created) an autogenerated string.
	//
	// GameSessionId is a required field
	GameSessionId *string `min:"1" type:"string" required:"true"`

	// Maximum number of players that can be simultaneously connected to the game
	// session.
	MaximumPlayerSessionCount *int64 `type:"integer"`

	// Descriptive label associated with a game session. Session names do not need
	// to be unique.
	Name *string `min:"1" type:"string"`

	// Policy determining whether or not the game session accepts new players.
	PlayerSessionCreationPolicy *string `type:"string" enum:"PlayerSessionCreationPolicy"`

	// Game session protection policy to apply to this game session only.
	//
	//    * NoProtection – The game session can be terminated during a scale-down
	//    event.
	//
	//    * FullProtection – If the game session is in an ACTIVE status, it cannot
	//    be terminated during a scale-down event.
	ProtectionPolicy *string `type:"string" enum:"ProtectionPolicy"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (UpdateGameSessionInput) GoString

func (s UpdateGameSessionInput) GoString() string

GoString returns the string representation

func (*UpdateGameSessionInput) SetGameSessionId added in v1.5.0

func (s *UpdateGameSessionInput) SetGameSessionId(v string) *UpdateGameSessionInput

SetGameSessionId sets the GameSessionId field's value.

func (*UpdateGameSessionInput) SetMaximumPlayerSessionCount added in v1.5.0

func (s *UpdateGameSessionInput) SetMaximumPlayerSessionCount(v int64) *UpdateGameSessionInput

SetMaximumPlayerSessionCount sets the MaximumPlayerSessionCount field's value.

func (*UpdateGameSessionInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*UpdateGameSessionInput) SetPlayerSessionCreationPolicy added in v1.5.0

func (s *UpdateGameSessionInput) SetPlayerSessionCreationPolicy(v string) *UpdateGameSessionInput

SetPlayerSessionCreationPolicy sets the PlayerSessionCreationPolicy field's value.

func (*UpdateGameSessionInput) SetProtectionPolicy added in v1.5.0

func (s *UpdateGameSessionInput) SetProtectionPolicy(v string) *UpdateGameSessionInput

SetProtectionPolicy sets the ProtectionPolicy field's value.

func (UpdateGameSessionInput) String

func (s UpdateGameSessionInput) String() string

String returns the string representation

func (*UpdateGameSessionInput) Validate added in v1.1.21

func (s *UpdateGameSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateGameSessionOutput

type UpdateGameSessionOutput struct {

	// Object containing the updated game session metadata.
	GameSession *GameSession `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (UpdateGameSessionOutput) GoString

func (s UpdateGameSessionOutput) GoString() string

GoString returns the string representation

func (*UpdateGameSessionOutput) SetGameSession added in v1.5.0

SetGameSession sets the GameSession field's value.

func (UpdateGameSessionOutput) String

func (s UpdateGameSessionOutput) String() string

String returns the string representation

type UpdateRuntimeConfigurationInput added in v1.2.1

type UpdateRuntimeConfigurationInput struct {

	// Unique identifier of the fleet to update runtime configuration for.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Instructions for launching server processes on each instance in the fleet.
	// The runtime configuration for a fleet has a collection of server process
	// configurations, one for each type of server process to run on an instance.
	// A server process configuration specifies the location of the server executable,
	// launch parameters, and the number of concurrent processes with that configuration
	// to maintain on each instance.
	//
	// RuntimeConfiguration is a required field
	RuntimeConfiguration *RuntimeConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for a request action.

func (UpdateRuntimeConfigurationInput) GoString added in v1.2.1

GoString returns the string representation

func (*UpdateRuntimeConfigurationInput) SetFleetId added in v1.5.0

SetFleetId sets the FleetId field's value.

func (*UpdateRuntimeConfigurationInput) SetRuntimeConfiguration added in v1.5.0

SetRuntimeConfiguration sets the RuntimeConfiguration field's value.

func (UpdateRuntimeConfigurationInput) String added in v1.2.1

String returns the string representation

func (*UpdateRuntimeConfigurationInput) Validate added in v1.2.1

func (s *UpdateRuntimeConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateRuntimeConfigurationOutput added in v1.2.1

type UpdateRuntimeConfigurationOutput struct {

	// The runtime configuration currently in force. If the update was successful,
	// this object matches the one in the request.
	RuntimeConfiguration *RuntimeConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Represents the returned data in response to a request action.

func (UpdateRuntimeConfigurationOutput) GoString added in v1.2.1

GoString returns the string representation

func (*UpdateRuntimeConfigurationOutput) SetRuntimeConfiguration added in v1.5.0

SetRuntimeConfiguration sets the RuntimeConfiguration field's value.

func (UpdateRuntimeConfigurationOutput) String added in v1.2.1

String returns the string representation

Directories

Path Synopsis
Package gameliftiface provides an interface to enable mocking the Amazon GameLift service client for testing your code.
Package gameliftiface provides an interface to enable mocking the Amazon GameLift service client for testing your code.

Jump to

Keyboard shortcuts

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