gamelift

package
v1.55.5 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 79

Documentation

Overview

Package gamelift provides the client and types for making API requests to Amazon GameLift.

Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand.

About Amazon GameLift solutions

Get more information on these Amazon GameLift solutions in the Amazon GameLift Developer Guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/).

  • Amazon GameLift managed hosting -- Amazon GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.

  • Managed hosting with Realtime Servers -- With Amazon GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core Amazon GameLift infrastructure already built in. Then use the full range of Amazon GameLift managed hosting features, including FlexMatch, for your game.

  • Amazon GameLift FleetIQ -- Use Amazon GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. Amazon GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the Amazon GameLift FleetIQ and FlexMatch standalone services.

  • Amazon GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with Amazon GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.

About this API Reference

This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:

See https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01 for more information on this service.

See gamelift package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/gamelift/

Using the Client

To contact Amazon GameLift with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon GameLift client GameLift for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/gamelift/#New

Index

Constants

View Source 
const (
	// AcceptanceTypeAccept is a AcceptanceType enum value
	AcceptanceTypeAccept = "ACCEPT"

	// AcceptanceTypeReject is a AcceptanceType enum value
	AcceptanceTypeReject = "REJECT"
)
View Source 
const (
	// BackfillModeAutomatic is a BackfillMode enum value
	BackfillModeAutomatic = "AUTOMATIC"

	// BackfillModeManual is a BackfillMode enum value
	BackfillModeManual = "MANUAL"
)
View Source 
const (
	// BalancingStrategySpotOnly is a BalancingStrategy enum value
	BalancingStrategySpotOnly = "SPOT_ONLY"

	// BalancingStrategySpotPreferred is a BalancingStrategy enum value
	BalancingStrategySpotPreferred = "SPOT_PREFERRED"

	// BalancingStrategyOnDemandOnly is a BalancingStrategy enum value
	BalancingStrategyOnDemandOnly = "ON_DEMAND_ONLY"
)
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 (
	// CertificateTypeDisabled is a CertificateType enum value
	CertificateTypeDisabled = "DISABLED"

	// CertificateTypeGenerated is a CertificateType enum value
	CertificateTypeGenerated = "GENERATED"
)
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 (
	// ComputeStatusPending is a ComputeStatus enum value
	ComputeStatusPending = "PENDING"

	// ComputeStatusActive is a ComputeStatus enum value
	ComputeStatusActive = "ACTIVE"

	// ComputeStatusTerminating is a ComputeStatus enum value
	ComputeStatusTerminating = "TERMINATING"
)
View Source 
const (
	// ComputeTypeEc2 is a ComputeType enum value
	ComputeTypeEc2 = "EC2"

	// ComputeTypeAnywhere is a ComputeType enum value
	ComputeTypeAnywhere = "ANYWHERE"

	// ComputeTypeContainer is a ComputeType enum value
	ComputeTypeContainer = "CONTAINER"
)
View Source 
const (
	// ContainerDependencyConditionStart is a ContainerDependencyCondition enum value
	ContainerDependencyConditionStart = "START"

	// ContainerDependencyConditionComplete is a ContainerDependencyCondition enum value
	ContainerDependencyConditionComplete = "COMPLETE"

	// ContainerDependencyConditionSuccess is a ContainerDependencyCondition enum value
	ContainerDependencyConditionSuccess = "SUCCESS"

	// ContainerDependencyConditionHealthy is a ContainerDependencyCondition enum value
	ContainerDependencyConditionHealthy = "HEALTHY"
)
View Source 
const (
	// ContainerGroupDefinitionStatusReady is a ContainerGroupDefinitionStatus enum value
	ContainerGroupDefinitionStatusReady = "READY"

	// ContainerGroupDefinitionStatusCopying is a ContainerGroupDefinitionStatus enum value
	ContainerGroupDefinitionStatusCopying = "COPYING"

	// ContainerGroupDefinitionStatusFailed is a ContainerGroupDefinitionStatus enum value
	ContainerGroupDefinitionStatusFailed = "FAILED"
)
View Source 
const (
	// ContainerSchedulingStrategyReplica is a ContainerSchedulingStrategy enum value
	ContainerSchedulingStrategyReplica = "REPLICA"

	// ContainerSchedulingStrategyDaemon is a ContainerSchedulingStrategy enum value
	ContainerSchedulingStrategyDaemon = "DAEMON"
)
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"

	// EC2InstanceTypeC5Large is a EC2InstanceType enum value
	EC2InstanceTypeC5Large = "c5.large"

	// EC2InstanceTypeC5Xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5Xlarge = "c5.xlarge"

	// EC2InstanceTypeC52xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC52xlarge = "c5.2xlarge"

	// EC2InstanceTypeC54xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC54xlarge = "c5.4xlarge"

	// EC2InstanceTypeC59xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC59xlarge = "c5.9xlarge"

	// EC2InstanceTypeC512xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC512xlarge = "c5.12xlarge"

	// EC2InstanceTypeC518xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC518xlarge = "c5.18xlarge"

	// EC2InstanceTypeC524xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC524xlarge = "c5.24xlarge"

	// EC2InstanceTypeC5aLarge is a EC2InstanceType enum value
	EC2InstanceTypeC5aLarge = "c5a.large"

	// EC2InstanceTypeC5aXlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5aXlarge = "c5a.xlarge"

	// EC2InstanceTypeC5a2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5a2xlarge = "c5a.2xlarge"

	// EC2InstanceTypeC5a4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5a4xlarge = "c5a.4xlarge"

	// EC2InstanceTypeC5a8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5a8xlarge = "c5a.8xlarge"

	// EC2InstanceTypeC5a12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5a12xlarge = "c5a.12xlarge"

	// EC2InstanceTypeC5a16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5a16xlarge = "c5a.16xlarge"

	// EC2InstanceTypeC5a24xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5a24xlarge = "c5a.24xlarge"

	// 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"

	// EC2InstanceTypeR4Large is a EC2InstanceType enum value
	EC2InstanceTypeR4Large = "r4.large"

	// EC2InstanceTypeR4Xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR4Xlarge = "r4.xlarge"

	// EC2InstanceTypeR42xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR42xlarge = "r4.2xlarge"

	// EC2InstanceTypeR44xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR44xlarge = "r4.4xlarge"

	// EC2InstanceTypeR48xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR48xlarge = "r4.8xlarge"

	// EC2InstanceTypeR416xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR416xlarge = "r4.16xlarge"

	// EC2InstanceTypeR5Large is a EC2InstanceType enum value
	EC2InstanceTypeR5Large = "r5.large"

	// EC2InstanceTypeR5Xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5Xlarge = "r5.xlarge"

	// EC2InstanceTypeR52xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR52xlarge = "r5.2xlarge"

	// EC2InstanceTypeR54xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR54xlarge = "r5.4xlarge"

	// EC2InstanceTypeR58xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR58xlarge = "r5.8xlarge"

	// EC2InstanceTypeR512xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR512xlarge = "r5.12xlarge"

	// EC2InstanceTypeR516xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR516xlarge = "r5.16xlarge"

	// EC2InstanceTypeR524xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR524xlarge = "r5.24xlarge"

	// EC2InstanceTypeR5aLarge is a EC2InstanceType enum value
	EC2InstanceTypeR5aLarge = "r5a.large"

	// EC2InstanceTypeR5aXlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5aXlarge = "r5a.xlarge"

	// EC2InstanceTypeR5a2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5a2xlarge = "r5a.2xlarge"

	// EC2InstanceTypeR5a4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5a4xlarge = "r5a.4xlarge"

	// EC2InstanceTypeR5a8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5a8xlarge = "r5a.8xlarge"

	// EC2InstanceTypeR5a12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5a12xlarge = "r5a.12xlarge"

	// EC2InstanceTypeR5a16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5a16xlarge = "r5a.16xlarge"

	// EC2InstanceTypeR5a24xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5a24xlarge = "r5a.24xlarge"

	// 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"

	// EC2InstanceTypeM5Large is a EC2InstanceType enum value
	EC2InstanceTypeM5Large = "m5.large"

	// EC2InstanceTypeM5Xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM5Xlarge = "m5.xlarge"

	// EC2InstanceTypeM52xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM52xlarge = "m5.2xlarge"

	// EC2InstanceTypeM54xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM54xlarge = "m5.4xlarge"

	// EC2InstanceTypeM58xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM58xlarge = "m5.8xlarge"

	// EC2InstanceTypeM512xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM512xlarge = "m5.12xlarge"

	// EC2InstanceTypeM516xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM516xlarge = "m5.16xlarge"

	// EC2InstanceTypeM524xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM524xlarge = "m5.24xlarge"

	// EC2InstanceTypeM5aLarge is a EC2InstanceType enum value
	EC2InstanceTypeM5aLarge = "m5a.large"

	// EC2InstanceTypeM5aXlarge is a EC2InstanceType enum value
	EC2InstanceTypeM5aXlarge = "m5a.xlarge"

	// EC2InstanceTypeM5a2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM5a2xlarge = "m5a.2xlarge"

	// EC2InstanceTypeM5a4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM5a4xlarge = "m5a.4xlarge"

	// EC2InstanceTypeM5a8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM5a8xlarge = "m5a.8xlarge"

	// EC2InstanceTypeM5a12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM5a12xlarge = "m5a.12xlarge"

	// EC2InstanceTypeM5a16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM5a16xlarge = "m5a.16xlarge"

	// EC2InstanceTypeM5a24xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM5a24xlarge = "m5a.24xlarge"

	// EC2InstanceTypeC5dLarge is a EC2InstanceType enum value
	EC2InstanceTypeC5dLarge = "c5d.large"

	// EC2InstanceTypeC5dXlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5dXlarge = "c5d.xlarge"

	// EC2InstanceTypeC5d2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5d2xlarge = "c5d.2xlarge"

	// EC2InstanceTypeC5d4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5d4xlarge = "c5d.4xlarge"

	// EC2InstanceTypeC5d9xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5d9xlarge = "c5d.9xlarge"

	// EC2InstanceTypeC5d12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5d12xlarge = "c5d.12xlarge"

	// EC2InstanceTypeC5d18xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5d18xlarge = "c5d.18xlarge"

	// EC2InstanceTypeC5d24xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC5d24xlarge = "c5d.24xlarge"

	// EC2InstanceTypeC6aLarge is a EC2InstanceType enum value
	EC2InstanceTypeC6aLarge = "c6a.large"

	// EC2InstanceTypeC6aXlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6aXlarge = "c6a.xlarge"

	// EC2InstanceTypeC6a2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6a2xlarge = "c6a.2xlarge"

	// EC2InstanceTypeC6a4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6a4xlarge = "c6a.4xlarge"

	// EC2InstanceTypeC6a8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6a8xlarge = "c6a.8xlarge"

	// EC2InstanceTypeC6a12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6a12xlarge = "c6a.12xlarge"

	// EC2InstanceTypeC6a16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6a16xlarge = "c6a.16xlarge"

	// EC2InstanceTypeC6a24xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6a24xlarge = "c6a.24xlarge"

	// EC2InstanceTypeC6iLarge is a EC2InstanceType enum value
	EC2InstanceTypeC6iLarge = "c6i.large"

	// EC2InstanceTypeC6iXlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6iXlarge = "c6i.xlarge"

	// EC2InstanceTypeC6i2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6i2xlarge = "c6i.2xlarge"

	// EC2InstanceTypeC6i4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6i4xlarge = "c6i.4xlarge"

	// EC2InstanceTypeC6i8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6i8xlarge = "c6i.8xlarge"

	// EC2InstanceTypeC6i12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6i12xlarge = "c6i.12xlarge"

	// EC2InstanceTypeC6i16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6i16xlarge = "c6i.16xlarge"

	// EC2InstanceTypeC6i24xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6i24xlarge = "c6i.24xlarge"

	// EC2InstanceTypeR5dLarge is a EC2InstanceType enum value
	EC2InstanceTypeR5dLarge = "r5d.large"

	// EC2InstanceTypeR5dXlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5dXlarge = "r5d.xlarge"

	// EC2InstanceTypeR5d2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5d2xlarge = "r5d.2xlarge"

	// EC2InstanceTypeR5d4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5d4xlarge = "r5d.4xlarge"

	// EC2InstanceTypeR5d8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5d8xlarge = "r5d.8xlarge"

	// EC2InstanceTypeR5d12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5d12xlarge = "r5d.12xlarge"

	// EC2InstanceTypeR5d16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5d16xlarge = "r5d.16xlarge"

	// EC2InstanceTypeR5d24xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR5d24xlarge = "r5d.24xlarge"

	// EC2InstanceTypeM6gMedium is a EC2InstanceType enum value
	EC2InstanceTypeM6gMedium = "m6g.medium"

	// EC2InstanceTypeM6gLarge is a EC2InstanceType enum value
	EC2InstanceTypeM6gLarge = "m6g.large"

	// EC2InstanceTypeM6gXlarge is a EC2InstanceType enum value
	EC2InstanceTypeM6gXlarge = "m6g.xlarge"

	// EC2InstanceTypeM6g2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM6g2xlarge = "m6g.2xlarge"

	// EC2InstanceTypeM6g4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM6g4xlarge = "m6g.4xlarge"

	// EC2InstanceTypeM6g8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM6g8xlarge = "m6g.8xlarge"

	// EC2InstanceTypeM6g12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM6g12xlarge = "m6g.12xlarge"

	// EC2InstanceTypeM6g16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM6g16xlarge = "m6g.16xlarge"

	// EC2InstanceTypeC6gMedium is a EC2InstanceType enum value
	EC2InstanceTypeC6gMedium = "c6g.medium"

	// EC2InstanceTypeC6gLarge is a EC2InstanceType enum value
	EC2InstanceTypeC6gLarge = "c6g.large"

	// EC2InstanceTypeC6gXlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6gXlarge = "c6g.xlarge"

	// EC2InstanceTypeC6g2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6g2xlarge = "c6g.2xlarge"

	// EC2InstanceTypeC6g4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6g4xlarge = "c6g.4xlarge"

	// EC2InstanceTypeC6g8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6g8xlarge = "c6g.8xlarge"

	// EC2InstanceTypeC6g12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6g12xlarge = "c6g.12xlarge"

	// EC2InstanceTypeC6g16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6g16xlarge = "c6g.16xlarge"

	// EC2InstanceTypeR6gMedium is a EC2InstanceType enum value
	EC2InstanceTypeR6gMedium = "r6g.medium"

	// EC2InstanceTypeR6gLarge is a EC2InstanceType enum value
	EC2InstanceTypeR6gLarge = "r6g.large"

	// EC2InstanceTypeR6gXlarge is a EC2InstanceType enum value
	EC2InstanceTypeR6gXlarge = "r6g.xlarge"

	// EC2InstanceTypeR6g2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR6g2xlarge = "r6g.2xlarge"

	// EC2InstanceTypeR6g4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR6g4xlarge = "r6g.4xlarge"

	// EC2InstanceTypeR6g8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR6g8xlarge = "r6g.8xlarge"

	// EC2InstanceTypeR6g12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR6g12xlarge = "r6g.12xlarge"

	// EC2InstanceTypeR6g16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR6g16xlarge = "r6g.16xlarge"

	// EC2InstanceTypeC6gnMedium is a EC2InstanceType enum value
	EC2InstanceTypeC6gnMedium = "c6gn.medium"

	// EC2InstanceTypeC6gnLarge is a EC2InstanceType enum value
	EC2InstanceTypeC6gnLarge = "c6gn.large"

	// EC2InstanceTypeC6gnXlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6gnXlarge = "c6gn.xlarge"

	// EC2InstanceTypeC6gn2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6gn2xlarge = "c6gn.2xlarge"

	// EC2InstanceTypeC6gn4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6gn4xlarge = "c6gn.4xlarge"

	// EC2InstanceTypeC6gn8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6gn8xlarge = "c6gn.8xlarge"

	// EC2InstanceTypeC6gn12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6gn12xlarge = "c6gn.12xlarge"

	// EC2InstanceTypeC6gn16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC6gn16xlarge = "c6gn.16xlarge"

	// EC2InstanceTypeC7gMedium is a EC2InstanceType enum value
	EC2InstanceTypeC7gMedium = "c7g.medium"

	// EC2InstanceTypeC7gLarge is a EC2InstanceType enum value
	EC2InstanceTypeC7gLarge = "c7g.large"

	// EC2InstanceTypeC7gXlarge is a EC2InstanceType enum value
	EC2InstanceTypeC7gXlarge = "c7g.xlarge"

	// EC2InstanceTypeC7g2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC7g2xlarge = "c7g.2xlarge"

	// EC2InstanceTypeC7g4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC7g4xlarge = "c7g.4xlarge"

	// EC2InstanceTypeC7g8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC7g8xlarge = "c7g.8xlarge"

	// EC2InstanceTypeC7g12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC7g12xlarge = "c7g.12xlarge"

	// EC2InstanceTypeC7g16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeC7g16xlarge = "c7g.16xlarge"

	// EC2InstanceTypeR7gMedium is a EC2InstanceType enum value
	EC2InstanceTypeR7gMedium = "r7g.medium"

	// EC2InstanceTypeR7gLarge is a EC2InstanceType enum value
	EC2InstanceTypeR7gLarge = "r7g.large"

	// EC2InstanceTypeR7gXlarge is a EC2InstanceType enum value
	EC2InstanceTypeR7gXlarge = "r7g.xlarge"

	// EC2InstanceTypeR7g2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR7g2xlarge = "r7g.2xlarge"

	// EC2InstanceTypeR7g4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR7g4xlarge = "r7g.4xlarge"

	// EC2InstanceTypeR7g8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR7g8xlarge = "r7g.8xlarge"

	// EC2InstanceTypeR7g12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR7g12xlarge = "r7g.12xlarge"

	// EC2InstanceTypeR7g16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeR7g16xlarge = "r7g.16xlarge"

	// EC2InstanceTypeM7gMedium is a EC2InstanceType enum value
	EC2InstanceTypeM7gMedium = "m7g.medium"

	// EC2InstanceTypeM7gLarge is a EC2InstanceType enum value
	EC2InstanceTypeM7gLarge = "m7g.large"

	// EC2InstanceTypeM7gXlarge is a EC2InstanceType enum value
	EC2InstanceTypeM7gXlarge = "m7g.xlarge"

	// EC2InstanceTypeM7g2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM7g2xlarge = "m7g.2xlarge"

	// EC2InstanceTypeM7g4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM7g4xlarge = "m7g.4xlarge"

	// EC2InstanceTypeM7g8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM7g8xlarge = "m7g.8xlarge"

	// EC2InstanceTypeM7g12xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM7g12xlarge = "m7g.12xlarge"

	// EC2InstanceTypeM7g16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeM7g16xlarge = "m7g.16xlarge"

	// EC2InstanceTypeG5gXlarge is a EC2InstanceType enum value
	EC2InstanceTypeG5gXlarge = "g5g.xlarge"

	// EC2InstanceTypeG5g2xlarge is a EC2InstanceType enum value
	EC2InstanceTypeG5g2xlarge = "g5g.2xlarge"

	// EC2InstanceTypeG5g4xlarge is a EC2InstanceType enum value
	EC2InstanceTypeG5g4xlarge = "g5g.4xlarge"

	// EC2InstanceTypeG5g8xlarge is a EC2InstanceType enum value
	EC2InstanceTypeG5g8xlarge = "g5g.8xlarge"

	// EC2InstanceTypeG5g16xlarge is a EC2InstanceType enum value
	EC2InstanceTypeG5g16xlarge = "g5g.16xlarge"
)
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"

	// EventCodeGameSessionActivationTimeout is a EventCode enum value
	EventCodeGameSessionActivationTimeout = "GAME_SESSION_ACTIVATION_TIMEOUT"

	// EventCodeFleetCreationExtractingBuild is a EventCode enum value
	EventCodeFleetCreationExtractingBuild = "FLEET_CREATION_EXTRACTING_BUILD"

	// EventCodeFleetCreationRunningInstaller is a EventCode enum value
	EventCodeFleetCreationRunningInstaller = "FLEET_CREATION_RUNNING_INSTALLER"

	// EventCodeFleetCreationValidatingRuntimeConfig is a EventCode enum value
	EventCodeFleetCreationValidatingRuntimeConfig = "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG"

	// EventCodeFleetVpcPeeringSucceeded is a EventCode enum value
	EventCodeFleetVpcPeeringSucceeded = "FLEET_VPC_PEERING_SUCCEEDED"

	// EventCodeFleetVpcPeeringFailed is a EventCode enum value
	EventCodeFleetVpcPeeringFailed = "FLEET_VPC_PEERING_FAILED"

	// EventCodeFleetVpcPeeringDeleted is a EventCode enum value
	EventCodeFleetVpcPeeringDeleted = "FLEET_VPC_PEERING_DELETED"

	// EventCodeInstanceInterrupted is a EventCode enum value
	EventCodeInstanceInterrupted = "INSTANCE_INTERRUPTED"

	// EventCodeInstanceRecycled is a EventCode enum value
	EventCodeInstanceRecycled = "INSTANCE_RECYCLED"
)
View Source 
const (
	// FilterInstanceStatusActive is a FilterInstanceStatus enum value
	FilterInstanceStatusActive = "ACTIVE"

	// FilterInstanceStatusDraining is a FilterInstanceStatus enum value
	FilterInstanceStatusDraining = "DRAINING"
)
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"

	// FleetStatusNotFound is a FleetStatus enum value
	FleetStatusNotFound = "NOT_FOUND"
)
View Source 
const (
	// FleetTypeOnDemand is a FleetType enum value
	FleetTypeOnDemand = "ON_DEMAND"

	// FleetTypeSpot is a FleetType enum value
	FleetTypeSpot = "SPOT"
)
View Source 
const (
	// FlexMatchModeStandalone is a FlexMatchMode enum value
	FlexMatchModeStandalone = "STANDALONE"

	// FlexMatchModeWithQueue is a FlexMatchMode enum value
	FlexMatchModeWithQueue = "WITH_QUEUE"
)
View Source 
const (
	// GameServerGroupDeleteOptionSafeDelete is a GameServerGroupDeleteOption enum value
	GameServerGroupDeleteOptionSafeDelete = "SAFE_DELETE"

	// GameServerGroupDeleteOptionForceDelete is a GameServerGroupDeleteOption enum value
	GameServerGroupDeleteOptionForceDelete = "FORCE_DELETE"

	// GameServerGroupDeleteOptionRetain is a GameServerGroupDeleteOption enum value
	GameServerGroupDeleteOptionRetain = "RETAIN"
)
View Source 
const (
	// GameServerGroupInstanceTypeC4Large is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC4Large = "c4.large"

	// GameServerGroupInstanceTypeC4Xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC4Xlarge = "c4.xlarge"

	// GameServerGroupInstanceTypeC42xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC42xlarge = "c4.2xlarge"

	// GameServerGroupInstanceTypeC44xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC44xlarge = "c4.4xlarge"

	// GameServerGroupInstanceTypeC48xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC48xlarge = "c4.8xlarge"

	// GameServerGroupInstanceTypeC5Large is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC5Large = "c5.large"

	// GameServerGroupInstanceTypeC5Xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC5Xlarge = "c5.xlarge"

	// GameServerGroupInstanceTypeC52xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC52xlarge = "c5.2xlarge"

	// GameServerGroupInstanceTypeC54xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC54xlarge = "c5.4xlarge"

	// GameServerGroupInstanceTypeC59xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC59xlarge = "c5.9xlarge"

	// GameServerGroupInstanceTypeC512xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC512xlarge = "c5.12xlarge"

	// GameServerGroupInstanceTypeC518xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC518xlarge = "c5.18xlarge"

	// GameServerGroupInstanceTypeC524xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC524xlarge = "c5.24xlarge"

	// GameServerGroupInstanceTypeC5aLarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC5aLarge = "c5a.large"

	// GameServerGroupInstanceTypeC5aXlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC5aXlarge = "c5a.xlarge"

	// GameServerGroupInstanceTypeC5a2xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC5a2xlarge = "c5a.2xlarge"

	// GameServerGroupInstanceTypeC5a4xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC5a4xlarge = "c5a.4xlarge"

	// GameServerGroupInstanceTypeC5a8xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC5a8xlarge = "c5a.8xlarge"

	// GameServerGroupInstanceTypeC5a12xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC5a12xlarge = "c5a.12xlarge"

	// GameServerGroupInstanceTypeC5a16xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC5a16xlarge = "c5a.16xlarge"

	// GameServerGroupInstanceTypeC5a24xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC5a24xlarge = "c5a.24xlarge"

	// GameServerGroupInstanceTypeC6gMedium is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC6gMedium = "c6g.medium"

	// GameServerGroupInstanceTypeC6gLarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC6gLarge = "c6g.large"

	// GameServerGroupInstanceTypeC6gXlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC6gXlarge = "c6g.xlarge"

	// GameServerGroupInstanceTypeC6g2xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC6g2xlarge = "c6g.2xlarge"

	// GameServerGroupInstanceTypeC6g4xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC6g4xlarge = "c6g.4xlarge"

	// GameServerGroupInstanceTypeC6g8xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC6g8xlarge = "c6g.8xlarge"

	// GameServerGroupInstanceTypeC6g12xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC6g12xlarge = "c6g.12xlarge"

	// GameServerGroupInstanceTypeC6g16xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeC6g16xlarge = "c6g.16xlarge"

	// GameServerGroupInstanceTypeR4Large is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR4Large = "r4.large"

	// GameServerGroupInstanceTypeR4Xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR4Xlarge = "r4.xlarge"

	// GameServerGroupInstanceTypeR42xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR42xlarge = "r4.2xlarge"

	// GameServerGroupInstanceTypeR44xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR44xlarge = "r4.4xlarge"

	// GameServerGroupInstanceTypeR48xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR48xlarge = "r4.8xlarge"

	// GameServerGroupInstanceTypeR416xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR416xlarge = "r4.16xlarge"

	// GameServerGroupInstanceTypeR5Large is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR5Large = "r5.large"

	// GameServerGroupInstanceTypeR5Xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR5Xlarge = "r5.xlarge"

	// GameServerGroupInstanceTypeR52xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR52xlarge = "r5.2xlarge"

	// GameServerGroupInstanceTypeR54xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR54xlarge = "r5.4xlarge"

	// GameServerGroupInstanceTypeR58xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR58xlarge = "r5.8xlarge"

	// GameServerGroupInstanceTypeR512xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR512xlarge = "r5.12xlarge"

	// GameServerGroupInstanceTypeR516xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR516xlarge = "r5.16xlarge"

	// GameServerGroupInstanceTypeR524xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR524xlarge = "r5.24xlarge"

	// GameServerGroupInstanceTypeR5aLarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR5aLarge = "r5a.large"

	// GameServerGroupInstanceTypeR5aXlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR5aXlarge = "r5a.xlarge"

	// GameServerGroupInstanceTypeR5a2xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR5a2xlarge = "r5a.2xlarge"

	// GameServerGroupInstanceTypeR5a4xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR5a4xlarge = "r5a.4xlarge"

	// GameServerGroupInstanceTypeR5a8xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR5a8xlarge = "r5a.8xlarge"

	// GameServerGroupInstanceTypeR5a12xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR5a12xlarge = "r5a.12xlarge"

	// GameServerGroupInstanceTypeR5a16xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR5a16xlarge = "r5a.16xlarge"

	// GameServerGroupInstanceTypeR5a24xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR5a24xlarge = "r5a.24xlarge"

	// GameServerGroupInstanceTypeR6gMedium is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR6gMedium = "r6g.medium"

	// GameServerGroupInstanceTypeR6gLarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR6gLarge = "r6g.large"

	// GameServerGroupInstanceTypeR6gXlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR6gXlarge = "r6g.xlarge"

	// GameServerGroupInstanceTypeR6g2xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR6g2xlarge = "r6g.2xlarge"

	// GameServerGroupInstanceTypeR6g4xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR6g4xlarge = "r6g.4xlarge"

	// GameServerGroupInstanceTypeR6g8xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR6g8xlarge = "r6g.8xlarge"

	// GameServerGroupInstanceTypeR6g12xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR6g12xlarge = "r6g.12xlarge"

	// GameServerGroupInstanceTypeR6g16xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeR6g16xlarge = "r6g.16xlarge"

	// GameServerGroupInstanceTypeM4Large is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM4Large = "m4.large"

	// GameServerGroupInstanceTypeM4Xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM4Xlarge = "m4.xlarge"

	// GameServerGroupInstanceTypeM42xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM42xlarge = "m4.2xlarge"

	// GameServerGroupInstanceTypeM44xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM44xlarge = "m4.4xlarge"

	// GameServerGroupInstanceTypeM410xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM410xlarge = "m4.10xlarge"

	// GameServerGroupInstanceTypeM5Large is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM5Large = "m5.large"

	// GameServerGroupInstanceTypeM5Xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM5Xlarge = "m5.xlarge"

	// GameServerGroupInstanceTypeM52xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM52xlarge = "m5.2xlarge"

	// GameServerGroupInstanceTypeM54xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM54xlarge = "m5.4xlarge"

	// GameServerGroupInstanceTypeM58xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM58xlarge = "m5.8xlarge"

	// GameServerGroupInstanceTypeM512xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM512xlarge = "m5.12xlarge"

	// GameServerGroupInstanceTypeM516xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM516xlarge = "m5.16xlarge"

	// GameServerGroupInstanceTypeM524xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM524xlarge = "m5.24xlarge"

	// GameServerGroupInstanceTypeM5aLarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM5aLarge = "m5a.large"

	// GameServerGroupInstanceTypeM5aXlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM5aXlarge = "m5a.xlarge"

	// GameServerGroupInstanceTypeM5a2xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM5a2xlarge = "m5a.2xlarge"

	// GameServerGroupInstanceTypeM5a4xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM5a4xlarge = "m5a.4xlarge"

	// GameServerGroupInstanceTypeM5a8xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM5a8xlarge = "m5a.8xlarge"

	// GameServerGroupInstanceTypeM5a12xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM5a12xlarge = "m5a.12xlarge"

	// GameServerGroupInstanceTypeM5a16xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM5a16xlarge = "m5a.16xlarge"

	// GameServerGroupInstanceTypeM5a24xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM5a24xlarge = "m5a.24xlarge"

	// GameServerGroupInstanceTypeM6gMedium is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM6gMedium = "m6g.medium"

	// GameServerGroupInstanceTypeM6gLarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM6gLarge = "m6g.large"

	// GameServerGroupInstanceTypeM6gXlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM6gXlarge = "m6g.xlarge"

	// GameServerGroupInstanceTypeM6g2xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM6g2xlarge = "m6g.2xlarge"

	// GameServerGroupInstanceTypeM6g4xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM6g4xlarge = "m6g.4xlarge"

	// GameServerGroupInstanceTypeM6g8xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM6g8xlarge = "m6g.8xlarge"

	// GameServerGroupInstanceTypeM6g12xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM6g12xlarge = "m6g.12xlarge"

	// GameServerGroupInstanceTypeM6g16xlarge is a GameServerGroupInstanceType enum value
	GameServerGroupInstanceTypeM6g16xlarge = "m6g.16xlarge"
)
View Source 
const (
	// GameServerGroupStatusNew is a GameServerGroupStatus enum value
	GameServerGroupStatusNew = "NEW"

	// GameServerGroupStatusActivating is a GameServerGroupStatus enum value
	GameServerGroupStatusActivating = "ACTIVATING"

	// GameServerGroupStatusActive is a GameServerGroupStatus enum value
	GameServerGroupStatusActive = "ACTIVE"

	// GameServerGroupStatusDeleteScheduled is a GameServerGroupStatus enum value
	GameServerGroupStatusDeleteScheduled = "DELETE_SCHEDULED"

	// GameServerGroupStatusDeleting is a GameServerGroupStatus enum value
	GameServerGroupStatusDeleting = "DELETING"

	// GameServerGroupStatusDeleted is a GameServerGroupStatus enum value
	GameServerGroupStatusDeleted = "DELETED"

	// GameServerGroupStatusError is a GameServerGroupStatus enum value
	GameServerGroupStatusError = "ERROR"
)
View Source 
const (
	// GameServerInstanceStatusActive is a GameServerInstanceStatus enum value
	GameServerInstanceStatusActive = "ACTIVE"

	// GameServerInstanceStatusDraining is a GameServerInstanceStatus enum value
	GameServerInstanceStatusDraining = "DRAINING"

	// GameServerInstanceStatusSpotTerminating is a GameServerInstanceStatus enum value
	GameServerInstanceStatusSpotTerminating = "SPOT_TERMINATING"
)
View Source 
const (
	// GameServerProtectionPolicyNoProtection is a GameServerProtectionPolicy enum value
	GameServerProtectionPolicyNoProtection = "NO_PROTECTION"

	// GameServerProtectionPolicyFullProtection is a GameServerProtectionPolicy enum value
	GameServerProtectionPolicyFullProtection = "FULL_PROTECTION"
)
View Source 
const (
	// GameServerUtilizationStatusAvailable is a GameServerUtilizationStatus enum value
	GameServerUtilizationStatusAvailable = "AVAILABLE"

	// GameServerUtilizationStatusUtilized is a GameServerUtilizationStatus enum value
	GameServerUtilizationStatusUtilized = "UTILIZED"
)
View Source 
const (
	// GameSessionPlacementStatePending is a GameSessionPlacementState enum value
	GameSessionPlacementStatePending = "PENDING"

	// GameSessionPlacementStateFulfilled is a GameSessionPlacementState enum value
	GameSessionPlacementStateFulfilled = "FULFILLED"

	// GameSessionPlacementStateCancelled is a GameSessionPlacementState enum value
	GameSessionPlacementStateCancelled = "CANCELLED"

	// GameSessionPlacementStateTimedOut is a GameSessionPlacementState enum value
	GameSessionPlacementStateTimedOut = "TIMED_OUT"

	// GameSessionPlacementStateFailed is a GameSessionPlacementState enum value
	GameSessionPlacementStateFailed = "FAILED"
)
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 (
	// LocationFilterAws is a LocationFilter enum value
	LocationFilterAws = "AWS"

	// LocationFilterCustom is a LocationFilter enum value
	LocationFilterCustom = "CUSTOM"
)
View Source 
const (
	// MatchmakingConfigurationStatusCancelled is a MatchmakingConfigurationStatus enum value
	MatchmakingConfigurationStatusCancelled = "CANCELLED"

	// MatchmakingConfigurationStatusCompleted is a MatchmakingConfigurationStatus enum value
	MatchmakingConfigurationStatusCompleted = "COMPLETED"

	// MatchmakingConfigurationStatusFailed is a MatchmakingConfigurationStatus enum value
	MatchmakingConfigurationStatusFailed = "FAILED"

	// MatchmakingConfigurationStatusPlacing is a MatchmakingConfigurationStatus enum value
	MatchmakingConfigurationStatusPlacing = "PLACING"

	// MatchmakingConfigurationStatusQueued is a MatchmakingConfigurationStatus enum value
	MatchmakingConfigurationStatusQueued = "QUEUED"

	// MatchmakingConfigurationStatusRequiresAcceptance is a MatchmakingConfigurationStatus enum value
	MatchmakingConfigurationStatusRequiresAcceptance = "REQUIRES_ACCEPTANCE"

	// MatchmakingConfigurationStatusSearching is a MatchmakingConfigurationStatus enum value
	MatchmakingConfigurationStatusSearching = "SEARCHING"

	// MatchmakingConfigurationStatusTimedOut is a MatchmakingConfigurationStatus enum value
	MatchmakingConfigurationStatusTimedOut = "TIMED_OUT"
)
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"

	// MetricNameAvailableGameSessions is a MetricName enum value
	MetricNameAvailableGameSessions = "AvailableGameSessions"

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

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

	// MetricNameIdleInstances is a MetricName enum value
	MetricNameIdleInstances = "IdleInstances"

	// MetricNamePercentAvailableGameSessions is a MetricName enum value
	MetricNamePercentAvailableGameSessions = "PercentAvailableGameSessions"

	// MetricNamePercentIdleInstances is a MetricName enum value
	MetricNamePercentIdleInstances = "PercentIdleInstances"

	// MetricNameQueueDepth is a MetricName enum value
	MetricNameQueueDepth = "QueueDepth"

	// MetricNameWaitTime is a MetricName enum value
	MetricNameWaitTime = "WaitTime"

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

	// OperatingSystemAmazonLinux is a OperatingSystem enum value
	OperatingSystemAmazonLinux = "AMAZON_LINUX"

	// OperatingSystemAmazonLinux2 is a OperatingSystem enum value
	OperatingSystemAmazonLinux2 = "AMAZON_LINUX_2"

	// OperatingSystemWindows2016 is a OperatingSystem enum value
	OperatingSystemWindows2016 = "WINDOWS_2016"

	// OperatingSystemAmazonLinux2023 is a OperatingSystem enum value
	OperatingSystemAmazonLinux2023 = "AMAZON_LINUX_2023"
)
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 (
	// PolicyTypeRuleBased is a PolicyType enum value
	PolicyTypeRuleBased = "RuleBased"

	// PolicyTypeTargetBased is a PolicyType enum value
	PolicyTypeTargetBased = "TargetBased"
)
View Source 
const (
	// PriorityTypeLatency is a PriorityType enum value
	PriorityTypeLatency = "LATENCY"

	// PriorityTypeCost is a PriorityType enum value
	PriorityTypeCost = "COST"

	// PriorityTypeDestination is a PriorityType enum value
	PriorityTypeDestination = "DESTINATION"

	// PriorityTypeLocation is a PriorityType enum value
	PriorityTypeLocation = "LOCATION"
)
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 (
	// SortOrderAscending is a SortOrder enum value
	SortOrderAscending = "ASCENDING"

	// SortOrderDescending is a SortOrder enum value
	SortOrderDescending = "DESCENDING"
)
View Source 
const (

	// ErrCodeConflictException for service response error code
	// "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.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeFleetCapacityExceededException for service response error code
	// "FleetCapacityExceededException".
	//
	// The specified fleet has no available instances to fulfill a CreateGameSession
	// request. Clients can retry such requests immediately or after a waiting period.
	ErrCodeFleetCapacityExceededException = "FleetCapacityExceededException"

	// ErrCodeGameSessionFullException for service response error code
	// "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.
	ErrCodeGameSessionFullException = "GameSessionFullException"

	// ErrCodeIdempotentParameterMismatchException for service response error code
	// "IdempotentParameterMismatchException".
	//
	// A game session with this custom ID string already exists in this fleet. Resolve
	// this conflict before retrying this request.
	ErrCodeIdempotentParameterMismatchException = "IdempotentParameterMismatchException"

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	//
	// The service encountered an unrecoverable internal failure while processing
	// the request. Clients can retry such requests immediately or after a waiting
	// period.
	ErrCodeInternalServiceException = "InternalServiceException"

	// ErrCodeInvalidFleetStatusException for service response error code
	// "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.
	ErrCodeInvalidFleetStatusException = "InvalidFleetStatusException"

	// ErrCodeInvalidGameSessionStatusException for service response error code
	// "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.
	ErrCodeInvalidGameSessionStatusException = "InvalidGameSessionStatusException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// One or more parameter values in the request are invalid. Correct the invalid
	// parameter values before retrying.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The requested operation would cause the resource to exceed the allowed service
	// limit. Resolve the issue before retrying.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// THe requested resources was not found. The resource was either not created
	// yet or deleted.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeNotReadyException for service response error code
	// "NotReadyException".
	//
	// The operation failed because Amazon GameLift has not yet finished validating
	// this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes
	// with exponential backoffs and jitter (http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/).
	ErrCodeNotReadyException = "NotReadyException"

	// ErrCodeOutOfCapacityException for service response error code
	// "OutOfCapacityException".
	//
	// The specified game server group has no available game servers to fulfill
	// a ClaimGameServer request. Clients can retry such requests immediately or
	// after a waiting period.
	ErrCodeOutOfCapacityException = "OutOfCapacityException"

	// ErrCodeTaggingFailedException for service response error code
	// "TaggingFailedException".
	//
	// The requested tagging operation did not succeed. This may be due to invalid
	// tag format or the maximum tag limit may have been exceeded. Resolve the issue
	// before retrying.
	ErrCodeTaggingFailedException = "TaggingFailedException"

	// ErrCodeTerminalRoutingStrategyException for service response error code
	// "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.
	ErrCodeTerminalRoutingStrategyException = "TerminalRoutingStrategyException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// The client failed authentication. Clients should not retry such requests.
	ErrCodeUnauthorizedException = "UnauthorizedException"

	// ErrCodeUnsupportedRegionException for service response error code
	// "UnsupportedRegionException".
	//
	// The requested operation is not supported in the Region specified.
	ErrCodeUnsupportedRegionException = "UnsupportedRegionException"
)
View Source 
const (
	ServiceName = "gamelift"  // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "GameLift"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ContainerOperatingSystemAmazonLinux2023 is a ContainerOperatingSystem enum value
	ContainerOperatingSystemAmazonLinux2023 = "AMAZON_LINUX_2023"
)
View Source 
const (
	// FleetActionAutoScaling is a FleetAction enum value
	FleetActionAutoScaling = "AUTO_SCALING"
)
View Source 
const (
	// GameServerClaimStatusClaimed is a GameServerClaimStatus enum value
	GameServerClaimStatusClaimed = "CLAIMED"
)
View Source 
const (
	// GameServerGroupActionReplaceInstanceTypes is a GameServerGroupAction enum value
	GameServerGroupActionReplaceInstanceTypes = "REPLACE_INSTANCE_TYPES"
)
View Source 
const (
	// GameServerHealthCheckHealthy is a GameServerHealthCheck enum value
	GameServerHealthCheckHealthy = "HEALTHY"
)
View Source 
const (
	// GameSessionStatusReasonInterrupted is a GameSessionStatusReason enum value
	GameSessionStatusReasonInterrupted = "INTERRUPTED"
)
View Source 
const (
	// InstanceRoleCredentialsProviderSharedCredentialFile is a InstanceRoleCredentialsProvider enum value
	InstanceRoleCredentialsProviderSharedCredentialFile = "SHARED_CREDENTIAL_FILE"
)
View Source 
const (
	// LocationUpdateStatusPendingUpdate is a LocationUpdateStatus enum value
	LocationUpdateStatusPendingUpdate = "PENDING_UPDATE"
)

Variables

This section is empty.

Functions

func AcceptanceType_Values added in v1.34.3 

func AcceptanceType_Values() []string

AcceptanceType_Values returns all elements of the AcceptanceType enum

func BackfillMode_Values added in v1.34.3 

func BackfillMode_Values() []string

BackfillMode_Values returns all elements of the BackfillMode enum

func BalancingStrategy_Values added in v1.34.3 

func BalancingStrategy_Values() []string

BalancingStrategy_Values returns all elements of the BalancingStrategy enum

func BuildStatus_Values added in v1.34.3 

func BuildStatus_Values() []string

BuildStatus_Values returns all elements of the BuildStatus enum

func CertificateType_Values added in v1.34.3 

func CertificateType_Values() []string

CertificateType_Values returns all elements of the CertificateType enum

func ComparisonOperatorType_Values added in v1.34.3 

func ComparisonOperatorType_Values() []string

ComparisonOperatorType_Values returns all elements of the ComparisonOperatorType enum

func ComputeStatus_Values added in v1.44.151 

func ComputeStatus_Values() []string

ComputeStatus_Values returns all elements of the ComputeStatus enum

func ComputeType_Values added in v1.44.151 

func ComputeType_Values() []string

ComputeType_Values returns all elements of the ComputeType enum

func ContainerDependencyCondition_Values added in v1.51.28 

func ContainerDependencyCondition_Values() []string

ContainerDependencyCondition_Values returns all elements of the ContainerDependencyCondition enum

func ContainerGroupDefinitionStatus_Values added in v1.51.28 

func ContainerGroupDefinitionStatus_Values() []string

ContainerGroupDefinitionStatus_Values returns all elements of the ContainerGroupDefinitionStatus enum

func ContainerOperatingSystem_Values added in v1.51.28 

func ContainerOperatingSystem_Values() []string

ContainerOperatingSystem_Values returns all elements of the ContainerOperatingSystem enum

func ContainerSchedulingStrategy_Values added in v1.51.28 

func ContainerSchedulingStrategy_Values() []string

ContainerSchedulingStrategy_Values returns all elements of the ContainerSchedulingStrategy enum

func EC2InstanceType_Values added in v1.34.3 

func EC2InstanceType_Values() []string

EC2InstanceType_Values returns all elements of the EC2InstanceType enum

func EventCode_Values added in v1.34.3 

func EventCode_Values() []string

EventCode_Values returns all elements of the EventCode enum

func FilterInstanceStatus_Values added in v1.44.270 

func FilterInstanceStatus_Values() []string

FilterInstanceStatus_Values returns all elements of the FilterInstanceStatus enum

func FleetAction_Values added in v1.34.3 

func FleetAction_Values() []string

FleetAction_Values returns all elements of the FleetAction enum

func FleetStatus_Values added in v1.34.3 

func FleetStatus_Values() []string

FleetStatus_Values returns all elements of the FleetStatus enum

func FleetType_Values added in v1.34.3 

func FleetType_Values() []string

FleetType_Values returns all elements of the FleetType enum

func FlexMatchMode_Values added in v1.35.35 

func FlexMatchMode_Values() []string

FlexMatchMode_Values returns all elements of the FlexMatchMode enum

func GameServerClaimStatus_Values added in v1.34.3 

func GameServerClaimStatus_Values() []string

GameServerClaimStatus_Values returns all elements of the GameServerClaimStatus enum

func GameServerGroupAction_Values added in v1.34.3 

func GameServerGroupAction_Values() []string

GameServerGroupAction_Values returns all elements of the GameServerGroupAction enum

func GameServerGroupDeleteOption_Values added in v1.34.3 

func GameServerGroupDeleteOption_Values() []string

GameServerGroupDeleteOption_Values returns all elements of the GameServerGroupDeleteOption enum

func GameServerGroupInstanceType_Values added in v1.34.3 

func GameServerGroupInstanceType_Values() []string

GameServerGroupInstanceType_Values returns all elements of the GameServerGroupInstanceType enum

func GameServerGroupStatus_Values added in v1.34.3 

func GameServerGroupStatus_Values() []string

GameServerGroupStatus_Values returns all elements of the GameServerGroupStatus enum

func GameServerHealthCheck_Values added in v1.34.3 

func GameServerHealthCheck_Values() []string

GameServerHealthCheck_Values returns all elements of the GameServerHealthCheck enum

func GameServerInstanceStatus_Values added in v1.34.12 

func GameServerInstanceStatus_Values() []string

GameServerInstanceStatus_Values returns all elements of the GameServerInstanceStatus enum

func GameServerProtectionPolicy_Values added in v1.34.3 

func GameServerProtectionPolicy_Values() []string

GameServerProtectionPolicy_Values returns all elements of the GameServerProtectionPolicy enum

func GameServerUtilizationStatus_Values added in v1.34.3 

func GameServerUtilizationStatus_Values() []string

GameServerUtilizationStatus_Values returns all elements of the GameServerUtilizationStatus enum

func GameSessionPlacementState_Values added in v1.34.3 

func GameSessionPlacementState_Values() []string

GameSessionPlacementState_Values returns all elements of the GameSessionPlacementState enum

func GameSessionStatusReason_Values added in v1.34.3 

func GameSessionStatusReason_Values() []string

GameSessionStatusReason_Values returns all elements of the GameSessionStatusReason enum

func GameSessionStatus_Values added in v1.34.3 

func GameSessionStatus_Values() []string

GameSessionStatus_Values returns all elements of the GameSessionStatus enum

func InstanceRoleCredentialsProvider_Values added in v1.47.2 

func InstanceRoleCredentialsProvider_Values() []string

InstanceRoleCredentialsProvider_Values returns all elements of the InstanceRoleCredentialsProvider enum

func InstanceStatus_Values added in v1.34.3 

func InstanceStatus_Values() []string

InstanceStatus_Values returns all elements of the InstanceStatus enum

func IpProtocol_Values added in v1.34.3 

func IpProtocol_Values() []string

IpProtocol_Values returns all elements of the IpProtocol enum

func LocationFilter_Values added in v1.44.151 

func LocationFilter_Values() []string

LocationFilter_Values returns all elements of the LocationFilter enum

func LocationUpdateStatus_Values added in v1.37.32 

func LocationUpdateStatus_Values() []string

LocationUpdateStatus_Values returns all elements of the LocationUpdateStatus enum

func MatchmakingConfigurationStatus_Values added in v1.34.3 

func MatchmakingConfigurationStatus_Values() []string

MatchmakingConfigurationStatus_Values returns all elements of the MatchmakingConfigurationStatus enum

func MetricName_Values added in v1.34.3 

func MetricName_Values() []string

MetricName_Values returns all elements of the MetricName enum

func OperatingSystem_Values added in v1.34.3 

func OperatingSystem_Values() []string

OperatingSystem_Values returns all elements of the OperatingSystem enum

func PlayerSessionCreationPolicy_Values added in v1.34.3 

func PlayerSessionCreationPolicy_Values() []string

PlayerSessionCreationPolicy_Values returns all elements of the PlayerSessionCreationPolicy enum

func PlayerSessionStatus_Values added in v1.34.3 

func PlayerSessionStatus_Values() []string

PlayerSessionStatus_Values returns all elements of the PlayerSessionStatus enum

func PolicyType_Values added in v1.34.3 

func PolicyType_Values() []string

PolicyType_Values returns all elements of the PolicyType enum

func PriorityType_Values added in v1.37.32 

func PriorityType_Values() []string

PriorityType_Values returns all elements of the PriorityType enum

func ProtectionPolicy_Values added in v1.34.3 

func ProtectionPolicy_Values() []string

ProtectionPolicy_Values returns all elements of the ProtectionPolicy enum

func RoutingStrategyType_Values added in v1.34.3 

func RoutingStrategyType_Values() []string

RoutingStrategyType_Values returns all elements of the RoutingStrategyType enum

func ScalingAdjustmentType_Values added in v1.34.3 

func ScalingAdjustmentType_Values() []string

ScalingAdjustmentType_Values returns all elements of the ScalingAdjustmentType enum

func ScalingStatusType_Values added in v1.34.3 

func ScalingStatusType_Values() []string

ScalingStatusType_Values returns all elements of the ScalingStatusType enum

func SortOrder_Values added in v1.34.3 

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

Types

type AcceptMatchInput added in v1.10.27 

type AcceptMatchInput struct {

	// Player response to the proposed match.
	//
	// AcceptanceType is a required field
	AcceptanceType *string `type:"string" required:"true" enum:"AcceptanceType"`

	// A unique identifier for a player delivering the response. This parameter
	// can include one or multiple player IDs.
	//
	// PlayerIds is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AcceptMatchInput's
	// String and GoString methods.
	//
	// PlayerIds is a required field
	PlayerIds []*string `type:"list" required:"true" sensitive:"true"`

	// A unique identifier for a matchmaking ticket. The ticket must be in status
	// REQUIRES_ACCEPTANCE; otherwise this request will fail.
	//
	// TicketId is a required field
	TicketId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AcceptMatchInput) GoString added in v1.10.27 

func (s AcceptMatchInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptMatchInput) SetAcceptanceType added in v1.10.27 

func (s *AcceptMatchInput) SetAcceptanceType(v string) *AcceptMatchInput

SetAcceptanceType sets the AcceptanceType field's value.

func (*AcceptMatchInput) SetPlayerIds added in v1.10.27 

func (s *AcceptMatchInput) SetPlayerIds(v []*string) *AcceptMatchInput

SetPlayerIds sets the PlayerIds field's value.

func (*AcceptMatchInput) SetTicketId added in v1.10.27 

func (s *AcceptMatchInput) SetTicketId(v string) *AcceptMatchInput

SetTicketId sets the TicketId field's value.

func (AcceptMatchInput) String added in v1.10.27 

func (s AcceptMatchInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptMatchInput) Validate added in v1.10.27 

func (s *AcceptMatchInput) Validate() error

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

type AcceptMatchOutput added in v1.10.27 

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

func (AcceptMatchOutput) GoString added in v1.10.27 

func (s AcceptMatchOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AcceptMatchOutput) String added in v1.10.27 

func (s AcceptMatchOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Alias 

type Alias struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift alias resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	// In a GameLift alias ARN, the resource ID matches the alias ID value.
	AliasArn *string `type:"string"`

	// A unique identifier for the alias. Alias IDs are unique within a Region.
	AliasId *string `type:"string"`

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

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

	// The time that this data object was last modified. Format is a number expressed
	// in Unix time as milliseconds (for example "1469498468.057").
	LastUpdatedTime *time.Time `type:"timestamp"`

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

	// The routing configuration, including routing type and fleet target, for the
	// alias.
	RoutingStrategy *RoutingStrategy `type:"structure"`
	// contains filtered or unexported fields
}

Properties that describe an alias resource.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

func (Alias) GoString 

func (s Alias) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Alias) SetAliasArn added in v1.6.27 

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

SetAliasArn sets the AliasArn field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AnywhereConfiguration added in v1.44.151 

type AnywhereConfiguration struct {

	// The cost to run your fleet per hour. Amazon GameLift uses the provided cost
	// of your fleet to balance usage in queues. For more information about queues,
	// see Setting up queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html)
	// in the Amazon GameLift Developer Guide.
	//
	// Cost is a required field
	Cost *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Amazon GameLift configuration options for your Anywhere fleets.

func (AnywhereConfiguration) GoString added in v1.44.151 

func (s AnywhereConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnywhereConfiguration) SetCost added in v1.44.151 

func (s *AnywhereConfiguration) SetCost(v string) *AnywhereConfiguration

SetCost sets the Cost field's value.

func (AnywhereConfiguration) String added in v1.44.151 

func (s AnywhereConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnywhereConfiguration) Validate added in v1.44.151 

func (s *AnywhereConfiguration) Validate() error

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

type AttributeValue added in v1.10.27 

type AttributeValue struct {

	// For number values, expressed as double.
	N *float64 `type:"double"`

	// For single string values. Maximum string length is 100 characters.
	S *string `min:"1" type:"string"`

	// For a map of up to 10 data type:value pairs. Maximum length for each string
	// value is 100 characters.
	SDM map[string]*float64 `type:"map"`

	// For a list of up to 100 strings. Maximum length for each string is 100 characters.
	// Duplicate values are not recognized; all occurrences of the repeated value
	// after the first of a repeated value are ignored.
	SL []*string `type:"list"`
	// contains filtered or unexported fields
}

Values for use in player attribute key-value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array, or data map. Each AttributeValue object can use only one of the available properties.

func (AttributeValue) GoString added in v1.10.27 

func (s AttributeValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeValue) SetN added in v1.10.27 

func (s *AttributeValue) SetN(v float64) *AttributeValue

SetN sets the N field's value.

func (*AttributeValue) SetS added in v1.10.27 

func (s *AttributeValue) SetS(v string) *AttributeValue

SetS sets the S field's value.

func (*AttributeValue) SetSDM added in v1.10.27 

func (s *AttributeValue) SetSDM(v map[string]*float64) *AttributeValue

SetSDM sets the SDM field's value.

func (*AttributeValue) SetSL added in v1.10.27 

func (s *AttributeValue) SetSL(v []*string) *AttributeValue

SetSL sets the SL field's value.

func (AttributeValue) String added in v1.10.27 

func (s AttributeValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeValue) Validate added in v1.10.27 

func (s *AttributeValue) Validate() error

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

type AwsCredentials 

type AwsCredentials struct {

	// The access key ID that identifies the temporary security credentials.
	AccessKeyId *string `min:"1" type:"string"`

	// The secret access key that can be used to sign requests.
	SecretAccessKey *string `min:"1" type:"string"`

	// The token that users must pass to the service API to use the temporary credentials.
	SessionToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Amazon Web Services account security credentials that allow interactions with Amazon GameLift resources. The credentials are temporary and valid for a limited time span. You can request fresh credentials at any time.

Amazon Web Services security credentials consist of three parts: an access key ID, a secret access key, and a session token. You must use all three parts together to authenticate your access requests.

You need Amazon Web Services credentials for the following tasks:

  • To upload a game server build directly to Amazon GameLift S3 storage using CreateBuild. To get access for this task, call RequestUploadCredentials.

  • To remotely connect to an active Amazon GameLift fleet instances. To get remote access, call GetComputeAccess.

func (AwsCredentials) GoString 

func (s AwsCredentials) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Build 

type Build struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// assigned to a Amazon GameLift build resource and uniquely identifies it.
	// ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	// In a GameLift build ARN, the resource ID matches the BuildId value.
	BuildArn *string `type:"string"`

	// A unique identifier for the build.
	BuildId *string `type:"string"`

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

	// A descriptive label associated with a build. Build names don't need to be
	// unique. It can be set using CreateBuild (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html)
	// or UpdateBuild (https://docs.aws.amazon.com/gamelift/latest/apireference/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"`

	// The Amazon GameLift Server SDK version used to develop your game server.
	ServerSdkVersion *string `type:"string"`

	// File size of the uploaded game build, expressed in bytes. When the build
	// status is INITIALIZED or when using a custom Amazon S3 storage location,
	// 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 information associated with a build or script. Version strings don't
	// need to be unique.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Properties describing a custom game build.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

func (Build) GoString 

func (s Build) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Build) SetBuildArn added in v1.26.6 

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

SetBuildArn sets the BuildArn field's value.

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) SetServerSdkVersion added in v1.44.151 

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

SetServerSdkVersion sets the ServerSdkVersion 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CertificateConfiguration added in v1.23.14 

type CertificateConfiguration struct {

	// Indicates whether a TLS/SSL certificate is generated for a fleet.
	//
	// Valid values include:
	//
	//    * GENERATED - Generate a TLS/SSL certificate for this fleet.
	//
	//    * DISABLED - (default) Do not generate a TLS/SSL certificate for this
	//    fleet.
	//
	// CertificateType is a required field
	CertificateType *string `type:"string" required:"true" enum:"CertificateType"`
	// contains filtered or unexported fields
}

This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate. The certificate can be retrieved by calling the Amazon GameLift Server SDK (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) operation GetInstanceCertificate.

func (CertificateConfiguration) GoString added in v1.23.14 

func (s CertificateConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateConfiguration) SetCertificateType added in v1.23.14 

func (s *CertificateConfiguration) SetCertificateType(v string) *CertificateConfiguration

SetCertificateType sets the CertificateType field's value.

func (CertificateConfiguration) String added in v1.23.14 

func (s CertificateConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateConfiguration) Validate added in v1.23.14 

func (s *CertificateConfiguration) Validate() error

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

type ClaimFilterOption added in v1.44.270 

type ClaimFilterOption struct {

	// List of instance statuses that game servers may be claimed on. If provided,
	// the list must contain the ACTIVE status.
	InstanceStatuses []*string `type:"list" enum:"FilterInstanceStatus"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Filters which game servers may be claimed when calling ClaimGameServer.

func (ClaimFilterOption) GoString added in v1.44.270 

func (s ClaimFilterOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClaimFilterOption) SetInstanceStatuses added in v1.44.270 

func (s *ClaimFilterOption) SetInstanceStatuses(v []*string) *ClaimFilterOption

SetInstanceStatuses sets the InstanceStatuses field's value.

func (ClaimFilterOption) String added in v1.44.270 

func (s ClaimFilterOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClaimGameServerInput added in v1.30.3 

type ClaimGameServerInput struct {

	// Object that restricts how a claimed game server is chosen.
	FilterOption *ClaimFilterOption `type:"structure"`

	// A set of custom game server properties, formatted as a single string value.
	// This data is passed to a game client or service when it requests information
	// on game servers.
	GameServerData *string `min:"1" type:"string"`

	// A unique identifier for the game server group where the game server is running.
	// If you are not specifying a game server to claim, this value identifies where
	// you want Amazon GameLift FleetIQ to look for an available game server to
	// claim.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// A custom string that uniquely identifies the game server to claim. If this
	// parameter is left empty, Amazon GameLift FleetIQ searches for an available
	// game server in the specified game server group.
	GameServerId *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (ClaimGameServerInput) GoString added in v1.30.3 

func (s ClaimGameServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClaimGameServerInput) SetFilterOption added in v1.44.270 

func (s *ClaimGameServerInput) SetFilterOption(v *ClaimFilterOption) *ClaimGameServerInput

SetFilterOption sets the FilterOption field's value.

func (*ClaimGameServerInput) SetGameServerData added in v1.30.3 

func (s *ClaimGameServerInput) SetGameServerData(v string) *ClaimGameServerInput

SetGameServerData sets the GameServerData field's value.

func (*ClaimGameServerInput) SetGameServerGroupName added in v1.30.3 

func (s *ClaimGameServerInput) SetGameServerGroupName(v string) *ClaimGameServerInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*ClaimGameServerInput) SetGameServerId added in v1.30.3 

func (s *ClaimGameServerInput) SetGameServerId(v string) *ClaimGameServerInput

SetGameServerId sets the GameServerId field's value.

func (ClaimGameServerInput) String added in v1.30.3 

func (s ClaimGameServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClaimGameServerInput) Validate added in v1.30.3 

func (s *ClaimGameServerInput) Validate() error

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

type ClaimGameServerOutput added in v1.30.3 

type ClaimGameServerOutput struct {

	// Object that describes the newly claimed game server.
	GameServer *GameServer `type:"structure"`
	// contains filtered or unexported fields
}

func (ClaimGameServerOutput) GoString added in v1.30.3 

func (s ClaimGameServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClaimGameServerOutput) SetGameServer added in v1.30.3 

func (s *ClaimGameServerOutput) SetGameServer(v *GameServer) *ClaimGameServerOutput

SetGameServer sets the GameServer field's value.

func (ClaimGameServerOutput) String added in v1.30.3 

func (s ClaimGameServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Compute added in v1.44.151 

type Compute struct {

	// The ARN that is assigned to a compute resource and uniquely identifies it.
	// ARNs are unique across locations. Instances in managed EC2 fleets are not
	// assigned a Compute ARN.
	ComputeArn *string `type:"string"`

	// A descriptive label for the compute resource. For instances in a managed
	// EC2 fleet, the compute name is the same value as the InstanceId ID.
	ComputeName *string `min:"1" type:"string"`

	// Current status of the compute. A compute must have an ACTIVE status to host
	// game sessions.
	ComputeStatus *string `type:"string" enum:"ComputeStatus"`

	// Some attributes of a container.
	ContainerAttributes *ContainerAttributes `type:"structure"`

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

	// The DNS name of a compute resource. Amazon GameLift requires a DNS name or
	// IP address for a compute.
	DnsName *string `type:"string"`

	// The Amazon Resource Name (ARN) of the fleet that the compute belongs to.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that the compute belongs to.
	FleetId *string `type:"string"`

	// The endpoint of the Amazon GameLift Agent.
	GameLiftAgentEndpoint *string `min:"1" type:"string"`

	// The Amazon GameLift SDK endpoint connection for a registered compute resource
	// in an Anywhere fleet. The game servers on the compute use this endpoint to
	// connect to the Amazon GameLift service.
	GameLiftServiceSdkEndpoint *string `min:"1" type:"string"`

	// The InstanceID of the Instance hosting the compute for Container and Managed
	// EC2 fleets.
	InstanceId *string `type:"string"`

	// The IP address of a compute resource. Amazon GameLift requires a DNS name
	// or IP address for a compute.
	//
	// IpAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Compute's
	// String and GoString methods.
	IpAddress *string `min:"1" type:"string" sensitive:"true"`

	// The name of the custom location you added to the fleet that this compute
	// resource resides in.
	Location *string `min:"1" type:"string"`

	// The type of operating system on the compute resource.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// The Amazon EC2 instance type that the fleet uses. For registered computes
	// in an Amazon GameLift Anywhere fleet, this property is empty.
	Type *string `type:"string" enum:"EC2InstanceType"`
	// contains filtered or unexported fields
}

This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

An Amazon GameLift compute resource for hosting your game servers. Computes in an Amazon GameLift fleet differs depending on the fleet's compute type property as follows:

  • For EC2 fleets, a compute is an EC2 instance.

  • For ANYWHERE fleets, a compute is a computing resource that you provide and is registered to the fleet.

  • For CONTAINER fleets, a compute is a container that's registered to the fleet.

func (Compute) GoString added in v1.44.151 

func (s Compute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Compute) SetComputeArn added in v1.44.151 

func (s *Compute) SetComputeArn(v string) *Compute

SetComputeArn sets the ComputeArn field's value.

func (*Compute) SetComputeName added in v1.44.151 

func (s *Compute) SetComputeName(v string) *Compute

SetComputeName sets the ComputeName field's value.

func (*Compute) SetComputeStatus added in v1.44.151 

func (s *Compute) SetComputeStatus(v string) *Compute

SetComputeStatus sets the ComputeStatus field's value.

func (*Compute) SetContainerAttributes added in v1.51.28 

func (s *Compute) SetContainerAttributes(v *ContainerAttributes) *Compute

SetContainerAttributes sets the ContainerAttributes field's value.

func (*Compute) SetCreationTime added in v1.44.151 

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

SetCreationTime sets the CreationTime field's value.

func (*Compute) SetDnsName added in v1.44.151 

func (s *Compute) SetDnsName(v string) *Compute

SetDnsName sets the DnsName field's value.

func (*Compute) SetFleetArn added in v1.44.151 

func (s *Compute) SetFleetArn(v string) *Compute

SetFleetArn sets the FleetArn field's value.

func (*Compute) SetFleetId added in v1.44.151 

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

SetFleetId sets the FleetId field's value.

func (*Compute) SetGameLiftAgentEndpoint added in v1.51.28 

func (s *Compute) SetGameLiftAgentEndpoint(v string) *Compute

SetGameLiftAgentEndpoint sets the GameLiftAgentEndpoint field's value.

func (*Compute) SetGameLiftServiceSdkEndpoint added in v1.44.151 

func (s *Compute) SetGameLiftServiceSdkEndpoint(v string) *Compute

SetGameLiftServiceSdkEndpoint sets the GameLiftServiceSdkEndpoint field's value.

func (*Compute) SetInstanceId added in v1.51.28 

func (s *Compute) SetInstanceId(v string) *Compute

SetInstanceId sets the InstanceId field's value.

func (*Compute) SetIpAddress added in v1.44.151 

func (s *Compute) SetIpAddress(v string) *Compute

SetIpAddress sets the IpAddress field's value.

func (*Compute) SetLocation added in v1.44.151 

func (s *Compute) SetLocation(v string) *Compute

SetLocation sets the Location field's value.

func (*Compute) SetOperatingSystem added in v1.44.151 

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

SetOperatingSystem sets the OperatingSystem field's value.

func (*Compute) SetType added in v1.44.151 

func (s *Compute) SetType(v string) *Compute

SetType sets the Type field's value.

func (Compute) String added in v1.44.151 

func (s Compute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException added in v1.28.0 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*ConflictException) Code added in v1.28.0 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.28.0 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.28.0 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.28.0 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.28.0 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.28.0 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.28.0 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.28.0 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionPortRange added in v1.51.28 

type ConnectionPortRange struct {

	// Starting value for the port range.
	//
	// FromPort is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ConnectionPortRange's
	// String and GoString methods.
	//
	// FromPort is a required field
	FromPort *int64 `min:"1" type:"integer" required:"true" sensitive:"true"`

	// Ending value for the port. Port numbers are end-inclusive. This value must
	// be equal to or greater than FromPort.
	//
	// ToPort is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ConnectionPortRange's
	// String and GoString methods.
	//
	// ToPort is a required field
	ToPort *int64 `min:"1" type:"integer" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.

Part of: ContainerGroupsConfiguration, ContainerGroupsAttributes

func (ConnectionPortRange) GoString added in v1.51.28 

func (s ConnectionPortRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionPortRange) SetFromPort added in v1.51.28 

func (s *ConnectionPortRange) SetFromPort(v int64) *ConnectionPortRange

SetFromPort sets the FromPort field's value.

func (*ConnectionPortRange) SetToPort added in v1.51.28 

func (s *ConnectionPortRange) SetToPort(v int64) *ConnectionPortRange

SetToPort sets the ToPort field's value.

func (ConnectionPortRange) String added in v1.51.28 

func (s ConnectionPortRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionPortRange) Validate added in v1.51.28 

func (s *ConnectionPortRange) Validate() error

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

type ContainerAttributes added in v1.51.28 

type ContainerAttributes struct {

	// Describes how container ports map to connection ports on the fleet instance.
	// Incoming traffic connects to a game via a connection port. A ContainerPortMapping
	// directs the traffic from a connection port to a port on the container that
	// hosts the game session.
	ContainerPortMappings []*ContainerPortMapping `type:"list"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Describes attributes of containers that are deployed to a fleet with compute type CONTAINER.

func (ContainerAttributes) GoString added in v1.51.28 

func (s ContainerAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerAttributes) SetContainerPortMappings added in v1.51.28 

func (s *ContainerAttributes) SetContainerPortMappings(v []*ContainerPortMapping) *ContainerAttributes

SetContainerPortMappings sets the ContainerPortMappings field's value.

func (ContainerAttributes) String added in v1.51.28 

func (s ContainerAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerDefinition added in v1.51.28 

type ContainerDefinition struct {

	// A command that's passed to the container on startup. Each argument for the
	// command is an additional string in the array. See the ContainerDefinition::command
	// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command)
	// parameter in the Amazon Elastic Container Service API reference.
	Command []*string `min:"1" type:"list"`

	// The container definition identifier. Container names are unique within a
	// container group definition.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`

	// The number of CPU units that are reserved for the container. Note: 1 vCPU
	// unit equals 1024 CPU units. If no resources are reserved, the container shares
	// the total CPU limit for the container group.
	//
	// Related data type: ContainerGroupDefinition$TotalCpuLimit
	Cpu *int64 `min:"1" type:"integer"`

	// Indicates that the container relies on the status of other containers in
	// the same container group during its startup and shutdown sequences. A container
	// might have dependencies on multiple containers.
	DependsOn []*ContainerDependency `min:"1" type:"list"`

	// The entry point that's passed to the container on startup. If there are multiple
	// arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint
	// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint)
	// parameter in the Amazon Elastic Container Service API Reference.
	EntryPoint []*string `min:"1" type:"list"`

	// A set of environment variables that's passed to the container on startup.
	// See the ContainerDefinition::environment (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment)
	// parameter in the Amazon Elastic Container Service API Reference.
	Environment []*ContainerEnvironment `min:"1" type:"list"`

	// Indicates whether the container is vital to the container group. If an essential
	// container fails, the entire container group is restarted.
	Essential *bool `type:"boolean"`

	// A configuration for a non-terminal health check. A container, which automatically
	// restarts if it stops functioning, also restarts if it fails this health check.
	// If an essential container in the daemon group fails a health check, the entire
	// container group is restarted. The essential container in the replica group
	// doesn't use this health check mechanism, because the Amazon GameLift Agent
	// automatically handles the task.
	HealthCheck *ContainerHealthCheck `type:"structure"`

	// The URI to the image that $short; copied and deployed to a container fleet.
	// For a more specific identifier, see ResolvedImageDigest.
	//
	// ImageUri is a required field
	ImageUri *string `min:"1" type:"string" required:"true"`

	// The amount of memory that Amazon GameLift makes available to the container.
	// If memory limits aren't set for an individual container, the container shares
	// the container group's total memory allocation.
	//
	// Related data type: ContainerGroupDefinition$TotalMemoryLimit
	MemoryLimits *ContainerMemoryLimits `type:"structure"`

	// Defines the ports that are available to assign to processes in the container.
	// For example, a game server process requires a container port to allow game
	// clients to connect to it. Container ports aren't directly accessed by inbound
	// traffic. Amazon GameLift maps these container ports to externally accessible
	// connection ports, which are assigned as needed from the container fleet's
	// ConnectionPortRange.
	PortConfiguration *ContainerPortConfiguration `type:"structure"`

	// A unique and immutable identifier for the container image that is deployed
	// to a container fleet. The digest is a SHA 256 hash of the container image
	// manifest.
	ResolvedImageDigest *string `type:"string"`

	// The directory in the container where commands are run. See the ContainerDefinition::workingDirectory
	// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory)
	// parameter in the Amazon Elastic Container Service API Reference.
	WorkingDirectory *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Describes a container in a container fleet, the resources available to the container, and the commands that are run when the container starts. Container properties can't be updated. To change a property, create a new container group definition. See also ContainerDefinitionInput.

Part of: ContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions

func (ContainerDefinition) GoString added in v1.51.28 

func (s ContainerDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerDefinition) SetCommand added in v1.51.28 

func (s *ContainerDefinition) SetCommand(v []*string) *ContainerDefinition

SetCommand sets the Command field's value.

func (*ContainerDefinition) SetContainerName added in v1.51.28 

func (s *ContainerDefinition) SetContainerName(v string) *ContainerDefinition

SetContainerName sets the ContainerName field's value.

func (*ContainerDefinition) SetCpu added in v1.51.28 

func (s *ContainerDefinition) SetCpu(v int64) *ContainerDefinition

SetCpu sets the Cpu field's value.

func (*ContainerDefinition) SetDependsOn added in v1.51.28 

func (s *ContainerDefinition) SetDependsOn(v []*ContainerDependency) *ContainerDefinition

SetDependsOn sets the DependsOn field's value.

func (*ContainerDefinition) SetEntryPoint added in v1.51.28 

func (s *ContainerDefinition) SetEntryPoint(v []*string) *ContainerDefinition

SetEntryPoint sets the EntryPoint field's value.

func (*ContainerDefinition) SetEnvironment added in v1.51.28 

func (s *ContainerDefinition) SetEnvironment(v []*ContainerEnvironment) *ContainerDefinition

SetEnvironment sets the Environment field's value.

func (*ContainerDefinition) SetEssential added in v1.51.28 

func (s *ContainerDefinition) SetEssential(v bool) *ContainerDefinition

SetEssential sets the Essential field's value.

func (*ContainerDefinition) SetHealthCheck added in v1.51.28 

func (s *ContainerDefinition) SetHealthCheck(v *ContainerHealthCheck) *ContainerDefinition

SetHealthCheck sets the HealthCheck field's value.

func (*ContainerDefinition) SetImageUri added in v1.51.28 

func (s *ContainerDefinition) SetImageUri(v string) *ContainerDefinition

SetImageUri sets the ImageUri field's value.

func (*ContainerDefinition) SetMemoryLimits added in v1.51.28 

func (s *ContainerDefinition) SetMemoryLimits(v *ContainerMemoryLimits) *ContainerDefinition

SetMemoryLimits sets the MemoryLimits field's value.

func (*ContainerDefinition) SetPortConfiguration added in v1.51.28 

func (s *ContainerDefinition) SetPortConfiguration(v *ContainerPortConfiguration) *ContainerDefinition

SetPortConfiguration sets the PortConfiguration field's value.

func (*ContainerDefinition) SetResolvedImageDigest added in v1.51.28 

func (s *ContainerDefinition) SetResolvedImageDigest(v string) *ContainerDefinition

SetResolvedImageDigest sets the ResolvedImageDigest field's value.

func (*ContainerDefinition) SetWorkingDirectory added in v1.51.28 

func (s *ContainerDefinition) SetWorkingDirectory(v string) *ContainerDefinition

SetWorkingDirectory sets the WorkingDirectory field's value.

func (ContainerDefinition) String added in v1.51.28 

func (s ContainerDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerDefinitionInput_ added in v1.51.28 

type ContainerDefinitionInput_ struct {

	// A command to pass to the container on startup. Add multiple arguments as
	// additional strings in the array. See the ContainerDefinition command (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command)
	// parameter in the Amazon Elastic Container Service API reference.
	Command []*string `min:"1" type:"list"`

	// A string that uniquely identifies the container definition within a container
	// group.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`

	// The number of CPU units to reserve for this container. The container can
	// use more resources when needed, if available. Note: 1 vCPU unit equals 1024
	// CPU units. If you don't reserve CPU units for this container, then it shares
	// the total CPU limit for the container group. This property is similar to
	// the Amazon ECS container definition parameter environment (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_environment)
	// (Amazon Elastic Container Service Developer Guide).
	//
	// Related data type: ContainerGroupDefinition$TotalCpuLimit
	Cpu *int64 `min:"1" type:"integer"`

	// Sets up dependencies between this container and the status of other containers
	// in the same container group. A container can have dependencies on multiple
	// different containers.
	//
	// You can use dependencies to establish a startup/shutdown sequence across
	// the container group. A container startup dependency is reversed on shutdown.
	//
	// For example, you might specify that SideCarContainerB has a START dependency
	// on SideCarContainerA. This dependency means that SideCarContainerB can't
	// start until after SideCarContainerA has started. This dependency is reversed
	// on shutdown, which means that SideCarContainerB must shut down before SideCarContainerA
	// can shut down.
	DependsOn []*ContainerDependency `min:"1" type:"list"`

	// An entry point to pass to the container on startup. Add multiple arguments
	// as additional strings in the array. See the ContainerDefinition::entryPoint
	// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint)
	// parameter in the Amazon Elastic Container Service API Reference.
	EntryPoint []*string `min:"1" type:"list"`

	// A set of environment variables to pass to the container on startup. See the
	// ContainerDefinition::environment (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment)
	// parameter in the Amazon Elastic Container Service API Reference.
	Environment []*ContainerEnvironment `min:"1" type:"list"`

	// Specifies whether the container is vital for the container group to function
	// properly. If an essential container fails, it causes the entire container
	// group to restart. Each container group must have an essential container.
	//
	// Replica container groups - A replica group must have exactly one essential
	// container. Use the following to configure an essential replica container:
	//
	//    * Choose a container is running your game server and the Amazon GameLift
	//    Agent.
	//
	//    * Include a port configuration. This container runs your game server processes,
	//    and each process requires a container port to allow access to game clients.
	//
	//    * Don't configure a health check. The Agent handles this task for the
	//    essential replica container.
	//
	// Daemon container groups - A daemon group must have at least one essential
	// container.
	Essential *bool `type:"boolean"`

	// Configuration for a non-terminal health check. A container automatically
	// restarts if it stops functioning. This parameter lets you define additional
	// reasons to consider a container unhealthy and restart it. You can set a health
	// check for any container except for the essential container in the replica
	// container group. If an essential container in the daemon group fails a health
	// check, the entire container group is restarted.
	HealthCheck *ContainerHealthCheck `type:"structure"`

	// The location of a container image that $short; will copy and deploy to a
	// container fleet. Images in Amazon Elastic Container Registry private repositories
	// are supported. The repository must be in the same Amazon Web Services account
	// and Amazon Web Services Region where you're creating the container group
	// definition. For limits on image size, see Amazon GameLift endpoints and quotas
	// (https://docs.aws.amazon.com/general/latest/gr/gamelift.html). You can use
	// any of the following image URI formats:
	//
	//    * Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository
	//    ID]
	//
	//    * Image ID and digest: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository
	//    ID]@[digest]
	//
	//    * Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository
	//    ID]:[tag]
	//
	// ImageUri is a required field
	ImageUri *string `min:"1" type:"string" required:"true"`

	// The amount of memory to make available to the container. If you don't specify
	// memory limits for this container, then it shares the container group's total
	// memory allocation.
	//
	// Related data type: ContainerGroupDefinition$TotalMemoryLimit
	MemoryLimits *ContainerMemoryLimits `type:"structure"`

	// A set of ports that Amazon GameLift can assign to processes in the container.
	// All processes that accept inbound traffic connections, including game server
	// processes, must be assigned a port from this set. The set of ports must be
	// large enough to assign one to each process in the container that needs one.
	// If the container includes your game server, include enough ports to assign
	// one port to each concurrent server process (as defined in a container fleet's
	// RuntimeConfiguration). For more details, see Networking for container fleets
	// (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-network).
	//
	// Container ports aren't directly accessed by inbound traffic. Amazon GameLift
	// maps these container ports to externally accessible connection ports, which
	// are assigned as needed from the container fleet's ConnectionPortRange.
	PortConfiguration *ContainerPortConfiguration `type:"structure"`

	// The directory in the container where commands are run. See the ContainerDefinition::workingDirectory
	// parameter (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory)
	// in the Amazon Elastic Container Service API Reference.
	WorkingDirectory *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Describes a container's configuration, resources, and start instructions. Use this data type to create a container group definition. For the properties of a container that's been deployed to a fleet, see ContainerDefinition. You can't change these properties after you've created the container group definition. If you need a container group with different properties, then you must create a new one.

Used with: CreateContainerGroupDefinition

func (ContainerDefinitionInput_) GoString added in v1.51.28 

func (s ContainerDefinitionInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerDefinitionInput_) SetCommand added in v1.51.28 

func (s *ContainerDefinitionInput_) SetCommand(v []*string) *ContainerDefinitionInput_

SetCommand sets the Command field's value.

func (*ContainerDefinitionInput_) SetContainerName added in v1.51.28 

func (s *ContainerDefinitionInput_) SetContainerName(v string) *ContainerDefinitionInput_

SetContainerName sets the ContainerName field's value.

func (*ContainerDefinitionInput_) SetCpu added in v1.51.28 

func (s *ContainerDefinitionInput_) SetCpu(v int64) *ContainerDefinitionInput_

SetCpu sets the Cpu field's value.

func (*ContainerDefinitionInput_) SetDependsOn added in v1.51.28 

func (s *ContainerDefinitionInput_) SetDependsOn(v []*ContainerDependency) *ContainerDefinitionInput_

SetDependsOn sets the DependsOn field's value.

func (*ContainerDefinitionInput_) SetEntryPoint added in v1.51.28 

func (s *ContainerDefinitionInput_) SetEntryPoint(v []*string) *ContainerDefinitionInput_

SetEntryPoint sets the EntryPoint field's value.

func (*ContainerDefinitionInput_) SetEnvironment added in v1.51.28 

func (s *ContainerDefinitionInput_) SetEnvironment(v []*ContainerEnvironment) *ContainerDefinitionInput_

SetEnvironment sets the Environment field's value.

func (*ContainerDefinitionInput_) SetEssential added in v1.51.28 

func (s *ContainerDefinitionInput_) SetEssential(v bool) *ContainerDefinitionInput_

SetEssential sets the Essential field's value.

func (*ContainerDefinitionInput_) SetHealthCheck added in v1.51.28 

func (s *ContainerDefinitionInput_) SetHealthCheck(v *ContainerHealthCheck) *ContainerDefinitionInput_

SetHealthCheck sets the HealthCheck field's value.

func (*ContainerDefinitionInput_) SetImageUri added in v1.51.28 

func (s *ContainerDefinitionInput_) SetImageUri(v string) *ContainerDefinitionInput_

SetImageUri sets the ImageUri field's value.

func (*ContainerDefinitionInput_) SetMemoryLimits added in v1.51.28 

func (s *ContainerDefinitionInput_) SetMemoryLimits(v *ContainerMemoryLimits) *ContainerDefinitionInput_

SetMemoryLimits sets the MemoryLimits field's value.

func (*ContainerDefinitionInput_) SetPortConfiguration added in v1.51.28 

func (s *ContainerDefinitionInput_) SetPortConfiguration(v *ContainerPortConfiguration) *ContainerDefinitionInput_

SetPortConfiguration sets the PortConfiguration field's value.

func (*ContainerDefinitionInput_) SetWorkingDirectory added in v1.51.28 

func (s *ContainerDefinitionInput_) SetWorkingDirectory(v string) *ContainerDefinitionInput_

SetWorkingDirectory sets the WorkingDirectory field's value.

func (ContainerDefinitionInput_) String added in v1.51.28 

func (s ContainerDefinitionInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerDefinitionInput_) Validate added in v1.51.28 

func (s *ContainerDefinitionInput_) Validate() error

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

type ContainerDependency added in v1.51.28 

type ContainerDependency struct {

	// The condition that the dependency container must reach before the dependent
	// container can start. Valid conditions include:
	//
	//    * START - The dependency container must have started.
	//
	//    * COMPLETE - The dependency container has run to completion (exits). Use
	//    this condition with nonessential containers, such as those that run a
	//    script and then exit. The dependency container can't be an essential container.
	//
	//    * SUCCESS - The dependency container has run to completion and exited
	//    with a zero status. The dependency container can't be an essential container.
	//
	//    * HEALTHY - The dependency container has passed its Docker health check.
	//    Use this condition with dependency containers that have health checks
	//    configured. This condition is confirmed at container group startup only.
	//
	// Condition is a required field
	Condition *string `type:"string" required:"true" enum:"ContainerDependencyCondition"`

	// A descriptive label for the container definition that this container depends
	// on.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

A container's dependency on another container in the same container group. The dependency impacts how the dependent container is able to start or shut down based the status of the other container.

For example, ContainerA is configured with the following dependency: a START dependency on ContainerB. This means that ContainerA can't start until ContainerB has started. It also means that ContainerA must shut down before ContainerB.

Part of: ContainerDefinition

func (ContainerDependency) GoString added in v1.51.28 

func (s ContainerDependency) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerDependency) SetCondition added in v1.51.28 

func (s *ContainerDependency) SetCondition(v string) *ContainerDependency

SetCondition sets the Condition field's value.

func (*ContainerDependency) SetContainerName added in v1.51.28 

func (s *ContainerDependency) SetContainerName(v string) *ContainerDependency

SetContainerName sets the ContainerName field's value.

func (ContainerDependency) String added in v1.51.28 

func (s ContainerDependency) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerDependency) Validate added in v1.51.28 

func (s *ContainerDependency) Validate() error

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

type ContainerEnvironment added in v1.51.28 

type ContainerEnvironment struct {

	// The environment variable name.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The environment variable value.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

An environment variable to set inside a container, in the form of a key-value pair.

Related data type: ContainerDefinition$Environment

func (ContainerEnvironment) GoString added in v1.51.28 

func (s ContainerEnvironment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerEnvironment) SetName added in v1.51.28 

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

SetName sets the Name field's value.

func (*ContainerEnvironment) SetValue added in v1.51.28 

func (s *ContainerEnvironment) SetValue(v string) *ContainerEnvironment

SetValue sets the Value field's value.

func (ContainerEnvironment) String added in v1.51.28 

func (s ContainerEnvironment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerEnvironment) Validate added in v1.51.28 

func (s *ContainerEnvironment) Validate() error

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

type ContainerGroupDefinition added in v1.51.28 

type ContainerGroupDefinition struct {

	// The set of container definitions that are included in the container group.
	ContainerDefinitions []*ContainerDefinition `min:"1" type:"list"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to an Amazon GameLift ContainerGroupDefinition resource.
	// It uniquely identifies the resource across all Amazon Web Services Regions.
	// Format is arn:aws:gamelift:<region>::containergroupdefinition/[container
	// group definition name].
	ContainerGroupDefinitionArn *string `min:"1" type:"string"`

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

	// A descriptive identifier for the container group definition. The name value
	// is unique in an Amazon Web Services Region.
	Name *string `min:"1" type:"string"`

	// The platform required for all containers in the container group definition.
	OperatingSystem *string `type:"string" enum:"ContainerOperatingSystem"`

	// The method for deploying the container group across fleet instances. A replica
	// container group might have multiple copies on each fleet instance. A daemon
	// container group maintains only one copy per fleet instance.
	SchedulingStrategy *string `type:"string" enum:"ContainerSchedulingStrategy"`

	// Current status of the container group definition resource. Values include:
	//
	//    * COPYING -- Amazon GameLift is in the process of making copies of all
	//    container images that are defined in the group. While in this state, the
	//    resource can't be used to create a container fleet.
	//
	//    * READY -- Amazon GameLift has copied the registry images for all containers
	//    that are defined in the group. You can use a container group definition
	//    in this status to create a container fleet.
	//
	//    * FAILED -- Amazon GameLift failed to create a valid container group definition
	//    resource. For more details on the cause of the failure, see StatusReason.
	//    A container group definition resource in failed status will be deleted
	//    within a few minutes.
	Status *string `type:"string" enum:"ContainerGroupDefinitionStatus"`

	// Additional information about a container group definition that's in FAILED
	// status. Possible reasons include:
	//
	//    * An internal issue prevented Amazon GameLift from creating the container
	//    group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.
	//
	//    * An access-denied message means that you don't have permissions to access
	//    the container image on ECR. See IAM permission examples (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html)
	//    for help setting up required IAM permissions for Amazon GameLift.
	//
	//    * The ImageUri value for at least one of the containers in the container
	//    group definition was invalid or not found in the current Amazon Web Services
	//    account.
	//
	//    * At least one of the container images referenced in the container group
	//    definition exceeds the allowed size. For size limits, see Amazon GameLift
	//    endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/gamelift.html).
	//
	//    * At least one of the container images referenced in the container group
	//    definition uses a different operating system than the one defined for
	//    the container group.
	StatusReason *string `min:"1" type:"string"`

	// The amount of CPU units on a fleet instance to allocate for the container
	// group. All containers in the group share these resources. This property is
	// an integer value in CPU units (1 vCPU is equal to 1024 CPU units).
	//
	// You can set additional limits for each ContainerDefinition in the group.
	// If individual containers have limits, this value must be equal to or greater
	// than the sum of all container-specific CPU limits in the group.
	//
	// For more details on memory allocation, see the Container fleet design guide
	// (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet).
	TotalCpuLimit *int64 `min:"128" type:"integer"`

	// The amount of memory (in MiB) on a fleet instance to allocate for the container
	// group. All containers in the group share these resources.
	//
	// You can set additional limits for each ContainerDefinition in the group.
	// If individual containers have limits, this value must meet the following
	// requirements:
	//
	//    * Equal to or greater than the sum of all container-specific soft memory
	//    limits in the group.
	//
	//    * Equal to or greater than any container-specific hard limits in the group.
	//
	// For more details on memory allocation, see the Container fleet design guide
	// (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet).
	TotalMemoryLimit *int64 `min:"4" type:"integer"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

The properties that describe a container group resource. Container group definition properties can't be updated. To change a property, create a new container group definition.

Used with: CreateContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions

func (ContainerGroupDefinition) GoString added in v1.51.28 

func (s ContainerGroupDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerGroupDefinition) SetContainerDefinitions added in v1.51.28 

func (s *ContainerGroupDefinition) SetContainerDefinitions(v []*ContainerDefinition) *ContainerGroupDefinition

SetContainerDefinitions sets the ContainerDefinitions field's value.

func (*ContainerGroupDefinition) SetContainerGroupDefinitionArn added in v1.51.28 

func (s *ContainerGroupDefinition) SetContainerGroupDefinitionArn(v string) *ContainerGroupDefinition

SetContainerGroupDefinitionArn sets the ContainerGroupDefinitionArn field's value.

func (*ContainerGroupDefinition) SetCreationTime added in v1.51.28 

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

SetCreationTime sets the CreationTime field's value.

func (*ContainerGroupDefinition) SetName added in v1.51.28 

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

SetName sets the Name field's value.

func (*ContainerGroupDefinition) SetOperatingSystem added in v1.51.28 

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

SetOperatingSystem sets the OperatingSystem field's value.

func (*ContainerGroupDefinition) SetSchedulingStrategy added in v1.51.28 

func (s *ContainerGroupDefinition) SetSchedulingStrategy(v string) *ContainerGroupDefinition

SetSchedulingStrategy sets the SchedulingStrategy field's value.

func (*ContainerGroupDefinition) SetStatus added in v1.51.28 

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

SetStatus sets the Status field's value.

func (*ContainerGroupDefinition) SetStatusReason added in v1.51.28 

func (s *ContainerGroupDefinition) SetStatusReason(v string) *ContainerGroupDefinition

SetStatusReason sets the StatusReason field's value.

func (*ContainerGroupDefinition) SetTotalCpuLimit added in v1.51.28 

func (s *ContainerGroupDefinition) SetTotalCpuLimit(v int64) *ContainerGroupDefinition

SetTotalCpuLimit sets the TotalCpuLimit field's value.

func (*ContainerGroupDefinition) SetTotalMemoryLimit added in v1.51.28 

func (s *ContainerGroupDefinition) SetTotalMemoryLimit(v int64) *ContainerGroupDefinition

SetTotalMemoryLimit sets the TotalMemoryLimit field's value.

func (ContainerGroupDefinition) String added in v1.51.28 

func (s ContainerGroupDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerGroupDefinitionProperty added in v1.51.28 

type ContainerGroupDefinitionProperty struct {

	// The unique identifier for the container group definition.
	ContainerGroupDefinitionName *string `min:"1" type:"string"`

	// The method for scheduling and maintaining copies of the container group across
	// a container fleet.
	SchedulingStrategy *string `type:"string" enum:"ContainerSchedulingStrategy"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

The properties of a container group that is deployed to a container fleet.

Part of: ContainerGroupsAttributes

Returned by: DescribeFleetAttributes

func (ContainerGroupDefinitionProperty) GoString added in v1.51.28 

func (s ContainerGroupDefinitionProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerGroupDefinitionProperty) SetContainerGroupDefinitionName added in v1.51.28 

func (s *ContainerGroupDefinitionProperty) SetContainerGroupDefinitionName(v string) *ContainerGroupDefinitionProperty

SetContainerGroupDefinitionName sets the ContainerGroupDefinitionName field's value.

func (*ContainerGroupDefinitionProperty) SetSchedulingStrategy added in v1.51.28 

func (s *ContainerGroupDefinitionProperty) SetSchedulingStrategy(v string) *ContainerGroupDefinitionProperty

SetSchedulingStrategy sets the SchedulingStrategy field's value.

func (ContainerGroupDefinitionProperty) String added in v1.51.28 

func (s ContainerGroupDefinitionProperty) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerGroupsAttributes added in v1.51.28 

type ContainerGroupsAttributes struct {

	// A set of ports that allow inbound traffic to connect to processes running
	// in the fleet's container groups. Amazon GameLift maps each connection port
	// to a container port, which is assigned to a specific container process. A
	// fleet's connection port range can't be changed, but you can control access
	// to connection ports by updating a fleet's EC2InboundPermissions with UpdateFleetPortSettings.
	ConnectionPortRange *ConnectionPortRange `type:"structure"`

	// A collection of properties that describe each container group in the fleet.
	// A container fleet is deployed with one or more ContainerGroupDefinition resources,
	// which is where these properties are set.
	ContainerGroupDefinitionProperties []*ContainerGroupDefinitionProperty `type:"list"`

	// Details about the number of replica container groups that Amazon GameLift
	// deploys to each instance in the container fleet.
	ContainerGroupsPerInstance *ContainerGroupsPerInstance `type:"structure"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

The properties of container groups that are running on a container fleet. Container group properties for a fleet can't be changed.

Returned by: DescribeFleetAttributes, CreateFleet

func (ContainerGroupsAttributes) GoString added in v1.51.28 

func (s ContainerGroupsAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerGroupsAttributes) SetConnectionPortRange added in v1.51.28 

func (s *ContainerGroupsAttributes) SetConnectionPortRange(v *ConnectionPortRange) *ContainerGroupsAttributes

SetConnectionPortRange sets the ConnectionPortRange field's value.

func (*ContainerGroupsAttributes) SetContainerGroupDefinitionProperties added in v1.51.28 

func (s *ContainerGroupsAttributes) SetContainerGroupDefinitionProperties(v []*ContainerGroupDefinitionProperty) *ContainerGroupsAttributes

SetContainerGroupDefinitionProperties sets the ContainerGroupDefinitionProperties field's value.

func (*ContainerGroupsAttributes) SetContainerGroupsPerInstance added in v1.51.28 

func (s *ContainerGroupsAttributes) SetContainerGroupsPerInstance(v *ContainerGroupsPerInstance) *ContainerGroupsAttributes

SetContainerGroupsPerInstance sets the ContainerGroupsPerInstance field's value.

func (ContainerGroupsAttributes) String added in v1.51.28 

func (s ContainerGroupsAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerGroupsConfiguration added in v1.51.28 

type ContainerGroupsConfiguration struct {

	// A set of ports to allow inbound traffic, including game clients, to connect
	// to processes running in the container fleet.
	//
	// Connection ports are dynamically mapped to container ports, which are assigned
	// to individual processes running in a container. The connection port range
	// must have enough ports to map to all container ports across a fleet instance.
	// To calculate the minimum connection ports needed, use the following formula:
	//
	// [Total number of container ports as defined for containers in the replica
	// container group] * [Desired or calculated number of replica container groups
	// per instance] + [Total number of container ports as defined for containers
	// in the daemon container group]
	//
	// As a best practice, double the minimum number of connection ports.
	//
	// Use the fleet's EC2InboundPermissions property to control external access
	// to connection ports. Set this property to the connection port numbers that
	// you want to open access to. See IpPermission for more details.
	//
	// ConnectionPortRange is a required field
	ConnectionPortRange *ConnectionPortRange `type:"structure" required:"true"`

	// The list of container group definition names to deploy to a new container
	// fleet.
	//
	// ContainerGroupDefinitionNames is a required field
	ContainerGroupDefinitionNames []*string `min:"1" type:"list" required:"true"`

	// The number of times to replicate the replica container group on each instance
	// in a container fleet. By default, Amazon GameLift calculates the maximum
	// number of replica container groups that can fit on a fleet instance (based
	// on CPU and memory resources). Leave this parameter empty if you want to use
	// the maximum number, or specify a desired number to override the maximum.
	// The desired number is used if it's less than the maximum number.
	DesiredReplicaContainerGroupsPerInstance *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Configuration details for a set of container groups, for use when creating a fleet with compute type CONTAINER.

Used with: CreateFleet

func (ContainerGroupsConfiguration) GoString added in v1.51.28 

func (s ContainerGroupsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerGroupsConfiguration) SetConnectionPortRange added in v1.51.28 

func (s *ContainerGroupsConfiguration) SetConnectionPortRange(v *ConnectionPortRange) *ContainerGroupsConfiguration

SetConnectionPortRange sets the ConnectionPortRange field's value.

func (*ContainerGroupsConfiguration) SetContainerGroupDefinitionNames added in v1.51.28 

func (s *ContainerGroupsConfiguration) SetContainerGroupDefinitionNames(v []*string) *ContainerGroupsConfiguration

SetContainerGroupDefinitionNames sets the ContainerGroupDefinitionNames field's value.

func (*ContainerGroupsConfiguration) SetDesiredReplicaContainerGroupsPerInstance added in v1.51.28 

func (s *ContainerGroupsConfiguration) SetDesiredReplicaContainerGroupsPerInstance(v int64) *ContainerGroupsConfiguration

SetDesiredReplicaContainerGroupsPerInstance sets the DesiredReplicaContainerGroupsPerInstance field's value.

func (ContainerGroupsConfiguration) String added in v1.51.28 

func (s ContainerGroupsConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerGroupsConfiguration) Validate added in v1.51.28 

func (s *ContainerGroupsConfiguration) Validate() error

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

type ContainerGroupsPerInstance added in v1.51.28 

type ContainerGroupsPerInstance struct {

	// The desired number of replica container groups to place on each fleet instance.
	DesiredReplicaContainerGroupsPerInstance *int64 `min:"1" type:"integer"`

	// The maximum possible number of replica container groups that each fleet instance
	// can have.
	MaxReplicaContainerGroupsPerInstance *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Determines how many replica container groups that Amazon GameLift deploys to each instance in a container fleet.

Amazon GameLift calculates the maximum possible replica groups per instance based on the instance 's CPU and memory resources. When deploying a fleet, Amazon GameLift places replica container groups on each fleet instance based on the following:

  • If no desired value is set, Amazon GameLift places the calculated maximum.

  • If a desired number is set to a value higher than the calculated maximum, Amazon GameLift places the calculated maximum.

  • If a desired number is set to a value lower than the calculated maximum, Amazon GameLift places the desired number.

Part of: ContainerGroupsConfiguration, ContainerGroupsAttributes

Returned by: DescribeFleetAttributes, CreateFleet

func (ContainerGroupsPerInstance) GoString added in v1.51.28 

func (s ContainerGroupsPerInstance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerGroupsPerInstance) SetDesiredReplicaContainerGroupsPerInstance added in v1.51.28 

func (s *ContainerGroupsPerInstance) SetDesiredReplicaContainerGroupsPerInstance(v int64) *ContainerGroupsPerInstance

SetDesiredReplicaContainerGroupsPerInstance sets the DesiredReplicaContainerGroupsPerInstance field's value.

func (*ContainerGroupsPerInstance) SetMaxReplicaContainerGroupsPerInstance added in v1.51.28 

func (s *ContainerGroupsPerInstance) SetMaxReplicaContainerGroupsPerInstance(v int64) *ContainerGroupsPerInstance

SetMaxReplicaContainerGroupsPerInstance sets the MaxReplicaContainerGroupsPerInstance field's value.

func (ContainerGroupsPerInstance) String added in v1.51.28 

func (s ContainerGroupsPerInstance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerHealthCheck added in v1.51.28 

type ContainerHealthCheck struct {

	// A string array that specifies the command that the container runs to determine
	// if it's healthy.
	//
	// Command is a required field
	Command []*string `min:"1" type:"list" required:"true"`

	// The time period (in seconds) between each health check.
	Interval *int64 `min:"60" type:"integer"`

	// The number of times to retry a failed health check before the container is
	// considered unhealthy. The first run of the command does not count as a retry.
	Retries *int64 `min:"5" type:"integer"`

	// The optional grace period (in seconds) to give a container time to bootstrap
	// before the first failed health check counts toward the number of retries.
	StartPeriod *int64 `type:"integer"`

	// The time period (in seconds) to wait for a health check to succeed before
	// a failed health check is counted.
	Timeout *int64 `min:"30" type:"integer"`
	// contains filtered or unexported fields
}

Instructions on when and how to check the health of a container in a container fleet. When health check properties are set in a container definition, they override any Docker health checks in the container image. For more information on container health checks, see HealthCheck command (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html#ECS-Type-HealthCheck-command) in the Amazon Elastic Container Service API.

The following example instructions tell the container to wait 100 seconds after launch before counting failed health checks, then initiate the health check command every 60 seconds. After issuing the health check command, wait 10 seconds for it to succeed. If it fails, retry the command 3 times before considering the container to be unhealthy.

{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], "Interval": 300, "Timeout": 30, "Retries": 5, "StartPeriod": 100 }

Part of: ContainerDefinition$HealthCheck

func (ContainerHealthCheck) GoString added in v1.51.28 

func (s ContainerHealthCheck) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerHealthCheck) SetCommand added in v1.51.28 

func (s *ContainerHealthCheck) SetCommand(v []*string) *ContainerHealthCheck

SetCommand sets the Command field's value.

func (*ContainerHealthCheck) SetInterval added in v1.51.28 

func (s *ContainerHealthCheck) SetInterval(v int64) *ContainerHealthCheck

SetInterval sets the Interval field's value.

func (*ContainerHealthCheck) SetRetries added in v1.51.28 

func (s *ContainerHealthCheck) SetRetries(v int64) *ContainerHealthCheck

SetRetries sets the Retries field's value.

func (*ContainerHealthCheck) SetStartPeriod added in v1.51.28 

func (s *ContainerHealthCheck) SetStartPeriod(v int64) *ContainerHealthCheck

SetStartPeriod sets the StartPeriod field's value.

func (*ContainerHealthCheck) SetTimeout added in v1.51.28 

func (s *ContainerHealthCheck) SetTimeout(v int64) *ContainerHealthCheck

SetTimeout sets the Timeout field's value.

func (ContainerHealthCheck) String added in v1.51.28 

func (s ContainerHealthCheck) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerHealthCheck) Validate added in v1.51.28 

func (s *ContainerHealthCheck) Validate() error

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

type ContainerMemoryLimits added in v1.51.28 

type ContainerMemoryLimits struct {

	// The maximum amount of memory that the container can use. If a container attempts
	// to exceed this limit, the container is stopped. This property is similar
	// to the Amazon ECS container definition parameter memory (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_memory)
	// in the Amazon Elastic Container Service Developer Guide.
	HardLimit *int64 `min:"4" type:"integer"`

	// The amount of memory that is reserved for a container. When the container
	// group's shared memory is under contention, the system attempts to maintain
	// the container memory usage at this soft limit. However, the container can
	// use more memory when needed, if available. This property is similar to the
	// Amazon ECS container definition parameter memoryreservation (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#ContainerDefinition-memoryReservation)
	// (Amazon Elastic Container Service Developer Guide).
	SoftLimit *int64 `min:"4" type:"integer"`
	// contains filtered or unexported fields
}

Specifies how much memory is available to a container. You can't change this value after you create this object.

Part of: ContainerDefinition$MemoryLimits

func (ContainerMemoryLimits) GoString added in v1.51.28 

func (s ContainerMemoryLimits) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerMemoryLimits) SetHardLimit added in v1.51.28 

func (s *ContainerMemoryLimits) SetHardLimit(v int64) *ContainerMemoryLimits

SetHardLimit sets the HardLimit field's value.

func (*ContainerMemoryLimits) SetSoftLimit added in v1.51.28 

func (s *ContainerMemoryLimits) SetSoftLimit(v int64) *ContainerMemoryLimits

SetSoftLimit sets the SoftLimit field's value.

func (ContainerMemoryLimits) String added in v1.51.28 

func (s ContainerMemoryLimits) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerMemoryLimits) Validate added in v1.51.28 

func (s *ContainerMemoryLimits) Validate() error

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

type ContainerPortConfiguration added in v1.51.28 

type ContainerPortConfiguration struct {

	// Specifies one or more ranges of ports on a container. These ranges must not
	// overlap.
	//
	// ContainerPortRanges is a required field
	ContainerPortRanges []*ContainerPortRange `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Defines ranges of ports that server processes can connect to.

Part of: ContainerDefinition$PortConfiguration

func (ContainerPortConfiguration) GoString added in v1.51.28 

func (s ContainerPortConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerPortConfiguration) SetContainerPortRanges added in v1.51.28 

func (s *ContainerPortConfiguration) SetContainerPortRanges(v []*ContainerPortRange) *ContainerPortConfiguration

SetContainerPortRanges sets the ContainerPortRanges field's value.

func (ContainerPortConfiguration) String added in v1.51.28 

func (s ContainerPortConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerPortConfiguration) Validate added in v1.51.28 

func (s *ContainerPortConfiguration) Validate() error

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

type ContainerPortMapping added in v1.51.28 

type ContainerPortMapping struct {

	// The port opened on the fleet instance. This is also called the "host port".
	//
	// ConnectionPort is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ContainerPortMapping's
	// String and GoString methods.
	ConnectionPort *int64 `min:"1" type:"integer" sensitive:"true"`

	// The port opened on the container.
	//
	// ContainerPort is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ContainerPortMapping's
	// String and GoString methods.
	ContainerPort *int64 `min:"1" type:"integer" sensitive:"true"`

	// The network protocol that this mapping supports.
	Protocol *string `type:"string" enum:"IpProtocol"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Defines how an internal-facing container port is mapped to an external-facing connection port on a fleet instance of compute type CONTAINER. Incoming traffic, such as a game client, uses a connection port to connect to a process in the container fleet. Amazon GameLift directs the inbound traffic to the container port that is assigned to the process, such as a game session, running on a container.

Part of: ContainerAttributes

func (ContainerPortMapping) GoString added in v1.51.28 

func (s ContainerPortMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerPortMapping) SetConnectionPort added in v1.51.28 

func (s *ContainerPortMapping) SetConnectionPort(v int64) *ContainerPortMapping

SetConnectionPort sets the ConnectionPort field's value.

func (*ContainerPortMapping) SetContainerPort added in v1.51.28 

func (s *ContainerPortMapping) SetContainerPort(v int64) *ContainerPortMapping

SetContainerPort sets the ContainerPort field's value.

func (*ContainerPortMapping) SetProtocol added in v1.51.28 

func (s *ContainerPortMapping) SetProtocol(v string) *ContainerPortMapping

SetProtocol sets the Protocol field's value.

func (ContainerPortMapping) String added in v1.51.28 

func (s ContainerPortMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerPortRange added in v1.51.28 

type ContainerPortRange struct {

	// A starting value for the range of allowed port numbers.
	//
	// FromPort is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ContainerPortRange's
	// String and GoString methods.
	//
	// FromPort is a required field
	FromPort *int64 `min:"1" type:"integer" required:"true" sensitive:"true"`

	// The network protocol that these ports support.
	//
	// Protocol is a required field
	Protocol *string `type:"string" required:"true" enum:"IpProtocol"`

	// An ending value for the range of allowed port numbers. Port numbers are end-inclusive.
	// This value must be equal to or greater than FromPort.
	//
	// ToPort is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ContainerPortRange's
	// String and GoString methods.
	//
	// ToPort is a required field
	ToPort *int64 `min:"1" type:"integer" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

A set of one or more port numbers that can be opened on the container.

Part of: ContainerPortConfiguration

func (ContainerPortRange) GoString added in v1.51.28 

func (s ContainerPortRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerPortRange) SetFromPort added in v1.51.28 

func (s *ContainerPortRange) SetFromPort(v int64) *ContainerPortRange

SetFromPort sets the FromPort field's value.

func (*ContainerPortRange) SetProtocol added in v1.51.28 

func (s *ContainerPortRange) SetProtocol(v string) *ContainerPortRange

SetProtocol sets the Protocol field's value.

func (*ContainerPortRange) SetToPort added in v1.51.28 

func (s *ContainerPortRange) SetToPort(v int64) *ContainerPortRange

SetToPort sets the ToPort field's value.

func (ContainerPortRange) String added in v1.51.28 

func (s ContainerPortRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerPortRange) Validate added in v1.51.28 

func (s *ContainerPortRange) Validate() error

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

type CreateAliasInput 

type CreateAliasInput struct {

	// A human-readable description of the alias.
	Description *string `min:"1" type:"string"`

	// A descriptive label that is 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"`

	// The routing configuration, including routing type and fleet target, for the
	// alias.
	//
	// RoutingStrategy is a required field
	RoutingStrategy *RoutingStrategy `type:"structure" required:"true"`

	// A list of labels to assign to the new alias resource. Tags are developer-defined
	// key-value pairs. Tagging Amazon Web Services resources are useful for resource
	// management, access management and cost allocation. For more information,
	// see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateAliasInput) GoString 

func (s CreateAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetTags added in v1.26.6 

func (s *CreateAliasInput) SetTags(v []*Tag) *CreateAliasInput

SetTags sets the Tags field's value.

func (CreateAliasInput) String 

func (s CreateAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The newly created alias resource.
	Alias *Alias `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateAliasOutput) GoString 

func (s CreateAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateBuildInput 

type CreateBuildInput struct {

	// A descriptive label associated with a build. Build names don't need to be
	// unique. You can change this value later.
	Name *string `min:"1" type:"string"`

	// The operating system that your game server binaries run on. This value determines
	// the type of fleet resources that you use for this build. If your game build
	// contains multiple executables, they all must run on the same operating system.
	// You must specify a valid operating system in this request. There is no default
	// value. You can't change a build's operating system later.
	//
	// If you have active fleets using the Windows Server 2012 operating system,
	// you can continue to create new builds using this OS until October 10, 2023,
	// when Microsoft ends its support. All others must use Windows Server 2016
	// when creating new Windows-based builds.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// A server SDK version you used when integrating your game server build with
	// Amazon GameLift. For more information see Integrate games with custom game
	// servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html).
	// By default Amazon GameLift sets this value to 4.0.2.
	ServerSdkVersion *string `type:"string"`

	// Information indicating where your game build files are stored. Use this parameter
	// only when creating a build with files stored in an Amazon S3 bucket that
	// you own. The storage location must specify an Amazon S3 bucket name and key.
	// The location must also specify a role ARN that you set up to allow Amazon
	// GameLift to access your Amazon S3 bucket. The S3 bucket and your new build
	// must be in the same Region.
	//
	// If a StorageLocation is specified, the size of your file can be found in
	// your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.
	StorageLocation *S3Location `type:"structure"`

	// A list of labels to assign to the new build resource. Tags are developer
	// defined key-value pairs. Tagging Amazon Web Services resources are useful
	// for resource management, access management and cost allocation. For more
	// information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference. Once the resource is created,
	// you can use TagResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html),
	// UntagResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html),
	// and ListTagsForResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html)
	// to add, remove, and view tags. The maximum tag limit may be lower than stated.
	// See the Amazon Web Services General Reference for actual tagging limits.
	Tags []*Tag `type:"list"`

	// Version information associated with a build or script. Version strings don't
	// need to be unique. You can change this value later.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateBuildInput) GoString 

func (s CreateBuildInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetServerSdkVersion added in v1.44.151 

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

SetServerSdkVersion sets the ServerSdkVersion 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) SetTags added in v1.26.6 

func (s *CreateBuildInput) SetTags(v []*Tag) *CreateBuildInput

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The newly created build resource, including a unique build IDs and status.
	Build *Build `type:"structure"`

	// Amazon S3 location for your game build file, including bucket name and key.
	StorageLocation *S3Location `type:"structure"`

	// This element is returned only when the operation is called without a storage
	// location. It contains credentials to use when you are uploading a build file
	// to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have
	// a limited life span. To refresh these credentials, call RequestUploadCredentials
	// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html).
	//
	// UploadCredentials is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateBuildOutput's
	// String and GoString methods.
	UploadCredentials *AwsCredentials `type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreateBuildOutput) GoString 

func (s CreateBuildOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateContainerGroupDefinitionInput added in v1.51.28 

type CreateContainerGroupDefinitionInput struct {

	// Definitions for all containers in this group. Each container definition identifies
	// the container image and specifies configuration settings for the container.
	// See the Container fleet design guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet.html)
	// for container guidelines.
	//
	// ContainerDefinitions is a required field
	ContainerDefinitions []*ContainerDefinitionInput_ `min:"1" type:"list" required:"true"`

	// A descriptive identifier for the container group definition. The name value
	// must be unique in an Amazon Web Services Region.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The platform that is used by containers in the container group definition.
	// All containers in a group must run on the same operating system.
	//
	// OperatingSystem is a required field
	OperatingSystem *string `type:"string" required:"true" enum:"ContainerOperatingSystem"`

	// The method for deploying the container group across fleet instances. A replica
	// container group might have multiple copies on each fleet instance. A daemon
	// container group has one copy per fleet instance. Default value is REPLICA.
	SchedulingStrategy *string `type:"string" enum:"ContainerSchedulingStrategy"`

	// A list of labels to assign to the container group definition resource. Tags
	// are developer-defined key-value pairs. Tagging Amazon Web Services resources
	// are useful for resource management, access management and cost allocation.
	// For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference.
	Tags []*Tag `type:"list"`

	// The maximum amount of CPU units to allocate to the container group. Set this
	// parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units).
	// All containers in the group share this memory. If you specify CPU limits
	// for individual containers, set this parameter based on the following guidelines.
	// The value must be equal to or greater than the sum of the CPU limits for
	// all containers in the group.
	//
	// TotalCpuLimit is a required field
	TotalCpuLimit *int64 `min:"128" type:"integer" required:"true"`

	// The maximum amount of memory (in MiB) to allocate to the container group.
	// All containers in the group share this memory. If you specify memory limits
	// for individual containers, set this parameter based on the following guidelines.
	// The value must be (1) greater than the sum of the soft memory limits for
	// all containers in the group, and (2) greater than any individual container's
	// hard memory limit.
	//
	// TotalMemoryLimit is a required field
	TotalMemoryLimit *int64 `min:"4" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (CreateContainerGroupDefinitionInput) GoString added in v1.51.28 

func (s CreateContainerGroupDefinitionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContainerGroupDefinitionInput) SetContainerDefinitions added in v1.51.28 

func (s *CreateContainerGroupDefinitionInput) SetContainerDefinitions(v []*ContainerDefinitionInput_) *CreateContainerGroupDefinitionInput

SetContainerDefinitions sets the ContainerDefinitions field's value.

func (*CreateContainerGroupDefinitionInput) SetName added in v1.51.28 

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

SetName sets the Name field's value.

func (*CreateContainerGroupDefinitionInput) SetOperatingSystem added in v1.51.28 

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

SetOperatingSystem sets the OperatingSystem field's value.

func (*CreateContainerGroupDefinitionInput) SetSchedulingStrategy added in v1.51.28 

func (s *CreateContainerGroupDefinitionInput) SetSchedulingStrategy(v string) *CreateContainerGroupDefinitionInput

SetSchedulingStrategy sets the SchedulingStrategy field's value.

func (*CreateContainerGroupDefinitionInput) SetTags added in v1.51.28 

func (s *CreateContainerGroupDefinitionInput) SetTags(v []*Tag) *CreateContainerGroupDefinitionInput

SetTags sets the Tags field's value.

func (*CreateContainerGroupDefinitionInput) SetTotalCpuLimit added in v1.51.28 

func (s *CreateContainerGroupDefinitionInput) SetTotalCpuLimit(v int64) *CreateContainerGroupDefinitionInput

SetTotalCpuLimit sets the TotalCpuLimit field's value.

func (*CreateContainerGroupDefinitionInput) SetTotalMemoryLimit added in v1.51.28 

func (s *CreateContainerGroupDefinitionInput) SetTotalMemoryLimit(v int64) *CreateContainerGroupDefinitionInput

SetTotalMemoryLimit sets the TotalMemoryLimit field's value.

func (CreateContainerGroupDefinitionInput) String added in v1.51.28 

func (s CreateContainerGroupDefinitionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContainerGroupDefinitionInput) Validate added in v1.51.28 

func (s *CreateContainerGroupDefinitionInput) Validate() error

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

type CreateContainerGroupDefinitionOutput added in v1.51.28 

type CreateContainerGroupDefinitionOutput struct {

	// The properties of the newly created container group definition resource.
	// You use this resource to create a container fleet.
	ContainerGroupDefinition *ContainerGroupDefinition `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateContainerGroupDefinitionOutput) GoString added in v1.51.28 

func (s CreateContainerGroupDefinitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContainerGroupDefinitionOutput) SetContainerGroupDefinition added in v1.51.28 

func (s *CreateContainerGroupDefinitionOutput) SetContainerGroupDefinition(v *ContainerGroupDefinition) *CreateContainerGroupDefinitionOutput

SetContainerGroupDefinition sets the ContainerGroupDefinition field's value.

func (CreateContainerGroupDefinitionOutput) String added in v1.51.28 

func (s CreateContainerGroupDefinitionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFleetInput 

type CreateFleetInput struct {

	// Amazon GameLift Anywhere configuration options.
	AnywhereConfiguration *AnywhereConfiguration `type:"structure"`

	// The unique identifier for a custom game server build to be deployed to a
	// fleet with compute type EC2. You can use either the build ID or ARN. The
	// build must be uploaded to Amazon GameLift and in READY status. This fleet
	// property can't be changed after the fleet is created.
	BuildId *string `type:"string"`

	// Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
	// Amazon GameLift uses the certificates to encrypt traffic between game clients
	// and the game servers running on Amazon GameLift. By default, the CertificateConfiguration
	// is DISABLED. You can't change this property after you create the fleet.
	//
	// Certificate Manager (ACM) certificates expire after 13 months. Certificate
	// expiration can cause fleets to fail, preventing players from connecting to
	// instances in the fleet. We recommend you replace fleets before 13 months,
	// consider using fleet aliases for a smooth transition.
	//
	// ACM isn't available in all Amazon Web Services regions. A fleet creation
	// request with certificate generation enabled in an unsupported Region, fails
	// with a 4xx error. For more information about the supported Regions, see Supported
	// Regions (https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html)
	// in the Certificate Manager User Guide.
	CertificateConfiguration *CertificateConfiguration `type:"structure"`

	// The type of compute resource used to host your game servers.
	//
	//    * EC2 – The game server build is deployed to Amazon EC2 instances for
	//    cloud hosting. This is the default setting.
	//
	//    * CONTAINER – Container images with your game server build and supporting
	//    software are deployed to Amazon EC2 instances for cloud hosting. With
	//    this compute type, you must specify the ContainerGroupsConfiguration parameter.
	//
	//    * ANYWHERE – Game servers or container images with your game server
	//    and supporting software are deployed to compute resources that are provided
	//    and managed by you. With this compute type, you can also set the AnywhereConfiguration
	//    parameter.
	ComputeType *string `type:"string" enum:"ComputeType"`

	// The container groups to deploy to instances in the container fleet and other
	// fleet-level configuration settings. Use the CreateContainerGroupDefinition
	// action to create container groups. A container fleet must have exactly one
	// replica container group, and can optionally have one daemon container group.
	// You can't change this property after you create the fleet.
	ContainerGroupsConfiguration *ContainerGroupsConfiguration `type:"structure"`

	// A description for the fleet.
	Description *string `min:"1" type:"string"`

	// The IP address ranges and port settings that allow inbound traffic to access
	// game server processes and other processes on this fleet. Set this parameter
	// for EC2 and container fleets. You can leave this parameter empty when creating
	// the fleet, but you must call UpdateFleetPortSettings to set it before players
	// can connect to game sessions. As a best practice, we recommend opening ports
	// for remote access only when you need them and closing them when you're finished.
	// For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP
	// ranges.
	//
	// To manage inbound access for a container fleet, set this parameter to the
	// same port numbers that you set for the fleet's connection port range. During
	// the life of the fleet, update this parameter to control which connection
	// ports are open to inbound traffic.
	EC2InboundPermissions []*IpPermission `type:"list"`

	// The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and
	// container fleets. Instance type determines the computing resources that will
	// be used to host your game servers, including CPU, memory, storage, and networking
	// capacity. See Amazon Elastic Compute Cloud Instance Types (http://aws.amazon.com/ec2/instance-types/)
	// for detailed descriptions of Amazon EC2 instance types.
	EC2InstanceType *string `type:"string" enum:"EC2InstanceType"`

	// Indicates whether to use On-Demand or Spot instances for this fleet. By default,
	// this property is set to ON_DEMAND. Learn more about when to use On-Demand
	// versus Spot Instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot).
	// This fleet property can't be changed after the fleet is created.
	FleetType *string `type:"string" enum:"FleetType"`

	// A unique identifier for an IAM role with access permissions to other Amazon
	// Web Services services. Any application that runs on an instance in the fleet--including
	// install scripts, server processes, and other processes--can use these permissions
	// to interact with Amazon Web Services resources that you own or have access
	// to. For more information about using the role with your game server builds,
	// see Communicate with other Amazon Web Services resources from your fleets
	// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html).
	// This fleet property can't be changed after the fleet is created.
	InstanceRoleArn *string `min:"1" type:"string"`

	// Prompts Amazon GameLift to generate a shared credentials file for the IAM
	// role that's defined in InstanceRoleArn. The shared credentials file is stored
	// on each fleet instance and refreshed as needed. Use shared credentials for
	// applications that are deployed along with the game server executable, if
	// the game server is integrated with server SDK version 5.x. For more information
	// about using shared credentials, see Communicate with other Amazon Web Services
	// resources from your fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html).
	InstanceRoleCredentialsProvider *string `type:"string" enum:"InstanceRoleCredentialsProvider"`

	// A set of remote locations to deploy additional instances to and manage as
	// part of the fleet. This parameter can only be used when creating fleets in
	// Amazon Web Services Regions that support multiple locations. You can add
	// any Amazon GameLift-supported Amazon Web Services Region as a remote location,
	// in the form of an Amazon Web Services Region code, such as us-west-2 or Local
	// Zone code. To create a fleet with instances in the home Region only, don't
	// set this parameter.
	//
	// When using this parameter, Amazon GameLift requires you to include your home
	// location in the request.
	Locations []*LocationConfiguration `min:"1" type:"list"`

	// This parameter is no longer used. To specify where Amazon GameLift should
	// store log files once a server process shuts down, use the Amazon GameLift
	// server API ProcessReady() and specify one or more directory paths in logParameters.
	// For more information, see Initialize the server process (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize)
	// in the Amazon GameLift Developer Guide.
	LogPaths []*string `type:"list"`

	// The name of an Amazon Web Services CloudWatch metric group to add this fleet
	// to. A metric group is used to aggregate the metrics for multiple fleets.
	// You can specify an existing metric group name or set a new name to create
	// a new metric group. A fleet can be included in only one metric group at a
	// time.
	MetricGroups []*string `type:"list"`

	// A descriptive label that is 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"`

	// The status of termination protection for active game sessions on the fleet.
	// By default, this property is set to NoProtection. You can also set game session
	// protection for an individual game session by calling UpdateGameSession (gamelift/latest/apireference/API_UpdateGameSession.html).
	//
	//    * NoProtection - Game sessions can be terminated during active gameplay
	//    as a result of a scale-down event.
	//
	//    * FullProtection - Game sessions in ACTIVE status cannot be terminated
	//    during a scale-down event.
	NewGameSessionProtectionPolicy *string `type:"string" enum:"ProtectionPolicy"`

	// Used when peering your Amazon GameLift fleet with a VPC, the unique identifier
	// for the Amazon Web Services account that owns the VPC. You can find your
	// account ID in the Amazon Web Services Management Console under account settings.
	PeerVpcAwsAccountId *string `min:"1" type:"string"`

	// A unique identifier for a VPC with resources to be accessed by your Amazon
	// GameLift fleet. The VPC must be in the same Region as your fleet. To look
	// up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/)
	// in the Amazon Web Services Management Console. Learn more about VPC peering
	// in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html).
	PeerVpcId *string `min:"1" type:"string"`

	// A policy that limits the number of game sessions that an individual player
	// can create on instances in this fleet within a specified span of time.
	ResourceCreationLimitPolicy *ResourceCreationLimitPolicy `type:"structure"`

	// Instructions for how to launch and run server processes on the fleet. Set
	// runtime configuration for EC2 fleets and container fleets. For an Anywhere
	// fleets, set this parameter only if the fleet is running the Amazon GameLift
	// Agent. The runtime configuration defines one or more server process configurations.
	// Each server process identifies a game executable or Realtime script file
	// and the number of processes to run concurrently.
	//
	// This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters,
	// which are still supported for backward compatibility.
	RuntimeConfiguration *RuntimeConfiguration `type:"structure"`

	// The unique identifier for a Realtime configuration script to be deployed
	// to a fleet with compute type EC2. You can use either the script ID or ARN.
	// Scripts must be uploaded to Amazon GameLift prior to creating the fleet.
	// This fleet property can't be changed after the fleet is created.
	ScriptId *string `type:"string"`

	// This parameter is no longer used. Specify server launch parameters using
	// the RuntimeConfiguration parameter. Requests that use this parameter instead
	// continue to be valid.
	ServerLaunchParameters *string `min:"1" type:"string"`

	// This parameter is no longer used. Specify a server launch path using the
	// RuntimeConfiguration parameter. Requests that use this parameter instead
	// continue to be valid.
	ServerLaunchPath *string `min:"1" type:"string"`

	// A list of labels to assign to the new fleet resource. Tags are developer-defined
	// key-value pairs. Tagging Amazon Web Services resources are useful for resource
	// management, access management and cost allocation. For more information,
	// see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateFleetInput) GoString 

func (s CreateFleetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFleetInput) SetAnywhereConfiguration added in v1.44.151 

func (s *CreateFleetInput) SetAnywhereConfiguration(v *AnywhereConfiguration) *CreateFleetInput

SetAnywhereConfiguration sets the AnywhereConfiguration field's value.

func (*CreateFleetInput) SetBuildId added in v1.5.0 

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

SetBuildId sets the BuildId field's value.

func (*CreateFleetInput) SetCertificateConfiguration added in v1.23.14 

func (s *CreateFleetInput) SetCertificateConfiguration(v *CertificateConfiguration) *CreateFleetInput

SetCertificateConfiguration sets the CertificateConfiguration field's value.

func (*CreateFleetInput) SetComputeType added in v1.44.151 

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

SetComputeType sets the ComputeType field's value.

func (*CreateFleetInput) SetContainerGroupsConfiguration added in v1.51.28 

func (s *CreateFleetInput) SetContainerGroupsConfiguration(v *ContainerGroupsConfiguration) *CreateFleetInput

SetContainerGroupsConfiguration sets the ContainerGroupsConfiguration 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) SetFleetType added in v1.12.78 

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

SetFleetType sets the FleetType field's value.

func (*CreateFleetInput) SetInstanceRoleArn added in v1.17.13 

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

SetInstanceRoleArn sets the InstanceRoleArn field's value.

func (*CreateFleetInput) SetInstanceRoleCredentialsProvider added in v1.47.2 

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

SetInstanceRoleCredentialsProvider sets the InstanceRoleCredentialsProvider field's value.

func (*CreateFleetInput) SetLocations added in v1.37.32 

func (s *CreateFleetInput) SetLocations(v []*LocationConfiguration) *CreateFleetInput

SetLocations sets the Locations 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) SetMetricGroups added in v1.8.24 

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

SetMetricGroups sets the MetricGroups 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) SetPeerVpcAwsAccountId added in v1.10.37 

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

SetPeerVpcAwsAccountId sets the PeerVpcAwsAccountId field's value.

func (*CreateFleetInput) SetPeerVpcId added in v1.10.37 

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

SetPeerVpcId sets the PeerVpcId 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) SetScriptId added in v1.19.18 

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

SetScriptId sets the ScriptId 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) SetTags added in v1.26.6 

func (s *CreateFleetInput) SetTags(v []*Tag) *CreateFleetInput

SetTags sets the Tags field's value.

func (CreateFleetInput) String 

func (s CreateFleetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 CreateFleetLocationsInput added in v1.37.32 

type CreateFleetLocationsInput struct {

	// A unique identifier for the fleet to add locations to. You can use either
	// the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// A list of locations to deploy additional instances to and manage as part
	// of the fleet. You can add any Amazon GameLift-supported Amazon Web Services
	// Region as a remote location, in the form of an Amazon Web Services Region
	// code such as us-west-2.
	//
	// Locations is a required field
	Locations []*LocationConfiguration `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateFleetLocationsInput) GoString added in v1.37.32 

func (s CreateFleetLocationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFleetLocationsInput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (*CreateFleetLocationsInput) SetLocations added in v1.37.32 

func (s *CreateFleetLocationsInput) SetLocations(v []*LocationConfiguration) *CreateFleetLocationsInput

SetLocations sets the Locations field's value.

func (CreateFleetLocationsInput) String added in v1.37.32 

func (s CreateFleetLocationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFleetLocationsInput) Validate added in v1.37.32 

func (s *CreateFleetLocationsInput) Validate() error

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

type CreateFleetLocationsOutput added in v1.37.32 

type CreateFleetLocationsOutput struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that was updated with new locations.
	FleetId *string `type:"string"`

	// The remote locations that are being added to the fleet, and the life-cycle
	// status of each location. For new locations, the status is set to NEW. During
	// location creation, Amazon GameLift updates each location's status as instances
	// are deployed there and prepared for game hosting. This list does not include
	// the fleet home Region or any remote locations that were already added to
	// the fleet.
	LocationStates []*LocationState `type:"list"`
	// contains filtered or unexported fields
}

func (CreateFleetLocationsOutput) GoString added in v1.37.32 

func (s CreateFleetLocationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFleetLocationsOutput) SetFleetArn added in v1.37.32 

func (s *CreateFleetLocationsOutput) SetFleetArn(v string) *CreateFleetLocationsOutput

SetFleetArn sets the FleetArn field's value.

func (*CreateFleetLocationsOutput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (*CreateFleetLocationsOutput) SetLocationStates added in v1.37.32 

func (s *CreateFleetLocationsOutput) SetLocationStates(v []*LocationState) *CreateFleetLocationsOutput

SetLocationStates sets the LocationStates field's value.

func (CreateFleetLocationsOutput) String added in v1.37.32 

func (s CreateFleetLocationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFleetOutput 

type CreateFleetOutput struct {

	// The properties for the new fleet, including the current status. All fleets
	// are placed in NEW status on creation.
	FleetAttributes *FleetAttributes `type:"structure"`

	// The fleet's locations and life-cycle status of each location. For new fleets,
	// the status of all locations is set to NEW. During fleet creation, Amazon
	// GameLift updates each location status as instances are deployed there and
	// prepared for game hosting. This list includes an entry for the fleet's home
	// Region. For fleets with no remote locations, only one entry, representing
	// the home Region, is returned.
	LocationStates []*LocationState `type:"list"`
	// contains filtered or unexported fields
}

func (CreateFleetOutput) GoString 

func (s CreateFleetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFleetOutput) SetFleetAttributes added in v1.5.0 

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

SetFleetAttributes sets the FleetAttributes field's value.

func (*CreateFleetOutput) SetLocationStates added in v1.37.32 

func (s *CreateFleetOutput) SetLocationStates(v []*LocationState) *CreateFleetOutput

SetLocationStates sets the LocationStates field's value.

func (CreateFleetOutput) String 

func (s CreateFleetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateGameServerGroupInput added in v1.30.3 

type CreateGameServerGroupInput struct {

	// Configuration settings to define a scaling policy for the Auto Scaling group
	// that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers"
	// to maintain a buffer of idle game servers that can immediately accommodate
	// new games and players. After the Auto Scaling group is created, update this
	// value directly in the Auto Scaling group using the Amazon Web Services console
	// or APIs.
	AutoScalingPolicy *GameServerGroupAutoScalingPolicy `type:"structure"`

	// Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances
	// and On-Demand Instances in the game server group. Method options include
	// the following:
	//
	//    * SPOT_ONLY - Only Spot Instances are used in the game server group. If
	//    Spot Instances are unavailable or not viable for game hosting, the game
	//    server group provides no hosting capacity until Spot Instances can again
	//    be used. Until then, no new instances are started, and the existing nonviable
	//    Spot Instances are terminated (after current gameplay ends) and are not
	//    replaced.
	//
	//    * SPOT_PREFERRED - (default value) Spot Instances are used whenever available
	//    in the game server group. If Spot Instances are unavailable, the game
	//    server group continues to provide hosting capacity by falling back to
	//    On-Demand Instances. Existing nonviable Spot Instances are terminated
	//    (after current gameplay ends) and are replaced with new On-Demand Instances.
	//
	//    * ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server
	//    group. No Spot Instances are used, even when available, while this balancing
	//    strategy is in force.
	BalancingStrategy *string `type:"string" enum:"BalancingStrategy"`

	// An identifier for the new game server group. This value is used to generate
	// unique ARN identifiers for the Amazon EC2 Auto Scaling group and the Amazon
	// GameLift FleetIQ game server group. The name must be unique per Region per
	// Amazon Web Services account.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// A flag that indicates whether instances in the game server group are protected
	// from early termination. Unprotected instances that have active game servers
	// running might be terminated during a scale-down event, causing players to
	// be dropped from the game. Protected instances cannot be terminated while
	// there are active game servers running except in the event of a forced game
	// server group deletion (see ). An exception to this is with Spot Instances,
	// which can be terminated by Amazon Web Services regardless of protection status.
	// This property is set to NO_PROTECTION by default.
	GameServerProtectionPolicy *string `type:"string" enum:"GameServerProtectionPolicy"`

	// The Amazon EC2 instance types and sizes to use in the Auto Scaling group.
	// The instance definitions must specify at least two different instance types
	// that are supported by Amazon GameLift FleetIQ. For more information on instance
	// types, see EC2 Instance Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)
	// in the Amazon Elastic Compute Cloud User Guide. You can optionally specify
	// capacity weighting for each instance type. If no weight value is specified
	// for an instance type, it is set to the default value "1". For more information
	// about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling
	// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// InstanceDefinitions is a required field
	InstanceDefinitions []*InstanceDefinition `min:"2" type:"list" required:"true"`

	// The Amazon EC2 launch template that contains configuration settings and game
	// server code to be deployed to all instances in the game server group. You
	// can specify the template using either the template name or ID. For help with
	// creating a launch template, see Creating a Launch Template for an Auto Scaling
	// Group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html)
	// in the Amazon Elastic Compute Cloud Auto Scaling User Guide. After the Auto
	// Scaling group is created, update this value directly in the Auto Scaling
	// group using the Amazon Web Services console or APIs.
	//
	// If you specify network interfaces in your launch template, you must explicitly
	// set the property AssociatePublicIpAddress to "true". If no network interface
	// is specified in the launch template, Amazon GameLift FleetIQ uses your account's
	// default VPC.
	//
	// LaunchTemplate is a required field
	LaunchTemplate *LaunchTemplateSpecification `type:"structure" required:"true"`

	// The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
	// During automatic scaling events, Amazon GameLift FleetIQ and EC2 do not scale
	// up the group above this maximum. After the Auto Scaling group is created,
	// update this value directly in the Auto Scaling group using the Amazon Web
	// Services console or APIs.
	//
	// MaxSize is a required field
	MaxSize *int64 `min:"1" type:"integer" required:"true"`

	// The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
	// During automatic scaling events, Amazon GameLift FleetIQ and Amazon EC2 do
	// not scale down the group below this minimum. In production, this value should
	// be set to at least 1. After the Auto Scaling group is created, update this
	// value directly in the Auto Scaling group using the Amazon Web Services console
	// or APIs.
	//
	// MinSize is a required field
	MinSize *int64 `type:"integer" required:"true"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto
	// Scaling groups.
	//
	// RoleArn is a required field
	RoleArn *string `min:"1" type:"string" required:"true"`

	// A list of labels to assign to the new game server group resource. Tags are
	// developer-defined key-value pairs. Tagging Amazon Web Services resources
	// is useful for resource management, access management, and cost allocation.
	// For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference.
	Tags []*Tag `type:"list"`

	// A list of virtual private cloud (VPC) subnets to use with instances in the
	// game server group. By default, all Amazon GameLift FleetIQ-supported Availability
	// Zones are used. You can use this parameter to specify VPCs that you've set
	// up. This property cannot be updated after the game server group is created,
	// and the corresponding Auto Scaling group will always use the property value
	// that is set with this request, even if the Auto Scaling group is updated
	// directly.
	VpcSubnets []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateGameServerGroupInput) GoString added in v1.30.3 

func (s CreateGameServerGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGameServerGroupInput) SetAutoScalingPolicy added in v1.30.3 

func (s *CreateGameServerGroupInput) SetAutoScalingPolicy(v *GameServerGroupAutoScalingPolicy) *CreateGameServerGroupInput

SetAutoScalingPolicy sets the AutoScalingPolicy field's value.

func (*CreateGameServerGroupInput) SetBalancingStrategy added in v1.30.3 

func (s *CreateGameServerGroupInput) SetBalancingStrategy(v string) *CreateGameServerGroupInput

SetBalancingStrategy sets the BalancingStrategy field's value.

func (*CreateGameServerGroupInput) SetGameServerGroupName added in v1.30.3 

func (s *CreateGameServerGroupInput) SetGameServerGroupName(v string) *CreateGameServerGroupInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*CreateGameServerGroupInput) SetGameServerProtectionPolicy added in v1.30.3 

func (s *CreateGameServerGroupInput) SetGameServerProtectionPolicy(v string) *CreateGameServerGroupInput

SetGameServerProtectionPolicy sets the GameServerProtectionPolicy field's value.

func (*CreateGameServerGroupInput) SetInstanceDefinitions added in v1.30.3 

func (s *CreateGameServerGroupInput) SetInstanceDefinitions(v []*InstanceDefinition) *CreateGameServerGroupInput

SetInstanceDefinitions sets the InstanceDefinitions field's value.

func (*CreateGameServerGroupInput) SetLaunchTemplate added in v1.30.3 

func (s *CreateGameServerGroupInput) SetLaunchTemplate(v *LaunchTemplateSpecification) *CreateGameServerGroupInput

SetLaunchTemplate sets the LaunchTemplate field's value.

func (*CreateGameServerGroupInput) SetMaxSize added in v1.30.3 

func (s *CreateGameServerGroupInput) SetMaxSize(v int64) *CreateGameServerGroupInput

SetMaxSize sets the MaxSize field's value.

func (*CreateGameServerGroupInput) SetMinSize added in v1.30.3 

func (s *CreateGameServerGroupInput) SetMinSize(v int64) *CreateGameServerGroupInput

SetMinSize sets the MinSize field's value.

func (*CreateGameServerGroupInput) SetRoleArn added in v1.30.3 

func (s *CreateGameServerGroupInput) SetRoleArn(v string) *CreateGameServerGroupInput

SetRoleArn sets the RoleArn field's value.

func (*CreateGameServerGroupInput) SetTags added in v1.30.3 

func (s *CreateGameServerGroupInput) SetTags(v []*Tag) *CreateGameServerGroupInput

SetTags sets the Tags field's value.

func (*CreateGameServerGroupInput) SetVpcSubnets added in v1.30.3 

func (s *CreateGameServerGroupInput) SetVpcSubnets(v []*string) *CreateGameServerGroupInput

SetVpcSubnets sets the VpcSubnets field's value.

func (CreateGameServerGroupInput) String added in v1.30.3 

func (s CreateGameServerGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGameServerGroupInput) Validate added in v1.30.3 

func (s *CreateGameServerGroupInput) Validate() error

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

type CreateGameServerGroupOutput added in v1.30.3 

type CreateGameServerGroupOutput struct {

	// The newly created game server group object, including the new ARN value for
	// the Amazon GameLift FleetIQ game server group and the object's status. The
	// Amazon EC2 Auto Scaling group ARN is initially null, since the group has
	// not yet been created. This value is added once the game server group status
	// reaches ACTIVE.
	GameServerGroup *GameServerGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateGameServerGroupOutput) GoString added in v1.30.3 

func (s CreateGameServerGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGameServerGroupOutput) SetGameServerGroup added in v1.30.3 

func (s *CreateGameServerGroupOutput) SetGameServerGroup(v *GameServerGroup) *CreateGameServerGroupOutput

SetGameServerGroup sets the GameServerGroup field's value.

func (CreateGameServerGroupOutput) String added in v1.30.3 

func (s CreateGameServerGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateGameSessionInput 

type CreateGameSessionInput struct {

	// A unique identifier for the alias associated with the fleet to create a game
	// session in. You can use either the alias ID or ARN value. Each request must
	// reference either a fleet ID or alias ID, but not both.
	AliasId *string `type:"string"`

	// A unique identifier for a player or entity creating the game session.
	//
	// If you add a resource creation limit policy to a fleet, the CreateGameSession
	// operation requires a CreatorId. Amazon GameLift limits the number of game
	// session creation requests with the same CreatorId in a specified time period.
	//
	// If you your fleet doesn't have a resource creation limit policy and you provide
	// a CreatorId in your CreateGameSession requests, Amazon GameLift limits requests
	// to one request per CreatorId per second.
	//
	// To not limit CreateGameSession requests with the same CreatorId, don't provide
	// a CreatorId in your CreateGameSession request.
	CreatorId *string `min:"1" type:"string"`

	// A unique identifier for the fleet to create a game session in. You can use
	// either the fleet ID or ARN value. Each request must reference either a fleet
	// ID or alias ID, but not both.
	FleetId *string `type:"string"`

	// A set of key-value pairs that can store custom data in a game session. For
	// example: {"Key": "difficulty", "Value": "novice"}. For an example, see Create
	// a game session with custom properties (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-create).
	GameProperties []*GameProperty `type:"list"`

	// A set of custom game session properties, formatted as a single string value.
	// This data is passed to a game server process with a request to start a new
	// game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
	GameSessionData *string `min:"1" type:"string"`

	// This parameter is deprecated. Use IdempotencyToken instead.
	//
	// Custom string that uniquely identifies a request for a new game session.
	// Maximum token length is 48 characters. If provided, this string is included
	// in the new game session's ID.
	GameSessionId *string `min:"1" type:"string"`

	// Custom string that uniquely identifies the new game session request. This
	// is useful for ensuring that game session requests with the same idempotency
	// token are processed only once. Subsequent requests with the same string return
	// the original GameSession object, with an updated status. Maximum token length
	// is 48 characters. If provided, this string is included in the new game session's
	// ID. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet
	// ID>/<custom ID string or idempotency token>. Idempotency tokens remain in
	// use for 30 days after a game session has ended; game session objects are
	// retained for this time period and then deleted.
	IdempotencyToken *string `min:"1" type:"string"`

	// A fleet's remote location to place the new game session in. If this parameter
	// is not set, the new game session is placed in the fleet's home Region. Specify
	// a remote location with an Amazon Web Services Region code such as us-west-2.
	// When using an Anywhere fleet, this parameter is required and must be set
	// to the Anywhere fleet's custom location.
	Location *string `min:"1" type:"string"`

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

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

func (CreateGameSessionInput) GoString 

func (s CreateGameSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGameSessionInput) SetAliasId added in v1.5.0 

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

SetAliasId sets the AliasId field's value.

func (*CreateGameSessionInput) SetCreatorId added in v1.5.0 

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

SetCreatorId sets the CreatorId field's value.

func (*CreateGameSessionInput) SetFleetId added in v1.5.0 

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

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) SetGameSessionData added in v1.10.27 

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

SetGameSessionData sets the GameSessionData 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) SetIdempotencyToken added in v1.8.12 

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

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*CreateGameSessionInput) SetLocation added in v1.37.32 

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

SetLocation sets the Location 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 

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

SetName sets the Name field's value.

func (CreateGameSessionInput) String 

func (s CreateGameSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 that describes the newly created game session record.
	GameSession *GameSession `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateGameSessionOutput) GoString 

func (s CreateGameSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGameSessionOutput) SetGameSession added in v1.5.0 

func (s *CreateGameSessionOutput) SetGameSession(v *GameSession) *CreateGameSessionOutput

SetGameSession sets the GameSession field's value.

func (CreateGameSessionOutput) String 

func (s CreateGameSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateGameSessionQueueInput added in v1.6.27 

type CreateGameSessionQueueInput struct {

	// Information to be added to all events that are related to this game session
	// queue.
	CustomEventData *string `type:"string"`

	// A list of fleets and/or fleet aliases that can be used to fulfill game session
	// placement requests in the queue. Destinations are identified by either a
	// fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
	Destinations []*GameSessionQueueDestination `type:"list"`

	// A list of locations where a queue is allowed to place new game sessions.
	// Locations are specified in the form of Amazon Web Services Region codes,
	// such as us-west-2. If this parameter is not set, game sessions can be placed
	// in any queue location.
	FilterConfiguration *FilterConfiguration `type:"structure"`

	// A descriptive label that is associated with game session queue. Queue names
	// must be unique within each Region.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// An SNS topic ARN that is set up to receive game session placement notifications.
	// See Setting up notifications for game session placement (https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html).
	NotificationTarget *string `type:"string"`

	// A set of policies that act as a sliding cap on player latency. FleetIQ works
	// to deliver low latency for most players in a game session. These policies
	// ensure that no individual player can be placed into a game with unreasonably
	// high latency. Use multiple policies to gradually relax latency requirements
	// a step at a time. Multiple policies are applied based on their maximum allowed
	// latency, starting with the lowest value.
	PlayerLatencyPolicies []*PlayerLatencyPolicy `type:"list"`

	// Custom settings to use when prioritizing destinations and locations for game
	// session placements. This configuration replaces the FleetIQ default prioritization
	// process. Priority types that are not explicitly named will be automatically
	// applied at the end of the prioritization process.
	PriorityConfiguration *PriorityConfiguration `type:"structure"`

	// A list of labels to assign to the new game session queue resource. Tags are
	// developer-defined key-value pairs. Tagging Amazon Web Services resources
	// are useful for resource management, access management and cost allocation.
	// For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference.
	Tags []*Tag `type:"list"`

	// The maximum time, in seconds, that a new game session placement request remains
	// in the queue. When a request exceeds this time, the game session placement
	// changes to a TIMED_OUT status. By default, this property is set to 600.
	TimeoutInSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (CreateGameSessionQueueInput) GoString added in v1.6.27 

func (s CreateGameSessionQueueInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGameSessionQueueInput) SetCustomEventData added in v1.38.3 

func (s *CreateGameSessionQueueInput) SetCustomEventData(v string) *CreateGameSessionQueueInput

SetCustomEventData sets the CustomEventData field's value.

func (*CreateGameSessionQueueInput) SetDestinations added in v1.6.27 

func (s *CreateGameSessionQueueInput) SetDestinations(v []*GameSessionQueueDestination) *CreateGameSessionQueueInput

SetDestinations sets the Destinations field's value.

func (*CreateGameSessionQueueInput) SetFilterConfiguration added in v1.37.32 

func (s *CreateGameSessionQueueInput) SetFilterConfiguration(v *FilterConfiguration) *CreateGameSessionQueueInput

SetFilterConfiguration sets the FilterConfiguration field's value.

func (*CreateGameSessionQueueInput) SetName added in v1.6.27 

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

SetName sets the Name field's value.

func (*CreateGameSessionQueueInput) SetNotificationTarget added in v1.38.3 

func (s *CreateGameSessionQueueInput) SetNotificationTarget(v string) *CreateGameSessionQueueInput

SetNotificationTarget sets the NotificationTarget field's value.

func (*CreateGameSessionQueueInput) SetPlayerLatencyPolicies added in v1.8.12 

func (s *CreateGameSessionQueueInput) SetPlayerLatencyPolicies(v []*PlayerLatencyPolicy) *CreateGameSessionQueueInput

SetPlayerLatencyPolicies sets the PlayerLatencyPolicies field's value.

func (*CreateGameSessionQueueInput) SetPriorityConfiguration added in v1.37.32 

func (s *CreateGameSessionQueueInput) SetPriorityConfiguration(v *PriorityConfiguration) *CreateGameSessionQueueInput

SetPriorityConfiguration sets the PriorityConfiguration field's value.

func (*CreateGameSessionQueueInput) SetTags added in v1.26.6 

func (s *CreateGameSessionQueueInput) SetTags(v []*Tag) *CreateGameSessionQueueInput

SetTags sets the Tags field's value.

func (*CreateGameSessionQueueInput) SetTimeoutInSeconds added in v1.6.27 

func (s *CreateGameSessionQueueInput) SetTimeoutInSeconds(v int64) *CreateGameSessionQueueInput

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (CreateGameSessionQueueInput) String added in v1.6.27 

func (s CreateGameSessionQueueInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGameSessionQueueInput) Validate added in v1.6.27 

func (s *CreateGameSessionQueueInput) Validate() error

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

type CreateGameSessionQueueOutput added in v1.6.27 

type CreateGameSessionQueueOutput struct {

	// An object that describes the newly created game session queue.
	GameSessionQueue *GameSessionQueue `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateGameSessionQueueOutput) GoString added in v1.6.27 

func (s CreateGameSessionQueueOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGameSessionQueueOutput) SetGameSessionQueue added in v1.6.27 

func (s *CreateGameSessionQueueOutput) SetGameSessionQueue(v *GameSessionQueue) *CreateGameSessionQueueOutput

SetGameSessionQueue sets the GameSessionQueue field's value.

func (CreateGameSessionQueueOutput) String added in v1.6.27 

func (s CreateGameSessionQueueOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLocationInput added in v1.44.151 

type CreateLocationInput struct {

	// A descriptive name for the custom location.
	//
	// LocationName is a required field
	LocationName *string `min:"8" type:"string" required:"true"`

	// A list of labels to assign to the new matchmaking configuration resource.
	// Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources
	// are useful for resource management, access management and cost allocation.
	// For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Rareference.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateLocationInput) GoString added in v1.44.151 

func (s CreateLocationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLocationInput) SetLocationName added in v1.44.151 

func (s *CreateLocationInput) SetLocationName(v string) *CreateLocationInput

SetLocationName sets the LocationName field's value.

func (*CreateLocationInput) SetTags added in v1.44.151 

func (s *CreateLocationInput) SetTags(v []*Tag) *CreateLocationInput

SetTags sets the Tags field's value.

func (CreateLocationInput) String added in v1.44.151 

func (s CreateLocationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLocationInput) Validate added in v1.44.151 

func (s *CreateLocationInput) Validate() error

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

type CreateLocationOutput added in v1.44.151 

type CreateLocationOutput struct {

	// The details of the custom location you created.
	Location *LocationModel `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateLocationOutput) GoString added in v1.44.151 

func (s CreateLocationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLocationOutput) SetLocation added in v1.44.151 

func (s *CreateLocationOutput) SetLocation(v *LocationModel) *CreateLocationOutput

SetLocation sets the Location field's value.

func (CreateLocationOutput) String added in v1.44.151 

func (s CreateLocationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateMatchmakingConfigurationInput added in v1.10.27 

type CreateMatchmakingConfigurationInput struct {

	// A flag that determines whether a match that was created with this configuration
	// must be accepted by the matched players. To require acceptance, set to TRUE.
	// With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE
	// to indicate when a completed potential match is waiting for player acceptance.
	//
	// AcceptanceRequired is a required field
	AcceptanceRequired *bool `type:"boolean" required:"true"`

	// The length of time (in seconds) to wait for players to accept a proposed
	// match, if acceptance is required.
	AcceptanceTimeoutSeconds *int64 `min:"1" type:"integer"`

	// The number of player slots in a match to keep open for future players. For
	// example, if the configuration's rule set specifies a match for a single 10-person
	// team, and the additional player count is set to 2, 10 players will be selected
	// for the match and 2 more player slots will be open for future players. This
	// parameter is not used if FlexMatchMode is set to STANDALONE.
	AdditionalPlayerCount *int64 `type:"integer"`

	// The method used to backfill game sessions that are created with this matchmaking
	// configuration. Specify MANUAL when your game manages backfill requests manually
	// or does not use the match backfill feature. Specify AUTOMATIC to have Amazon
	// GameLift create a backfill request whenever a game session has one or more
	// open slots. Learn more about manual and automatic backfill in Backfill Existing
	// Games with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html).
	// Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
	BackfillMode *string `type:"string" enum:"BackfillMode"`

	// Information to be added to all events related to this matchmaking configuration.
	CustomEventData *string `type:"string"`

	// A human-readable description of the matchmaking configuration.
	Description *string `min:"1" type:"string"`

	// Indicates whether this matchmaking configuration is being used with Amazon
	// GameLift hosting or as a standalone matchmaking solution.
	//
	//    * STANDALONE - FlexMatch forms matches and returns match information,
	//    including players and team assignments, in a MatchmakingSucceeded (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded)
	//    event.
	//
	//    * WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift
	//    queue to start a game session for the match.
	FlexMatchMode *string `type:"string" enum:"FlexMatchMode"`

	// A set of key-value pairs that can store custom data in a game session. For
	// example: {"Key": "difficulty", "Value": "novice"}. This information is added
	// to the new GameSession object that is created for a successful match. This
	// parameter is not used if FlexMatchMode is set to STANDALONE.
	GameProperties []*GameProperty `type:"list"`

	// A set of custom game session properties, formatted as a single string value.
	// This data is passed to a game server process with a request to start a new
	// game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
	// This information is added to the new GameSession object that is created for
	// a successful match. This parameter is not used if FlexMatchMode is set to
	// STANDALONE.
	GameSessionData *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift game session queue resource and uniquely
	// identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue
	// name>. Queues can be located in any Region. Queues are used to start new
	// Amazon GameLift-hosted game sessions for matches that are created with this
	// matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not
	// set this parameter.
	GameSessionQueueArns []*string `type:"list"`

	// A unique identifier for the matchmaking configuration. This name is used
	// to identify the configuration associated with a matchmaking request or ticket.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// An SNS topic ARN that is set up to receive matchmaking notifications. See
	// Setting up notifications for matchmaking (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html)
	// for more information.
	NotificationTarget *string `type:"string"`

	// The maximum duration, in seconds, that a matchmaking ticket can remain in
	// process before timing out. Requests that fail due to timing out can be resubmitted
	// as needed.
	//
	// RequestTimeoutSeconds is a required field
	RequestTimeoutSeconds *int64 `min:"1" type:"integer" required:"true"`

	// A unique identifier for the matchmaking rule set to use with this configuration.
	// You can use either the rule set name or ARN value. A matchmaking configuration
	// can only use rule sets that are defined in the same Region.
	//
	// RuleSetName is a required field
	RuleSetName *string `min:"1" type:"string" required:"true"`

	// A list of labels to assign to the new matchmaking configuration resource.
	// Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources
	// are useful for resource management, access management and cost allocation.
	// For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateMatchmakingConfigurationInput) GoString added in v1.10.27 

func (s CreateMatchmakingConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMatchmakingConfigurationInput) SetAcceptanceRequired added in v1.10.27 

func (s *CreateMatchmakingConfigurationInput) SetAcceptanceRequired(v bool) *CreateMatchmakingConfigurationInput

SetAcceptanceRequired sets the AcceptanceRequired field's value.

func (*CreateMatchmakingConfigurationInput) SetAcceptanceTimeoutSeconds added in v1.10.27 

func (s *CreateMatchmakingConfigurationInput) SetAcceptanceTimeoutSeconds(v int64) *CreateMatchmakingConfigurationInput

SetAcceptanceTimeoutSeconds sets the AcceptanceTimeoutSeconds field's value.

func (*CreateMatchmakingConfigurationInput) SetAdditionalPlayerCount added in v1.10.27 

func (s *CreateMatchmakingConfigurationInput) SetAdditionalPlayerCount(v int64) *CreateMatchmakingConfigurationInput

SetAdditionalPlayerCount sets the AdditionalPlayerCount field's value.

func (*CreateMatchmakingConfigurationInput) SetBackfillMode added in v1.20.17 

func (s *CreateMatchmakingConfigurationInput) SetBackfillMode(v string) *CreateMatchmakingConfigurationInput

SetBackfillMode sets the BackfillMode field's value.

func (*CreateMatchmakingConfigurationInput) SetCustomEventData added in v1.10.27 

func (s *CreateMatchmakingConfigurationInput) SetCustomEventData(v string) *CreateMatchmakingConfigurationInput

SetCustomEventData sets the CustomEventData field's value.

func (*CreateMatchmakingConfigurationInput) SetDescription added in v1.10.27 

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

SetDescription sets the Description field's value.

func (*CreateMatchmakingConfigurationInput) SetFlexMatchMode added in v1.35.35 

func (s *CreateMatchmakingConfigurationInput) SetFlexMatchMode(v string) *CreateMatchmakingConfigurationInput

SetFlexMatchMode sets the FlexMatchMode field's value.

func (*CreateMatchmakingConfigurationInput) SetGameProperties added in v1.10.27 

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

SetGameProperties sets the GameProperties field's value.

func (*CreateMatchmakingConfigurationInput) SetGameSessionData added in v1.10.27 

func (s *CreateMatchmakingConfigurationInput) SetGameSessionData(v string) *CreateMatchmakingConfigurationInput

SetGameSessionData sets the GameSessionData field's value.

func (*CreateMatchmakingConfigurationInput) SetGameSessionQueueArns added in v1.10.27 

func (s *CreateMatchmakingConfigurationInput) SetGameSessionQueueArns(v []*string) *CreateMatchmakingConfigurationInput

SetGameSessionQueueArns sets the GameSessionQueueArns field's value.

func (*CreateMatchmakingConfigurationInput) SetName added in v1.10.27 

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

SetName sets the Name field's value.

func (*CreateMatchmakingConfigurationInput) SetNotificationTarget added in v1.10.27 

func (s *CreateMatchmakingConfigurationInput) SetNotificationTarget(v string) *CreateMatchmakingConfigurationInput

SetNotificationTarget sets the NotificationTarget field's value.

func (*CreateMatchmakingConfigurationInput) SetRequestTimeoutSeconds added in v1.10.27 

func (s *CreateMatchmakingConfigurationInput) SetRequestTimeoutSeconds(v int64) *CreateMatchmakingConfigurationInput

SetRequestTimeoutSeconds sets the RequestTimeoutSeconds field's value.

func (*CreateMatchmakingConfigurationInput) SetRuleSetName added in v1.10.27 

func (s *CreateMatchmakingConfigurationInput) SetRuleSetName(v string) *CreateMatchmakingConfigurationInput

SetRuleSetName sets the RuleSetName field's value.

func (*CreateMatchmakingConfigurationInput) SetTags added in v1.26.6 

func (s *CreateMatchmakingConfigurationInput) SetTags(v []*Tag) *CreateMatchmakingConfigurationInput

SetTags sets the Tags field's value.

func (CreateMatchmakingConfigurationInput) String added in v1.10.27 

func (s CreateMatchmakingConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMatchmakingConfigurationInput) Validate added in v1.10.27 

func (s *CreateMatchmakingConfigurationInput) Validate() error

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

type CreateMatchmakingConfigurationOutput added in v1.10.27 

type CreateMatchmakingConfigurationOutput struct {

	// Object that describes the newly created matchmaking configuration.
	Configuration *MatchmakingConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateMatchmakingConfigurationOutput) GoString added in v1.10.27 

func (s CreateMatchmakingConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMatchmakingConfigurationOutput) SetConfiguration added in v1.10.27 

func (s *CreateMatchmakingConfigurationOutput) SetConfiguration(v *MatchmakingConfiguration) *CreateMatchmakingConfigurationOutput

SetConfiguration sets the Configuration field's value.

func (CreateMatchmakingConfigurationOutput) String added in v1.10.27 

func (s CreateMatchmakingConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateMatchmakingRuleSetInput added in v1.10.27 

type CreateMatchmakingRuleSetInput struct {

	// A unique identifier for the matchmaking rule set. A matchmaking configuration
	// identifies the rule set it uses by this name value. Note that the rule set
	// name is different from the optional name field in the rule set body.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// A collection of matchmaking rules, formatted as a JSON string. Comments are
	// not allowed in JSON, but most elements support a description field.
	//
	// RuleSetBody is a required field
	RuleSetBody *string `min:"1" type:"string" required:"true"`

	// A list of labels to assign to the new matchmaking rule set resource. Tags
	// are developer-defined key-value pairs. Tagging Amazon Web Services resources
	// are useful for resource management, access management and cost allocation.
	// For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateMatchmakingRuleSetInput) GoString added in v1.10.27 

func (s CreateMatchmakingRuleSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMatchmakingRuleSetInput) SetName added in v1.10.27 

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

SetName sets the Name field's value.

func (*CreateMatchmakingRuleSetInput) SetRuleSetBody added in v1.10.27 

func (s *CreateMatchmakingRuleSetInput) SetRuleSetBody(v string) *CreateMatchmakingRuleSetInput

SetRuleSetBody sets the RuleSetBody field's value.

func (*CreateMatchmakingRuleSetInput) SetTags added in v1.26.6 

func (s *CreateMatchmakingRuleSetInput) SetTags(v []*Tag) *CreateMatchmakingRuleSetInput

SetTags sets the Tags field's value.

func (CreateMatchmakingRuleSetInput) String added in v1.10.27 

func (s CreateMatchmakingRuleSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMatchmakingRuleSetInput) Validate added in v1.10.27 

func (s *CreateMatchmakingRuleSetInput) Validate() error

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

type CreateMatchmakingRuleSetOutput added in v1.10.27 

type CreateMatchmakingRuleSetOutput struct {

	// The newly created matchmaking rule set.
	//
	// RuleSet is a required field
	RuleSet *MatchmakingRuleSet `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateMatchmakingRuleSetOutput) GoString added in v1.10.27 

func (s CreateMatchmakingRuleSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMatchmakingRuleSetOutput) SetRuleSet added in v1.10.27 

func (s *CreateMatchmakingRuleSetOutput) SetRuleSet(v *MatchmakingRuleSet) *CreateMatchmakingRuleSetOutput

SetRuleSet sets the RuleSet field's value.

func (CreateMatchmakingRuleSetOutput) String added in v1.10.27 

func (s CreateMatchmakingRuleSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePlayerSessionInput 

type CreatePlayerSessionInput struct {

	// A unique identifier for the game session to add a player to.
	//
	// GameSessionId is a required field
	GameSessionId *string `min:"1" type:"string" required:"true"`

	// Developer-defined information related to a player. Amazon GameLift does not
	// use this data, so it can be formatted as needed for use in the game.
	PlayerData *string `min:"1" type:"string"`

	// A unique identifier for a player. Player IDs are developer-defined.
	//
	// PlayerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreatePlayerSessionInput's
	// String and GoString methods.
	//
	// PlayerId is a required field
	PlayerId *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreatePlayerSessionInput) GoString 

func (s CreatePlayerSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePlayerSessionInput) SetGameSessionId added in v1.5.0 

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

SetGameSessionId sets the GameSessionId field's value.

func (*CreatePlayerSessionInput) SetPlayerData added in v1.6.27 

func (s *CreatePlayerSessionInput) SetPlayerData(v string) *CreatePlayerSessionInput

SetPlayerData sets the PlayerData field's value.

func (*CreatePlayerSessionInput) SetPlayerId added in v1.5.0 

func (s *CreatePlayerSessionInput) SetPlayerId(v string) *CreatePlayerSessionInput

SetPlayerId sets the PlayerId field's value.

func (CreatePlayerSessionInput) String 

func (s CreatePlayerSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 that describes the newly created player session record.
	PlayerSession *PlayerSession `type:"structure"`
	// contains filtered or unexported fields
}

func (CreatePlayerSessionOutput) GoString 

func (s CreatePlayerSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePlayerSessionOutput) SetPlayerSession added in v1.5.0 

func (s *CreatePlayerSessionOutput) SetPlayerSession(v *PlayerSession) *CreatePlayerSessionOutput

SetPlayerSession sets the PlayerSession field's value.

func (CreatePlayerSessionOutput) String 

func (s CreatePlayerSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePlayerSessionsInput 

type CreatePlayerSessionsInput struct {

	// A unique identifier for the game session to add players to.
	//
	// GameSessionId is a required field
	GameSessionId *string `min:"1" type:"string" required:"true"`

	// Map of string pairs, each specifying a player ID and a set of developer-defined
	// information related to the player. Amazon GameLift does not use this data,
	// so it can be formatted as needed for use in the game. Any player data strings
	// for player IDs that are not included in the PlayerIds parameter are ignored.
	PlayerDataMap map[string]*string `type:"map"`

	// List of unique identifiers for the players to be added.
	//
	// PlayerIds is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreatePlayerSessionsInput's
	// String and GoString methods.
	//
	// PlayerIds is a required field
	PlayerIds []*string `min:"1" type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreatePlayerSessionsInput) GoString 

func (s CreatePlayerSessionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePlayerSessionsInput) SetGameSessionId added in v1.5.0 

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

SetGameSessionId sets the GameSessionId field's value.

func (*CreatePlayerSessionsInput) SetPlayerDataMap added in v1.6.27 

func (s *CreatePlayerSessionsInput) SetPlayerDataMap(v map[string]*string) *CreatePlayerSessionsInput

SetPlayerDataMap sets the PlayerDataMap field's value.

func (*CreatePlayerSessionsInput) SetPlayerIds added in v1.5.0 

func (s *CreatePlayerSessionsInput) SetPlayerIds(v []*string) *CreatePlayerSessionsInput

SetPlayerIds sets the PlayerIds field's value.

func (CreatePlayerSessionsInput) String 

func (s CreatePlayerSessionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

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

func (CreatePlayerSessionsOutput) GoString 

func (s CreatePlayerSessionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePlayerSessionsOutput) SetPlayerSessions added in v1.5.0 

func (s *CreatePlayerSessionsOutput) SetPlayerSessions(v []*PlayerSession) *CreatePlayerSessionsOutput

SetPlayerSessions sets the PlayerSessions field's value.

func (CreatePlayerSessionsOutput) String 

func (s CreatePlayerSessionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateScriptInput added in v1.19.18 

type CreateScriptInput struct {

	// A descriptive label that is associated with a script. Script names don't
	// need to be unique. You can use UpdateScript (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html)
	// to change this value later.
	Name *string `min:"1" type:"string"`

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

	// A list of labels to assign to the new script resource. Tags are developer-defined
	// key-value pairs. Tagging Amazon Web Services resources are useful for resource
	// management, access management and cost allocation. For more information,
	// see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference. Once the resource is created,
	// you can use TagResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html),
	// UntagResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html),
	// and ListTagsForResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html)
	// to add, remove, and view tags. The maximum tag limit may be lower than stated.
	// See the Amazon Web Services General Reference for actual tagging limits.
	Tags []*Tag `type:"list"`

	// Version information associated with a build or script. Version strings don't
	// need to be unique. You can use UpdateScript (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html)
	// to change this value later.
	Version *string `min:"1" type:"string"`

	// A data object containing your Realtime scripts and dependencies as a zip
	// file. The zip file can have one or multiple files. Maximum size of a zip
	// file is 5 MB.
	//
	// When using the Amazon Web Services CLI tool to create a script, this parameter
	// is set to the zip file name. It must be prepended with the string "fileb://"
	// to indicate that the file data is a binary object. For example: --zip-file
	// fileb://myRealtimeScript.zip.
	// ZipFile is automatically base64 encoded/decoded by the SDK.
	ZipFile []byte `type:"blob"`
	// contains filtered or unexported fields
}

func (CreateScriptInput) GoString added in v1.19.18 

func (s CreateScriptInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScriptInput) SetName added in v1.19.18 

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

SetName sets the Name field's value.

func (*CreateScriptInput) SetStorageLocation added in v1.19.18 

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

SetStorageLocation sets the StorageLocation field's value.

func (*CreateScriptInput) SetTags added in v1.26.6 

func (s *CreateScriptInput) SetTags(v []*Tag) *CreateScriptInput

SetTags sets the Tags field's value.

func (*CreateScriptInput) SetVersion added in v1.19.18 

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

SetVersion sets the Version field's value.

func (*CreateScriptInput) SetZipFile added in v1.19.18 

func (s *CreateScriptInput) SetZipFile(v []byte) *CreateScriptInput

SetZipFile sets the ZipFile field's value.

func (CreateScriptInput) String added in v1.19.18 

func (s CreateScriptInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScriptInput) Validate added in v1.19.18 

func (s *CreateScriptInput) Validate() error

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

type CreateScriptOutput added in v1.19.18 

type CreateScriptOutput struct {

	// The newly created script record with a unique script ID and ARN. The new
	// script's storage location reflects an Amazon S3 location: (1) If the script
	// was uploaded from an S3 bucket under your account, the storage location reflects
	// the information that was provided in the CreateScript request; (2) If the
	// script file was uploaded from a local zip file, the storage location reflects
	// an S3 location controls by the Amazon GameLift service.
	Script *Script `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateScriptOutput) GoString added in v1.19.18 

func (s CreateScriptOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScriptOutput) SetScript added in v1.19.18 

func (s *CreateScriptOutput) SetScript(v *Script) *CreateScriptOutput

SetScript sets the Script field's value.

func (CreateScriptOutput) String added in v1.19.18 

func (s CreateScriptOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateVpcPeeringAuthorizationInput added in v1.10.37 

type CreateVpcPeeringAuthorizationInput struct {

	// A unique identifier for the Amazon Web Services account that you use to manage
	// your Amazon GameLift fleet. You can find your Account ID in the Amazon Web
	// Services Management Console under account settings.
	//
	// GameLiftAwsAccountId is a required field
	GameLiftAwsAccountId *string `min:"1" type:"string" required:"true"`

	// A unique identifier for a VPC with resources to be accessed by your Amazon
	// GameLift fleet. The VPC must be in the same Region as your fleet. To look
	// up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/)
	// in the Amazon Web Services Management Console. Learn more about VPC peering
	// in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html).
	//
	// PeerVpcId is a required field
	PeerVpcId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateVpcPeeringAuthorizationInput) GoString added in v1.10.37 

func (s CreateVpcPeeringAuthorizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVpcPeeringAuthorizationInput) SetGameLiftAwsAccountId added in v1.10.37 

func (s *CreateVpcPeeringAuthorizationInput) SetGameLiftAwsAccountId(v string) *CreateVpcPeeringAuthorizationInput

SetGameLiftAwsAccountId sets the GameLiftAwsAccountId field's value.

func (*CreateVpcPeeringAuthorizationInput) SetPeerVpcId added in v1.10.37 

func (s *CreateVpcPeeringAuthorizationInput) SetPeerVpcId(v string) *CreateVpcPeeringAuthorizationInput

SetPeerVpcId sets the PeerVpcId field's value.

func (CreateVpcPeeringAuthorizationInput) String added in v1.10.37 

func (s CreateVpcPeeringAuthorizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVpcPeeringAuthorizationInput) Validate added in v1.10.37 

func (s *CreateVpcPeeringAuthorizationInput) Validate() error

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

type CreateVpcPeeringAuthorizationOutput added in v1.10.37 

type CreateVpcPeeringAuthorizationOutput struct {

	// Details on the requested VPC peering authorization, including expiration.
	VpcPeeringAuthorization *VpcPeeringAuthorization `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateVpcPeeringAuthorizationOutput) GoString added in v1.10.37 

func (s CreateVpcPeeringAuthorizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVpcPeeringAuthorizationOutput) SetVpcPeeringAuthorization added in v1.10.37 

func (s *CreateVpcPeeringAuthorizationOutput) SetVpcPeeringAuthorization(v *VpcPeeringAuthorization) *CreateVpcPeeringAuthorizationOutput

SetVpcPeeringAuthorization sets the VpcPeeringAuthorization field's value.

func (CreateVpcPeeringAuthorizationOutput) String added in v1.10.37 

func (s CreateVpcPeeringAuthorizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateVpcPeeringConnectionInput added in v1.10.37 

type CreateVpcPeeringConnectionInput struct {

	// A unique identifier for the fleet. You can use either the fleet ID or ARN
	// value. This tells Amazon GameLift which GameLift VPC to peer with.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// A unique identifier for the Amazon Web Services account with the VPC that
	// you want to peer your Amazon GameLift fleet with. You can find your Account
	// ID in the Amazon Web Services Management Console under account settings.
	//
	// PeerVpcAwsAccountId is a required field
	PeerVpcAwsAccountId *string `min:"1" type:"string" required:"true"`

	// A unique identifier for a VPC with resources to be accessed by your Amazon
	// GameLift fleet. The VPC must be in the same Region as your fleet. To look
	// up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/)
	// in the Amazon Web Services Management Console. Learn more about VPC peering
	// in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html).
	//
	// PeerVpcId is a required field
	PeerVpcId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateVpcPeeringConnectionInput) GoString added in v1.10.37 

func (s CreateVpcPeeringConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVpcPeeringConnectionInput) SetFleetId added in v1.10.37 

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

SetFleetId sets the FleetId field's value.

func (*CreateVpcPeeringConnectionInput) SetPeerVpcAwsAccountId added in v1.10.37 

func (s *CreateVpcPeeringConnectionInput) SetPeerVpcAwsAccountId(v string) *CreateVpcPeeringConnectionInput

SetPeerVpcAwsAccountId sets the PeerVpcAwsAccountId field's value.

func (*CreateVpcPeeringConnectionInput) SetPeerVpcId added in v1.10.37 

func (s *CreateVpcPeeringConnectionInput) SetPeerVpcId(v string) *CreateVpcPeeringConnectionInput

SetPeerVpcId sets the PeerVpcId field's value.

func (CreateVpcPeeringConnectionInput) String added in v1.10.37 

func (s CreateVpcPeeringConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVpcPeeringConnectionInput) Validate added in v1.10.37 

func (s *CreateVpcPeeringConnectionInput) Validate() error

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

type CreateVpcPeeringConnectionOutput added in v1.10.37 

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

func (CreateVpcPeeringConnectionOutput) GoString added in v1.10.37 

func (s CreateVpcPeeringConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateVpcPeeringConnectionOutput) String added in v1.10.37 

func (s CreateVpcPeeringConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAliasInput 

type DeleteAliasInput struct {

	// A unique identifier of the alias that you want to delete. You can use either
	// the alias ID or ARN value.
	//
	// AliasId is a required field
	AliasId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAliasInput) GoString 

func (s DeleteAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAliasOutput) String 

func (s DeleteAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteBuildInput 

type DeleteBuildInput struct {

	// A unique identifier for the build to delete. You can use either the build
	// ID or ARN value.
	//
	// BuildId is a required field
	BuildId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBuildInput) GoString 

func (s DeleteBuildInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteBuildOutput) String 

func (s DeleteBuildOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteContainerGroupDefinitionInput added in v1.51.28 

type DeleteContainerGroupDefinitionInput struct {

	// The unique identifier for the container group definition to delete. You can
	// use either the Name or ARN value.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteContainerGroupDefinitionInput) GoString added in v1.51.28 

func (s DeleteContainerGroupDefinitionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContainerGroupDefinitionInput) SetName added in v1.51.28 

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

SetName sets the Name field's value.

func (DeleteContainerGroupDefinitionInput) String added in v1.51.28 

func (s DeleteContainerGroupDefinitionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContainerGroupDefinitionInput) Validate added in v1.51.28 

func (s *DeleteContainerGroupDefinitionInput) Validate() error

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

type DeleteContainerGroupDefinitionOutput added in v1.51.28 

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

func (DeleteContainerGroupDefinitionOutput) GoString added in v1.51.28 

func (s DeleteContainerGroupDefinitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteContainerGroupDefinitionOutput) String added in v1.51.28 

func (s DeleteContainerGroupDefinitionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFleetInput 

type DeleteFleetInput struct {

	// A unique identifier for the fleet to be deleted. You can use either the fleet
	// ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFleetInput) GoString 

func (s DeleteFleetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 DeleteFleetLocationsInput added in v1.37.32 

type DeleteFleetLocationsInput struct {

	// A unique identifier for the fleet to delete locations for. You can use either
	// the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The list of fleet locations to delete. Specify locations in the form of an
	// Amazon Web Services Region code, such as us-west-2.
	//
	// Locations is a required field
	Locations []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFleetLocationsInput) GoString added in v1.37.32 

func (s DeleteFleetLocationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFleetLocationsInput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (*DeleteFleetLocationsInput) SetLocations added in v1.37.32 

func (s *DeleteFleetLocationsInput) SetLocations(v []*string) *DeleteFleetLocationsInput

SetLocations sets the Locations field's value.

func (DeleteFleetLocationsInput) String added in v1.37.32 

func (s DeleteFleetLocationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFleetLocationsInput) Validate added in v1.37.32 

func (s *DeleteFleetLocationsInput) Validate() error

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

type DeleteFleetLocationsOutput added in v1.37.32 

type DeleteFleetLocationsOutput struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that location attributes are being deleted
	// for.
	FleetId *string `type:"string"`

	// The remote locations that are being deleted, with each location status set
	// to DELETING.
	LocationStates []*LocationState `type:"list"`
	// contains filtered or unexported fields
}

func (DeleteFleetLocationsOutput) GoString added in v1.37.32 

func (s DeleteFleetLocationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFleetLocationsOutput) SetFleetArn added in v1.37.32 

func (s *DeleteFleetLocationsOutput) SetFleetArn(v string) *DeleteFleetLocationsOutput

SetFleetArn sets the FleetArn field's value.

func (*DeleteFleetLocationsOutput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (*DeleteFleetLocationsOutput) SetLocationStates added in v1.37.32 

func (s *DeleteFleetLocationsOutput) SetLocationStates(v []*LocationState) *DeleteFleetLocationsOutput

SetLocationStates sets the LocationStates field's value.

func (DeleteFleetLocationsOutput) String added in v1.37.32 

func (s DeleteFleetLocationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFleetOutput 

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

func (DeleteFleetOutput) GoString 

func (s DeleteFleetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFleetOutput) String 

func (s DeleteFleetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteGameServerGroupInput added in v1.30.3 

type DeleteGameServerGroupInput struct {

	// The type of delete to perform. Options include the following:
	//
	//    * SAFE_DELETE – (default) Terminates the game server group and Amazon
	//    EC2 Auto Scaling group only when it has no game servers that are in UTILIZED
	//    status.
	//
	//    * FORCE_DELETE – Terminates the game server group, including all active
	//    game servers regardless of their utilization status, and the Amazon EC2
	//    Auto Scaling group.
	//
	//    * RETAIN – Does a safe delete of the game server group but retains the
	//    Amazon EC2 Auto Scaling group as is.
	DeleteOption *string `type:"string" enum:"GameServerGroupDeleteOption"`

	// A unique identifier for the game server group. Use either the name or ARN
	// value.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGameServerGroupInput) GoString added in v1.30.3 

func (s DeleteGameServerGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGameServerGroupInput) SetDeleteOption added in v1.30.3 

func (s *DeleteGameServerGroupInput) SetDeleteOption(v string) *DeleteGameServerGroupInput

SetDeleteOption sets the DeleteOption field's value.

func (*DeleteGameServerGroupInput) SetGameServerGroupName added in v1.30.3 

func (s *DeleteGameServerGroupInput) SetGameServerGroupName(v string) *DeleteGameServerGroupInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (DeleteGameServerGroupInput) String added in v1.30.3 

func (s DeleteGameServerGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGameServerGroupInput) Validate added in v1.30.3 

func (s *DeleteGameServerGroupInput) Validate() error

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

type DeleteGameServerGroupOutput added in v1.30.3 

type DeleteGameServerGroupOutput struct {

	// An object that describes the deleted game server group resource, with status
	// updated to DELETE_SCHEDULED.
	GameServerGroup *GameServerGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteGameServerGroupOutput) GoString added in v1.30.3 

func (s DeleteGameServerGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGameServerGroupOutput) SetGameServerGroup added in v1.30.3 

func (s *DeleteGameServerGroupOutput) SetGameServerGroup(v *GameServerGroup) *DeleteGameServerGroupOutput

SetGameServerGroup sets the GameServerGroup field's value.

func (DeleteGameServerGroupOutput) String added in v1.30.3 

func (s DeleteGameServerGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteGameSessionQueueInput added in v1.6.27 

type DeleteGameSessionQueueInput struct {

	// A descriptive label that is associated with game session queue. Queue names
	// must be unique within each Region. You can use either the queue ID or ARN
	// value.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGameSessionQueueInput) GoString added in v1.6.27 

func (s DeleteGameSessionQueueInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGameSessionQueueInput) SetName added in v1.6.27 

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

SetName sets the Name field's value.

func (DeleteGameSessionQueueInput) String added in v1.6.27 

func (s DeleteGameSessionQueueInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGameSessionQueueInput) Validate added in v1.6.27 

func (s *DeleteGameSessionQueueInput) Validate() error

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

type DeleteGameSessionQueueOutput added in v1.6.27 

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

func (DeleteGameSessionQueueOutput) GoString added in v1.6.27 

func (s DeleteGameSessionQueueOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteGameSessionQueueOutput) String added in v1.6.27 

func (s DeleteGameSessionQueueOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLocationInput added in v1.44.151 

type DeleteLocationInput struct {

	// The location name of the custom location to be deleted.
	//
	// LocationName is a required field
	LocationName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLocationInput) GoString added in v1.44.151 

func (s DeleteLocationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLocationInput) SetLocationName added in v1.44.151 

func (s *DeleteLocationInput) SetLocationName(v string) *DeleteLocationInput

SetLocationName sets the LocationName field's value.

func (DeleteLocationInput) String added in v1.44.151 

func (s DeleteLocationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLocationInput) Validate added in v1.44.151 

func (s *DeleteLocationInput) Validate() error

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

type DeleteLocationOutput added in v1.44.151 

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

func (DeleteLocationOutput) GoString added in v1.44.151 

func (s DeleteLocationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLocationOutput) String added in v1.44.151 

func (s DeleteLocationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteMatchmakingConfigurationInput added in v1.10.27 

type DeleteMatchmakingConfigurationInput struct {

	// A unique identifier for the matchmaking configuration. You can use either
	// the configuration name or ARN value.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMatchmakingConfigurationInput) GoString added in v1.10.27 

func (s DeleteMatchmakingConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMatchmakingConfigurationInput) SetName added in v1.10.27 

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

SetName sets the Name field's value.

func (DeleteMatchmakingConfigurationInput) String added in v1.10.27 

func (s DeleteMatchmakingConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMatchmakingConfigurationInput) Validate added in v1.10.27 

func (s *DeleteMatchmakingConfigurationInput) Validate() error

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

type DeleteMatchmakingConfigurationOutput added in v1.10.27 

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

func (DeleteMatchmakingConfigurationOutput) GoString added in v1.10.27 

func (s DeleteMatchmakingConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteMatchmakingConfigurationOutput) String added in v1.10.27 

func (s DeleteMatchmakingConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteMatchmakingRuleSetInput added in v1.16.30 

type DeleteMatchmakingRuleSetInput struct {

	// A unique identifier for the matchmaking rule set to be deleted. (Note: The
	// rule set name is different from the optional "name" field in the rule set
	// body.) You can use either the rule set name or ARN value.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMatchmakingRuleSetInput) GoString added in v1.16.30 

func (s DeleteMatchmakingRuleSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMatchmakingRuleSetInput) SetName added in v1.16.30 

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

SetName sets the Name field's value.

func (DeleteMatchmakingRuleSetInput) String added in v1.16.30 

func (s DeleteMatchmakingRuleSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMatchmakingRuleSetInput) Validate added in v1.16.30 

func (s *DeleteMatchmakingRuleSetInput) Validate() error

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

type DeleteMatchmakingRuleSetOutput added in v1.16.30 

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

func (DeleteMatchmakingRuleSetOutput) GoString added in v1.16.30 

func (s DeleteMatchmakingRuleSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteMatchmakingRuleSetOutput) String added in v1.16.30 

func (s DeleteMatchmakingRuleSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteScalingPolicyInput added in v1.1.10 

type DeleteScalingPolicyInput struct {

	// A unique identifier for the fleet to be deleted. You can use either the fleet
	// ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// A descriptive label that is associated with a fleet's 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
}

func (DeleteScalingPolicyInput) GoString added in v1.1.10 

func (s DeleteScalingPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScalingPolicyInput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (*DeleteScalingPolicyInput) SetName added in v1.5.0 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteScalingPolicyOutput) String added in v1.1.10 

func (s DeleteScalingPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteScriptInput added in v1.19.18 

type DeleteScriptInput struct {

	// A unique identifier for the Realtime script to delete. You can use either
	// the script ID or ARN value.
	//
	// ScriptId is a required field
	ScriptId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteScriptInput) GoString added in v1.19.18 

func (s DeleteScriptInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScriptInput) SetScriptId added in v1.19.18 

func (s *DeleteScriptInput) SetScriptId(v string) *DeleteScriptInput

SetScriptId sets the ScriptId field's value.

func (DeleteScriptInput) String added in v1.19.18 

func (s DeleteScriptInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScriptInput) Validate added in v1.19.18 

func (s *DeleteScriptInput) Validate() error

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

type DeleteScriptOutput added in v1.19.18 

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

func (DeleteScriptOutput) GoString added in v1.19.18 

func (s DeleteScriptOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteScriptOutput) String added in v1.19.18 

func (s DeleteScriptOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteVpcPeeringAuthorizationInput added in v1.10.37 

type DeleteVpcPeeringAuthorizationInput struct {

	// A unique identifier for the Amazon Web Services account that you use to manage
	// your Amazon GameLift fleet. You can find your Account ID in the Amazon Web
	// Services Management Console under account settings.
	//
	// GameLiftAwsAccountId is a required field
	GameLiftAwsAccountId *string `min:"1" type:"string" required:"true"`

	// A unique identifier for a VPC with resources to be accessed by your Amazon
	// GameLift fleet. The VPC must be in the same Region as your fleet. To look
	// up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/)
	// in the Amazon Web Services Management Console. Learn more about VPC peering
	// in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html).
	//
	// PeerVpcId is a required field
	PeerVpcId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVpcPeeringAuthorizationInput) GoString added in v1.10.37 

func (s DeleteVpcPeeringAuthorizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVpcPeeringAuthorizationInput) SetGameLiftAwsAccountId added in v1.10.37 

func (s *DeleteVpcPeeringAuthorizationInput) SetGameLiftAwsAccountId(v string) *DeleteVpcPeeringAuthorizationInput

SetGameLiftAwsAccountId sets the GameLiftAwsAccountId field's value.

func (*DeleteVpcPeeringAuthorizationInput) SetPeerVpcId added in v1.10.37 

func (s *DeleteVpcPeeringAuthorizationInput) SetPeerVpcId(v string) *DeleteVpcPeeringAuthorizationInput

SetPeerVpcId sets the PeerVpcId field's value.

func (DeleteVpcPeeringAuthorizationInput) String added in v1.10.37 

func (s DeleteVpcPeeringAuthorizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVpcPeeringAuthorizationInput) Validate added in v1.10.37 

func (s *DeleteVpcPeeringAuthorizationInput) Validate() error

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

type DeleteVpcPeeringAuthorizationOutput added in v1.10.37 

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

func (DeleteVpcPeeringAuthorizationOutput) GoString added in v1.10.37 

func (s DeleteVpcPeeringAuthorizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteVpcPeeringAuthorizationOutput) String added in v1.10.37 

func (s DeleteVpcPeeringAuthorizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteVpcPeeringConnectionInput added in v1.10.37 

type DeleteVpcPeeringConnectionInput struct {

	// A unique identifier for the fleet. This fleet specified must match the fleet
	// referenced in the VPC peering connection record. You can use either the fleet
	// ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// A unique identifier for a VPC peering connection.
	//
	// VpcPeeringConnectionId is a required field
	VpcPeeringConnectionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVpcPeeringConnectionInput) GoString added in v1.10.37 

func (s DeleteVpcPeeringConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVpcPeeringConnectionInput) SetFleetId added in v1.10.37 

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

SetFleetId sets the FleetId field's value.

func (*DeleteVpcPeeringConnectionInput) SetVpcPeeringConnectionId added in v1.10.37 

func (s *DeleteVpcPeeringConnectionInput) SetVpcPeeringConnectionId(v string) *DeleteVpcPeeringConnectionInput

SetVpcPeeringConnectionId sets the VpcPeeringConnectionId field's value.

func (DeleteVpcPeeringConnectionInput) String added in v1.10.37 

func (s DeleteVpcPeeringConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVpcPeeringConnectionInput) Validate added in v1.10.37 

func (s *DeleteVpcPeeringConnectionInput) Validate() error

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

type DeleteVpcPeeringConnectionOutput added in v1.10.37 

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

func (DeleteVpcPeeringConnectionOutput) GoString added in v1.10.37 

func (s DeleteVpcPeeringConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteVpcPeeringConnectionOutput) String added in v1.10.37 

func (s DeleteVpcPeeringConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeregisterComputeInput added in v1.44.151 

type DeregisterComputeInput struct {

	// The unique identifier of the compute resource to deregister. For an Anywhere
	// fleet compute, use the registered compute name. For a container fleet, use
	// the compute name (for example, a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)
	// or the compute ARN.
	//
	// ComputeName is a required field
	ComputeName *string `type:"string" required:"true"`

	// A unique identifier for the fleet the compute resource is currently registered
	// to.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterComputeInput) GoString added in v1.44.151 

func (s DeregisterComputeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterComputeInput) SetComputeName added in v1.44.151 

func (s *DeregisterComputeInput) SetComputeName(v string) *DeregisterComputeInput

SetComputeName sets the ComputeName field's value.

func (*DeregisterComputeInput) SetFleetId added in v1.44.151 

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

SetFleetId sets the FleetId field's value.

func (DeregisterComputeInput) String added in v1.44.151 

func (s DeregisterComputeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterComputeInput) Validate added in v1.44.151 

func (s *DeregisterComputeInput) Validate() error

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

type DeregisterComputeOutput added in v1.44.151 

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

func (DeregisterComputeOutput) GoString added in v1.44.151 

func (s DeregisterComputeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeregisterComputeOutput) String added in v1.44.151 

func (s DeregisterComputeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeregisterGameServerInput added in v1.30.3 

type DeregisterGameServerInput struct {

	// A unique identifier for the game server group where the game server is running.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// A custom string that uniquely identifies the game server to deregister.
	//
	// GameServerId is a required field
	GameServerId *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterGameServerInput) GoString added in v1.30.3 

func (s DeregisterGameServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterGameServerInput) SetGameServerGroupName added in v1.30.3 

func (s *DeregisterGameServerInput) SetGameServerGroupName(v string) *DeregisterGameServerInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*DeregisterGameServerInput) SetGameServerId added in v1.30.3 

func (s *DeregisterGameServerInput) SetGameServerId(v string) *DeregisterGameServerInput

SetGameServerId sets the GameServerId field's value.

func (DeregisterGameServerInput) String added in v1.30.3 

func (s DeregisterGameServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterGameServerInput) Validate added in v1.30.3 

func (s *DeregisterGameServerInput) Validate() error

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

type DeregisterGameServerOutput added in v1.30.3 

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

func (DeregisterGameServerOutput) GoString added in v1.30.3 

func (s DeregisterGameServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeregisterGameServerOutput) String added in v1.30.3 

func (s DeregisterGameServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAliasInput 

type DescribeAliasInput struct {

	// The unique identifier for the fleet alias that you want to retrieve. You
	// can use either the alias ID or ARN value.
	//
	// AliasId is a required field
	AliasId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAliasInput) GoString 

func (s DescribeAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The requested alias resource.
	Alias *Alias `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAliasOutput) GoString 

func (s DescribeAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAliasOutput) SetAlias added in v1.5.0 

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

SetAlias sets the Alias field's value.

func (DescribeAliasOutput) String 

func (s DescribeAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBuildInput 

type DescribeBuildInput struct {

	// A unique identifier for the build to retrieve properties for. You can use
	// either the build ID or ARN value.
	//
	// BuildId is a required field
	BuildId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBuildInput) GoString 

func (s DescribeBuildInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

func (DescribeBuildOutput) GoString 

func (s DescribeBuildOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBuildOutput) SetBuild added in v1.5.0 

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

SetBuild sets the Build field's value.

func (DescribeBuildOutput) String 

func (s DescribeBuildOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeComputeInput added in v1.44.151 

type DescribeComputeInput struct {

	// The unique identifier of the compute resource to retrieve properties for.
	// For an Anywhere fleet compute, use the registered compute name. For an EC2
	// fleet instance, use the instance ID. For a container fleet, use the compute
	// name (for example, a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)
	// or the compute ARN.
	//
	// ComputeName is a required field
	ComputeName *string `type:"string" required:"true"`

	// A unique identifier for the fleet that the compute belongs to. You can use
	// either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeComputeInput) GoString added in v1.44.151 

func (s DescribeComputeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeComputeInput) SetComputeName added in v1.44.151 

func (s *DescribeComputeInput) SetComputeName(v string) *DescribeComputeInput

SetComputeName sets the ComputeName field's value.

func (*DescribeComputeInput) SetFleetId added in v1.44.151 

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

SetFleetId sets the FleetId field's value.

func (DescribeComputeInput) String added in v1.44.151 

func (s DescribeComputeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeComputeInput) Validate added in v1.44.151 

func (s *DescribeComputeInput) Validate() error

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

type DescribeComputeOutput added in v1.44.151 

type DescribeComputeOutput struct {

	// The set of properties for the requested compute resource.
	Compute *Compute `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeComputeOutput) GoString added in v1.44.151 

func (s DescribeComputeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeComputeOutput) SetCompute added in v1.44.151 

func (s *DescribeComputeOutput) SetCompute(v *Compute) *DescribeComputeOutput

SetCompute sets the Compute field's value.

func (DescribeComputeOutput) String added in v1.44.151 

func (s DescribeComputeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeContainerGroupDefinitionInput added in v1.51.28 

type DescribeContainerGroupDefinitionInput struct {

	// The unique identifier for the container group definition to retrieve properties
	// for. You can use either the Name or ARN value.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeContainerGroupDefinitionInput) GoString added in v1.51.28 

func (s DescribeContainerGroupDefinitionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeContainerGroupDefinitionInput) SetName added in v1.51.28 

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

SetName sets the Name field's value.

func (DescribeContainerGroupDefinitionInput) String added in v1.51.28 

func (s DescribeContainerGroupDefinitionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeContainerGroupDefinitionInput) Validate added in v1.51.28 

func (s *DescribeContainerGroupDefinitionInput) Validate() error

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

type DescribeContainerGroupDefinitionOutput added in v1.51.28 

type DescribeContainerGroupDefinitionOutput struct {

	// The properties of the requested container group definition resource.
	ContainerGroupDefinition *ContainerGroupDefinition `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeContainerGroupDefinitionOutput) GoString added in v1.51.28 

func (s DescribeContainerGroupDefinitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeContainerGroupDefinitionOutput) SetContainerGroupDefinition added in v1.51.28 

func (s *DescribeContainerGroupDefinitionOutput) SetContainerGroupDefinition(v *ContainerGroupDefinition) *DescribeContainerGroupDefinitionOutput

SetContainerGroupDefinition sets the ContainerGroupDefinition field's value.

func (DescribeContainerGroupDefinitionOutput) String added in v1.51.28 

func (s DescribeContainerGroupDefinitionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEC2InstanceLimitsInput 

type DescribeEC2InstanceLimitsInput struct {

	// Name of an Amazon 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. Do
	// not specify a value for this parameter to retrieve limits for all instance
	// types.
	EC2InstanceType *string `type:"string" enum:"EC2InstanceType"`

	// The name of a remote location to request instance limits for, in the form
	// of an Amazon Web Services Region code such as us-west-2.
	Location *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEC2InstanceLimitsInput) GoString 

func (s DescribeEC2InstanceLimitsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEC2InstanceLimitsInput) SetEC2InstanceType added in v1.5.0 

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

SetEC2InstanceType sets the EC2InstanceType field's value.

func (*DescribeEC2InstanceLimitsInput) SetLocation added in v1.37.32 

func (s *DescribeEC2InstanceLimitsInput) SetLocation(v string) *DescribeEC2InstanceLimitsInput

SetLocation sets the Location field's value.

func (DescribeEC2InstanceLimitsInput) String 

func (s DescribeEC2InstanceLimitsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEC2InstanceLimitsInput) Validate added in v1.37.32 

func (s *DescribeEC2InstanceLimitsInput) Validate() error

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

type DescribeEC2InstanceLimitsOutput 

type DescribeEC2InstanceLimitsOutput struct {

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

func (DescribeEC2InstanceLimitsOutput) GoString 

func (s DescribeEC2InstanceLimitsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEC2InstanceLimitsOutput) SetEC2InstanceLimits added in v1.5.0 

func (s *DescribeEC2InstanceLimitsOutput) SetEC2InstanceLimits(v []*EC2InstanceLimit) *DescribeEC2InstanceLimitsOutput

SetEC2InstanceLimits sets the EC2InstanceLimits field's value.

func (DescribeEC2InstanceLimitsOutput) String 

func (s DescribeEC2InstanceLimitsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFleetAttributesInput 

type DescribeFleetAttributesInput struct {

	// A list of unique fleet identifiers to retrieve attributes for. You can use
	// either the fleet ID or ARN value. To retrieve attributes for all current
	// fleets, do not include this parameter.
	FleetIds []*string `min:"1" type:"list"`

	// The 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"`

	// A token that indicates the start of the next sequential page of results.
	// Use the token that is returned with a previous call to this operation. To
	// start at the beginning of the result set, do not specify a value. 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
}

func (DescribeFleetAttributesInput) GoString 

func (s DescribeFleetAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetAttributesInput) SetFleetIds added in v1.5.0 

func (s *DescribeFleetAttributesInput) SetFleetIds(v []*string) *DescribeFleetAttributesInput

SetFleetIds sets the FleetIds field's value.

func (*DescribeFleetAttributesInput) SetLimit added in v1.5.0 

func (s *DescribeFleetAttributesInput) SetLimit(v int64) *DescribeFleetAttributesInput

SetLimit sets the Limit field's value.

func (*DescribeFleetAttributesInput) SetNextToken added in v1.5.0 

func (s *DescribeFleetAttributesInput) SetNextToken(v string) *DescribeFleetAttributesInput

SetNextToken sets the NextToken field's value.

func (DescribeFleetAttributesInput) String 

func (s DescribeFleetAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A collection of objects containing attribute metadata for each requested
	// fleet ID. Attribute objects are returned only for fleets that currently exist.
	FleetAttributes []*FleetAttributes `type:"list"`

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

func (DescribeFleetAttributesOutput) GoString 

func (s DescribeFleetAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetAttributesOutput) SetFleetAttributes added in v1.5.0 

func (s *DescribeFleetAttributesOutput) SetFleetAttributes(v []*FleetAttributes) *DescribeFleetAttributesOutput

SetFleetAttributes sets the FleetAttributes field's value.

func (*DescribeFleetAttributesOutput) SetNextToken added in v1.5.0 

func (s *DescribeFleetAttributesOutput) SetNextToken(v string) *DescribeFleetAttributesOutput

SetNextToken sets the NextToken field's value.

func (DescribeFleetAttributesOutput) String 

func (s DescribeFleetAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFleetCapacityInput 

type DescribeFleetCapacityInput struct {

	// A unique identifier for the fleet to retrieve capacity information for. You
	// can use either the fleet ID or ARN value. Leave this parameter empty to retrieve
	// capacity information for all fleets.
	FleetIds []*string `min:"1" type:"list"`

	// The 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"`

	// A token that indicates the start of the next sequential page of results.
	// Use the token that is returned with a previous call to this operation. To
	// start at the beginning of the result set, do not specify a value. 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
}

func (DescribeFleetCapacityInput) GoString 

func (s DescribeFleetCapacityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetCapacityInput) SetFleetIds added in v1.5.0 

func (s *DescribeFleetCapacityInput) SetFleetIds(v []*string) *DescribeFleetCapacityInput

SetFleetIds sets the FleetIds field's value.

func (*DescribeFleetCapacityInput) SetLimit added in v1.5.0 

func (s *DescribeFleetCapacityInput) SetLimit(v int64) *DescribeFleetCapacityInput

SetLimit sets the Limit field's value.

func (*DescribeFleetCapacityInput) SetNextToken added in v1.5.0 

func (s *DescribeFleetCapacityInput) SetNextToken(v string) *DescribeFleetCapacityInput

SetNextToken sets the NextToken field's value.

func (DescribeFleetCapacityInput) String 

func (s DescribeFleetCapacityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A collection of objects that contains capacity information for each requested
	// fleet ID. Capacity objects are returned only for fleets that currently exist.
	// Changes in desired instance value can take up to 1 minute to be reflected.
	FleetCapacity []*FleetCapacity `type:"list"`

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

func (DescribeFleetCapacityOutput) GoString 

func (s DescribeFleetCapacityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetCapacityOutput) SetFleetCapacity added in v1.5.0 

func (s *DescribeFleetCapacityOutput) SetFleetCapacity(v []*FleetCapacity) *DescribeFleetCapacityOutput

SetFleetCapacity sets the FleetCapacity field's value.

func (*DescribeFleetCapacityOutput) SetNextToken added in v1.5.0 

func (s *DescribeFleetCapacityOutput) SetNextToken(v string) *DescribeFleetCapacityOutput

SetNextToken sets the NextToken field's value.

func (DescribeFleetCapacityOutput) String 

func (s DescribeFleetCapacityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFleetEventsInput 

type DescribeFleetEventsInput struct {

	// The 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"`

	// A unique identifier for the fleet to get event logs for. You can use either
	// the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The 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"`

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

	// The 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"`
	// contains filtered or unexported fields
}

func (DescribeFleetEventsInput) GoString 

func (s DescribeFleetEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetEventsInput) SetEndTime added in v1.5.0 

func (s *DescribeFleetEventsInput) SetEndTime(v time.Time) *DescribeFleetEventsInput

SetEndTime sets the EndTime field's value.

func (*DescribeFleetEventsInput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (*DescribeFleetEventsInput) SetLimit added in v1.5.0 

func (s *DescribeFleetEventsInput) SetLimit(v int64) *DescribeFleetEventsInput

SetLimit sets the Limit field's value.

func (*DescribeFleetEventsInput) SetNextToken added in v1.5.0 

func (s *DescribeFleetEventsInput) SetNextToken(v string) *DescribeFleetEventsInput

SetNextToken sets the NextToken field's value.

func (*DescribeFleetEventsInput) SetStartTime added in v1.5.0 

func (s *DescribeFleetEventsInput) SetStartTime(v time.Time) *DescribeFleetEventsInput

SetStartTime sets the StartTime field's value.

func (DescribeFleetEventsInput) String 

func (s DescribeFleetEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

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

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

func (DescribeFleetEventsOutput) GoString 

func (s DescribeFleetEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetEventsOutput) SetEvents added in v1.5.0 

func (s *DescribeFleetEventsOutput) SetEvents(v []*Event) *DescribeFleetEventsOutput

SetEvents sets the Events field's value.

func (*DescribeFleetEventsOutput) SetNextToken added in v1.5.0 

func (s *DescribeFleetEventsOutput) SetNextToken(v string) *DescribeFleetEventsOutput

SetNextToken sets the NextToken field's value.

func (DescribeFleetEventsOutput) String 

func (s DescribeFleetEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFleetLocationAttributesInput added in v1.37.32 

type DescribeFleetLocationAttributesInput struct {

	// A unique identifier for the fleet to retrieve remote locations for. You can
	// use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The maximum number of results to return. Use this parameter with NextToken
	// to get results as a set of sequential pages. This limit is not currently
	// enforced.
	Limit *int64 `min:"1" type:"integer"`

	// A list of fleet locations to retrieve information for. Specify locations
	// in the form of an Amazon Web Services Region code, such as us-west-2.
	Locations []*string `min:"1" type:"list"`

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

func (DescribeFleetLocationAttributesInput) GoString added in v1.37.32 

func (s DescribeFleetLocationAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetLocationAttributesInput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (*DescribeFleetLocationAttributesInput) SetLimit added in v1.37.32 

func (s *DescribeFleetLocationAttributesInput) SetLimit(v int64) *DescribeFleetLocationAttributesInput

SetLimit sets the Limit field's value.

func (*DescribeFleetLocationAttributesInput) SetLocations added in v1.37.32 

func (s *DescribeFleetLocationAttributesInput) SetLocations(v []*string) *DescribeFleetLocationAttributesInput

SetLocations sets the Locations field's value.

func (*DescribeFleetLocationAttributesInput) SetNextToken added in v1.37.32 

func (s *DescribeFleetLocationAttributesInput) SetNextToken(v string) *DescribeFleetLocationAttributesInput

SetNextToken sets the NextToken field's value.

func (DescribeFleetLocationAttributesInput) String added in v1.37.32 

func (s DescribeFleetLocationAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetLocationAttributesInput) Validate added in v1.37.32 

func (s *DescribeFleetLocationAttributesInput) Validate() error

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

type DescribeFleetLocationAttributesOutput added in v1.37.32 

type DescribeFleetLocationAttributesOutput struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that location attributes were requested
	// for.
	FleetId *string `type:"string"`

	// Location-specific information on the requested fleet's remote locations.
	LocationAttributes []*LocationAttributes `type:"list"`

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

func (DescribeFleetLocationAttributesOutput) GoString added in v1.37.32 

func (s DescribeFleetLocationAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetLocationAttributesOutput) SetFleetArn added in v1.37.32 

func (s *DescribeFleetLocationAttributesOutput) SetFleetArn(v string) *DescribeFleetLocationAttributesOutput

SetFleetArn sets the FleetArn field's value.

func (*DescribeFleetLocationAttributesOutput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (*DescribeFleetLocationAttributesOutput) SetLocationAttributes added in v1.37.32 

func (s *DescribeFleetLocationAttributesOutput) SetLocationAttributes(v []*LocationAttributes) *DescribeFleetLocationAttributesOutput

SetLocationAttributes sets the LocationAttributes field's value.

func (*DescribeFleetLocationAttributesOutput) SetNextToken added in v1.37.32 

func (s *DescribeFleetLocationAttributesOutput) SetNextToken(v string) *DescribeFleetLocationAttributesOutput

SetNextToken sets the NextToken field's value.

func (DescribeFleetLocationAttributesOutput) String added in v1.37.32 

func (s DescribeFleetLocationAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFleetLocationCapacityInput added in v1.37.32 

type DescribeFleetLocationCapacityInput struct {

	// A unique identifier for the fleet to request location capacity for. You can
	// use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The fleet location to retrieve capacity information for. Specify a location
	// in the form of an Amazon Web Services Region code, such as us-west-2.
	//
	// Location is a required field
	Location *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFleetLocationCapacityInput) GoString added in v1.37.32 

func (s DescribeFleetLocationCapacityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetLocationCapacityInput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (*DescribeFleetLocationCapacityInput) SetLocation added in v1.37.32 

func (s *DescribeFleetLocationCapacityInput) SetLocation(v string) *DescribeFleetLocationCapacityInput

SetLocation sets the Location field's value.

func (DescribeFleetLocationCapacityInput) String added in v1.37.32 

func (s DescribeFleetLocationCapacityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetLocationCapacityInput) Validate added in v1.37.32 

func (s *DescribeFleetLocationCapacityInput) Validate() error

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

type DescribeFleetLocationCapacityOutput added in v1.37.32 

type DescribeFleetLocationCapacityOutput struct {

	// Resource capacity information for the requested fleet location. Capacity
	// objects are returned only for fleets and locations that currently exist.
	// Changes in desired instance value can take up to 1 minute to be reflected.
	FleetCapacity *FleetCapacity `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeFleetLocationCapacityOutput) GoString added in v1.37.32 

func (s DescribeFleetLocationCapacityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetLocationCapacityOutput) SetFleetCapacity added in v1.37.32 

func (s *DescribeFleetLocationCapacityOutput) SetFleetCapacity(v *FleetCapacity) *DescribeFleetLocationCapacityOutput

SetFleetCapacity sets the FleetCapacity field's value.

func (DescribeFleetLocationCapacityOutput) String added in v1.37.32 

func (s DescribeFleetLocationCapacityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFleetLocationUtilizationInput added in v1.37.32 

type DescribeFleetLocationUtilizationInput struct {

	// A unique identifier for the fleet to request location utilization for. You
	// can use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The fleet location to retrieve utilization information for. Specify a location
	// in the form of an Amazon Web Services Region code, such as us-west-2.
	//
	// Location is a required field
	Location *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFleetLocationUtilizationInput) GoString added in v1.37.32 

func (s DescribeFleetLocationUtilizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetLocationUtilizationInput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (*DescribeFleetLocationUtilizationInput) SetLocation added in v1.37.32 

func (s *DescribeFleetLocationUtilizationInput) SetLocation(v string) *DescribeFleetLocationUtilizationInput

SetLocation sets the Location field's value.

func (DescribeFleetLocationUtilizationInput) String added in v1.37.32 

func (s DescribeFleetLocationUtilizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetLocationUtilizationInput) Validate added in v1.37.32 

func (s *DescribeFleetLocationUtilizationInput) Validate() error

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

type DescribeFleetLocationUtilizationOutput added in v1.37.32 

type DescribeFleetLocationUtilizationOutput struct {

	// Utilization information for the requested fleet location. Utilization objects
	// are returned only for fleets and locations that currently exist.
	FleetUtilization *FleetUtilization `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeFleetLocationUtilizationOutput) GoString added in v1.37.32 

func (s DescribeFleetLocationUtilizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetLocationUtilizationOutput) SetFleetUtilization added in v1.37.32 

func (s *DescribeFleetLocationUtilizationOutput) SetFleetUtilization(v *FleetUtilization) *DescribeFleetLocationUtilizationOutput

SetFleetUtilization sets the FleetUtilization field's value.

func (DescribeFleetLocationUtilizationOutput) String added in v1.37.32 

func (s DescribeFleetLocationUtilizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFleetPortSettingsInput 

type DescribeFleetPortSettingsInput struct {

	// A unique identifier for the fleet to retrieve port settings for. You can
	// use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// A remote location to check for status of port setting updates. Use the Amazon
	// Web Services Region code format, such as us-west-2.
	Location *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFleetPortSettingsInput) GoString 

func (s DescribeFleetPortSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetPortSettingsInput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (*DescribeFleetPortSettingsInput) SetLocation added in v1.37.32 

func (s *DescribeFleetPortSettingsInput) SetLocation(v string) *DescribeFleetPortSettingsInput

SetLocation sets the Location field's value.

func (DescribeFleetPortSettingsInput) String 

func (s DescribeFleetPortSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that was requested.
	FleetId *string `type:"string"`

	// The port settings for the requested fleet ID.
	InboundPermissions []*IpPermission `type:"list"`

	// The requested fleet location, expressed as an Amazon Web Services Region
	// code, such as us-west-2.
	Location *string `min:"1" type:"string"`

	// The current status of updates to the fleet's port settings in the requested
	// fleet location. A status of PENDING_UPDATE indicates that an update was requested
	// for the fleet but has not yet been completed for the location.
	UpdateStatus *string `type:"string" enum:"LocationUpdateStatus"`
	// contains filtered or unexported fields
}

func (DescribeFleetPortSettingsOutput) GoString 

func (s DescribeFleetPortSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetPortSettingsOutput) SetFleetArn added in v1.37.32 

func (s *DescribeFleetPortSettingsOutput) SetFleetArn(v string) *DescribeFleetPortSettingsOutput

SetFleetArn sets the FleetArn field's value.

func (*DescribeFleetPortSettingsOutput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (*DescribeFleetPortSettingsOutput) SetInboundPermissions added in v1.5.0 

func (s *DescribeFleetPortSettingsOutput) SetInboundPermissions(v []*IpPermission) *DescribeFleetPortSettingsOutput

SetInboundPermissions sets the InboundPermissions field's value.

func (*DescribeFleetPortSettingsOutput) SetLocation added in v1.37.32 

func (s *DescribeFleetPortSettingsOutput) SetLocation(v string) *DescribeFleetPortSettingsOutput

SetLocation sets the Location field's value.

func (*DescribeFleetPortSettingsOutput) SetUpdateStatus added in v1.37.32 

func (s *DescribeFleetPortSettingsOutput) SetUpdateStatus(v string) *DescribeFleetPortSettingsOutput

SetUpdateStatus sets the UpdateStatus field's value.

func (DescribeFleetPortSettingsOutput) String 

func (s DescribeFleetPortSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFleetUtilizationInput 

type DescribeFleetUtilizationInput struct {

	// A unique identifier for the fleet to retrieve utilization data for. You can
	// use either the fleet ID or ARN value. To retrieve attributes for all current
	// fleets, do not include this parameter.
	FleetIds []*string `min:"1" type:"list"`

	// The 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"`

	// A token that indicates the start of the next sequential page of results.
	// Use the token that is returned with a previous call to this operation. To
	// start at the beginning of the result set, do not specify a value. 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
}

func (DescribeFleetUtilizationInput) GoString 

func (s DescribeFleetUtilizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetUtilizationInput) SetFleetIds added in v1.5.0 

func (s *DescribeFleetUtilizationInput) SetFleetIds(v []*string) *DescribeFleetUtilizationInput

SetFleetIds sets the FleetIds field's value.

func (*DescribeFleetUtilizationInput) SetLimit added in v1.5.0 

func (s *DescribeFleetUtilizationInput) SetLimit(v int64) *DescribeFleetUtilizationInput

SetLimit sets the Limit field's value.

func (*DescribeFleetUtilizationInput) SetNextToken added in v1.5.0 

func (s *DescribeFleetUtilizationInput) SetNextToken(v string) *DescribeFleetUtilizationInput

SetNextToken sets the NextToken field's value.

func (DescribeFleetUtilizationInput) String 

func (s DescribeFleetUtilizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A collection of objects containing utilization information for each requested
	// fleet ID. Utilization objects are returned only for fleets that currently
	// exist.
	FleetUtilization []*FleetUtilization `type:"list"`

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

func (DescribeFleetUtilizationOutput) GoString 

func (s DescribeFleetUtilizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetUtilizationOutput) SetFleetUtilization added in v1.5.0 

func (s *DescribeFleetUtilizationOutput) SetFleetUtilization(v []*FleetUtilization) *DescribeFleetUtilizationOutput

SetFleetUtilization sets the FleetUtilization field's value.

func (*DescribeFleetUtilizationOutput) SetNextToken added in v1.5.0 

func (s *DescribeFleetUtilizationOutput) SetNextToken(v string) *DescribeFleetUtilizationOutput

SetNextToken sets the NextToken field's value.

func (DescribeFleetUtilizationOutput) String 

func (s DescribeFleetUtilizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGameServerGroupInput added in v1.30.3 

type DescribeGameServerGroupInput struct {

	// A unique identifier for the game server group. Use either the name or ARN
	// value.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGameServerGroupInput) GoString added in v1.30.3 

func (s DescribeGameServerGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameServerGroupInput) SetGameServerGroupName added in v1.30.3 

func (s *DescribeGameServerGroupInput) SetGameServerGroupName(v string) *DescribeGameServerGroupInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (DescribeGameServerGroupInput) String added in v1.30.3 

func (s DescribeGameServerGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameServerGroupInput) Validate added in v1.30.3 

func (s *DescribeGameServerGroupInput) Validate() error

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

type DescribeGameServerGroupOutput added in v1.30.3 

type DescribeGameServerGroupOutput struct {

	// An object with the property settings for the requested game server group
	// resource.
	GameServerGroup *GameServerGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeGameServerGroupOutput) GoString added in v1.30.3 

func (s DescribeGameServerGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameServerGroupOutput) SetGameServerGroup added in v1.30.3 

func (s *DescribeGameServerGroupOutput) SetGameServerGroup(v *GameServerGroup) *DescribeGameServerGroupOutput

SetGameServerGroup sets the GameServerGroup field's value.

func (DescribeGameServerGroupOutput) String added in v1.30.3 

func (s DescribeGameServerGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGameServerInput added in v1.30.3 

type DescribeGameServerInput struct {

	// A unique identifier for the game server group where the game server is running.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// A custom string that uniquely identifies the game server information to be
	// retrieved.
	//
	// GameServerId is a required field
	GameServerId *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGameServerInput) GoString added in v1.30.3 

func (s DescribeGameServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameServerInput) SetGameServerGroupName added in v1.30.3 

func (s *DescribeGameServerInput) SetGameServerGroupName(v string) *DescribeGameServerInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*DescribeGameServerInput) SetGameServerId added in v1.30.3 

func (s *DescribeGameServerInput) SetGameServerId(v string) *DescribeGameServerInput

SetGameServerId sets the GameServerId field's value.

func (DescribeGameServerInput) String added in v1.30.3 

func (s DescribeGameServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameServerInput) Validate added in v1.30.3 

func (s *DescribeGameServerInput) Validate() error

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

type DescribeGameServerInstancesInput added in v1.34.12 

type DescribeGameServerInstancesInput struct {

	// A unique identifier for the game server group. Use either the name or ARN
	// value.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2
	// instance IDs use a 17-character format, for example: i-1234567890abcdef0.
	// To retrieve all instances in the game server group, leave this parameter
	// empty.
	InstanceIds []*string `min:"1" type:"list"`

	// The 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"`

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

func (DescribeGameServerInstancesInput) GoString added in v1.34.12 

func (s DescribeGameServerInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameServerInstancesInput) SetGameServerGroupName added in v1.34.12 

func (s *DescribeGameServerInstancesInput) SetGameServerGroupName(v string) *DescribeGameServerInstancesInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*DescribeGameServerInstancesInput) SetInstanceIds added in v1.34.12 

func (s *DescribeGameServerInstancesInput) SetInstanceIds(v []*string) *DescribeGameServerInstancesInput

SetInstanceIds sets the InstanceIds field's value.

func (*DescribeGameServerInstancesInput) SetLimit added in v1.34.12 

func (s *DescribeGameServerInstancesInput) SetLimit(v int64) *DescribeGameServerInstancesInput

SetLimit sets the Limit field's value.

func (*DescribeGameServerInstancesInput) SetNextToken added in v1.34.12 

func (s *DescribeGameServerInstancesInput) SetNextToken(v string) *DescribeGameServerInstancesInput

SetNextToken sets the NextToken field's value.

func (DescribeGameServerInstancesInput) String added in v1.34.12 

func (s DescribeGameServerInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameServerInstancesInput) Validate added in v1.34.12 

func (s *DescribeGameServerInstancesInput) Validate() error

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

type DescribeGameServerInstancesOutput added in v1.34.12 

type DescribeGameServerInstancesOutput struct {

	// The collection of requested game server instances.
	GameServerInstances []*GameServerInstance `type:"list"`

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

func (DescribeGameServerInstancesOutput) GoString added in v1.34.12 

func (s DescribeGameServerInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameServerInstancesOutput) SetGameServerInstances added in v1.34.12 

func (s *DescribeGameServerInstancesOutput) SetGameServerInstances(v []*GameServerInstance) *DescribeGameServerInstancesOutput

SetGameServerInstances sets the GameServerInstances field's value.

func (*DescribeGameServerInstancesOutput) SetNextToken added in v1.34.12 

func (s *DescribeGameServerInstancesOutput) SetNextToken(v string) *DescribeGameServerInstancesOutput

SetNextToken sets the NextToken field's value.

func (DescribeGameServerInstancesOutput) String added in v1.34.12 

func (s DescribeGameServerInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGameServerOutput added in v1.30.3 

type DescribeGameServerOutput struct {

	// Object that describes the requested game server.
	GameServer *GameServer `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeGameServerOutput) GoString added in v1.30.3 

func (s DescribeGameServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameServerOutput) SetGameServer added in v1.30.3 

func (s *DescribeGameServerOutput) SetGameServer(v *GameServer) *DescribeGameServerOutput

SetGameServer sets the GameServer field's value.

func (DescribeGameServerOutput) String added in v1.30.3 

func (s DescribeGameServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGameSessionDetailsInput added in v1.1.10 

type DescribeGameSessionDetailsInput struct {

	// A unique identifier for the alias associated with the fleet to retrieve all
	// game sessions for. You can use either the alias ID or ARN value.
	AliasId *string `type:"string"`

	// A unique identifier for the fleet to retrieve all game sessions active on
	// the fleet. You can use either the fleet ID or ARN value.
	FleetId *string `type:"string"`

	// A unique identifier for the game session to retrieve.
	GameSessionId *string `min:"1" type:"string"`

	// The 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"`

	// A fleet location to get game session details for. You can specify a fleet's
	// home Region or a remote location. Use the Amazon Web Services Region code
	// format, such as us-west-2.
	Location *string `min:"1" type:"string"`

	// A token that indicates the start of the next sequential page of results.
	// Use the token that is returned with a previous call to this operation. To
	// start at the beginning of the result set, do not specify a value.
	NextToken *string `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
}

func (DescribeGameSessionDetailsInput) GoString added in v1.1.10 

func (s DescribeGameSessionDetailsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameSessionDetailsInput) SetAliasId added in v1.5.0 

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

SetAliasId sets the AliasId field's value.

func (*DescribeGameSessionDetailsInput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (*DescribeGameSessionDetailsInput) SetGameSessionId added in v1.5.0 

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

SetGameSessionId sets the GameSessionId field's value.

func (*DescribeGameSessionDetailsInput) SetLimit added in v1.5.0 

func (s *DescribeGameSessionDetailsInput) SetLimit(v int64) *DescribeGameSessionDetailsInput

SetLimit sets the Limit field's value.

func (*DescribeGameSessionDetailsInput) SetLocation added in v1.37.32 

func (s *DescribeGameSessionDetailsInput) SetLocation(v string) *DescribeGameSessionDetailsInput

SetLocation sets the Location field's value.

func (*DescribeGameSessionDetailsInput) SetNextToken added in v1.5.0 

func (s *DescribeGameSessionDetailsInput) SetNextToken(v string) *DescribeGameSessionDetailsInput

SetNextToken sets the NextToken field's value.

func (*DescribeGameSessionDetailsInput) SetStatusFilter added in v1.5.0 

func (s *DescribeGameSessionDetailsInput) SetStatusFilter(v string) *DescribeGameSessionDetailsInput

SetStatusFilter sets the StatusFilter field's value.

func (DescribeGameSessionDetailsInput) String added in v1.1.10 

func (s DescribeGameSessionDetailsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A collection of properties for each game session that matches the request.
	GameSessionDetails []*GameSessionDetail `type:"list"`

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

func (DescribeGameSessionDetailsOutput) GoString added in v1.1.10 

func (s DescribeGameSessionDetailsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameSessionDetailsOutput) SetGameSessionDetails added in v1.5.0 

func (s *DescribeGameSessionDetailsOutput) SetGameSessionDetails(v []*GameSessionDetail) *DescribeGameSessionDetailsOutput

SetGameSessionDetails sets the GameSessionDetails field's value.

func (*DescribeGameSessionDetailsOutput) SetNextToken added in v1.5.0 

func (s *DescribeGameSessionDetailsOutput) SetNextToken(v string) *DescribeGameSessionDetailsOutput

SetNextToken sets the NextToken field's value.

func (DescribeGameSessionDetailsOutput) String added in v1.1.10 

func (s DescribeGameSessionDetailsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGameSessionPlacementInput added in v1.6.27 

type DescribeGameSessionPlacementInput struct {

	// A unique identifier for a game session placement to retrieve.
	//
	// PlacementId is a required field
	PlacementId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGameSessionPlacementInput) GoString added in v1.6.27 

func (s DescribeGameSessionPlacementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameSessionPlacementInput) SetPlacementId added in v1.6.27 

func (s *DescribeGameSessionPlacementInput) SetPlacementId(v string) *DescribeGameSessionPlacementInput

SetPlacementId sets the PlacementId field's value.

func (DescribeGameSessionPlacementInput) String added in v1.6.27 

func (s DescribeGameSessionPlacementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameSessionPlacementInput) Validate added in v1.6.27 

func (s *DescribeGameSessionPlacementInput) Validate() error

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

type DescribeGameSessionPlacementOutput added in v1.6.27 

type DescribeGameSessionPlacementOutput struct {

	// Object that describes the requested game session placement.
	GameSessionPlacement *GameSessionPlacement `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeGameSessionPlacementOutput) GoString added in v1.6.27 

func (s DescribeGameSessionPlacementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameSessionPlacementOutput) SetGameSessionPlacement added in v1.6.27 

func (s *DescribeGameSessionPlacementOutput) SetGameSessionPlacement(v *GameSessionPlacement) *DescribeGameSessionPlacementOutput

SetGameSessionPlacement sets the GameSessionPlacement field's value.

func (DescribeGameSessionPlacementOutput) String added in v1.6.27 

func (s DescribeGameSessionPlacementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGameSessionQueuesInput added in v1.6.27 

type DescribeGameSessionQueuesInput struct {

	// The maximum number of results to return. Use this parameter with NextToken
	// to get results as a set of sequential pages. You can request up to 50 results.
	Limit *int64 `min:"1" type:"integer"`

	// A list of queue names to retrieve information for. You can use either the
	// queue ID or ARN value. To request settings for all queues, leave this parameter
	// empty.
	Names []*string `type:"list"`

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

func (DescribeGameSessionQueuesInput) GoString added in v1.6.27 

func (s DescribeGameSessionQueuesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameSessionQueuesInput) SetLimit added in v1.6.27 

func (s *DescribeGameSessionQueuesInput) SetLimit(v int64) *DescribeGameSessionQueuesInput

SetLimit sets the Limit field's value.

func (*DescribeGameSessionQueuesInput) SetNames added in v1.6.27 

func (s *DescribeGameSessionQueuesInput) SetNames(v []*string) *DescribeGameSessionQueuesInput

SetNames sets the Names field's value.

func (*DescribeGameSessionQueuesInput) SetNextToken added in v1.6.27 

func (s *DescribeGameSessionQueuesInput) SetNextToken(v string) *DescribeGameSessionQueuesInput

SetNextToken sets the NextToken field's value.

func (DescribeGameSessionQueuesInput) String added in v1.6.27 

func (s DescribeGameSessionQueuesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameSessionQueuesInput) Validate added in v1.6.27 

func (s *DescribeGameSessionQueuesInput) Validate() error

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

type DescribeGameSessionQueuesOutput added in v1.6.27 

type DescribeGameSessionQueuesOutput struct {

	// A collection of objects that describe the requested game session queues.
	GameSessionQueues []*GameSessionQueue `type:"list"`

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

func (DescribeGameSessionQueuesOutput) GoString added in v1.6.27 

func (s DescribeGameSessionQueuesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameSessionQueuesOutput) SetGameSessionQueues added in v1.6.27 

func (s *DescribeGameSessionQueuesOutput) SetGameSessionQueues(v []*GameSessionQueue) *DescribeGameSessionQueuesOutput

SetGameSessionQueues sets the GameSessionQueues field's value.

func (*DescribeGameSessionQueuesOutput) SetNextToken added in v1.6.27 

func (s *DescribeGameSessionQueuesOutput) SetNextToken(v string) *DescribeGameSessionQueuesOutput

SetNextToken sets the NextToken field's value.

func (DescribeGameSessionQueuesOutput) String added in v1.6.27 

func (s DescribeGameSessionQueuesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGameSessionsInput 

type DescribeGameSessionsInput struct {

	// A unique identifier for the alias associated with the fleet to retrieve game
	// sessions for. You can use either the alias ID or ARN value.
	AliasId *string `type:"string"`

	// A unique identifier for the fleet to retrieve game sessions for. You can
	// use either the fleet ID or ARN value.
	FleetId *string `type:"string"`

	// A unique identifier for the game session to retrieve.
	GameSessionId *string `min:"1" type:"string"`

	// The 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"`

	// A fleet location to get game sessions for. You can specify a fleet's home
	// Region or a remote location. Use the Amazon Web Services Region code format,
	// such as us-west-2.
	Location *string `min:"1" type:"string"`

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

	// Game session status to filter results on. You can filter on the following
	// states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are
	// transitory and used for only very brief periods of time.
	StatusFilter *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeGameSessionsInput) GoString 

func (s DescribeGameSessionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameSessionsInput) SetAliasId added in v1.5.0 

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

SetAliasId sets the AliasId field's value.

func (*DescribeGameSessionsInput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (*DescribeGameSessionsInput) SetGameSessionId added in v1.5.0 

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

SetGameSessionId sets the GameSessionId field's value.

func (*DescribeGameSessionsInput) SetLimit added in v1.5.0 

func (s *DescribeGameSessionsInput) SetLimit(v int64) *DescribeGameSessionsInput

SetLimit sets the Limit field's value.

func (*DescribeGameSessionsInput) SetLocation added in v1.37.32 

func (s *DescribeGameSessionsInput) SetLocation(v string) *DescribeGameSessionsInput

SetLocation sets the Location field's value.

func (*DescribeGameSessionsInput) SetNextToken added in v1.5.0 

func (s *DescribeGameSessionsInput) SetNextToken(v string) *DescribeGameSessionsInput

SetNextToken sets the NextToken field's value.

func (*DescribeGameSessionsInput) SetStatusFilter added in v1.5.0 

func (s *DescribeGameSessionsInput) SetStatusFilter(v string) *DescribeGameSessionsInput

SetStatusFilter sets the StatusFilter field's value.

func (DescribeGameSessionsInput) String 

func (s DescribeGameSessionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A collection of properties for each game session that matches the request.
	GameSessions []*GameSession `type:"list"`

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

func (DescribeGameSessionsOutput) GoString 

func (s DescribeGameSessionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGameSessionsOutput) SetGameSessions added in v1.5.0 

func (s *DescribeGameSessionsOutput) SetGameSessions(v []*GameSession) *DescribeGameSessionsOutput

SetGameSessions sets the GameSessions field's value.

func (*DescribeGameSessionsOutput) SetNextToken added in v1.5.0 

func (s *DescribeGameSessionsOutput) SetNextToken(v string) *DescribeGameSessionsOutput

SetNextToken sets the NextToken field's value.

func (DescribeGameSessionsOutput) String 

func (s DescribeGameSessionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeInstancesInput added in v1.4.17 

type DescribeInstancesInput struct {

	// A unique identifier for the fleet to retrieve instance information for. You
	// can use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// A unique identifier for an instance to retrieve. Specify an instance ID or
	// leave blank to retrieve all instances in the fleet.
	InstanceId *string `type:"string"`

	// The 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"`

	// The name of a location to retrieve instance information for, in the form
	// of an Amazon Web Services Region code such as us-west-2.
	Location *string `min:"1" type:"string"`

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

func (DescribeInstancesInput) GoString added in v1.4.17 

func (s DescribeInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstancesInput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (*DescribeInstancesInput) SetInstanceId added in v1.5.0 

func (s *DescribeInstancesInput) SetInstanceId(v string) *DescribeInstancesInput

SetInstanceId sets the InstanceId field's value.

func (*DescribeInstancesInput) SetLimit added in v1.5.0 

func (s *DescribeInstancesInput) SetLimit(v int64) *DescribeInstancesInput

SetLimit sets the Limit field's value.

func (*DescribeInstancesInput) SetLocation added in v1.37.32 

func (s *DescribeInstancesInput) SetLocation(v string) *DescribeInstancesInput

SetLocation sets the Location field's value.

func (*DescribeInstancesInput) SetNextToken added in v1.5.0 

func (s *DescribeInstancesInput) SetNextToken(v string) *DescribeInstancesInput

SetNextToken sets the NextToken field's value.

func (DescribeInstancesInput) String added in v1.4.17 

func (s DescribeInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstancesInput) Validate added in v1.4.17 

func (s *DescribeInstancesInput) Validate() error

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

type DescribeInstancesOutput added in v1.4.17 

type DescribeInstancesOutput struct {

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

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

func (DescribeInstancesOutput) GoString added in v1.4.17 

func (s DescribeInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstancesOutput) SetInstances added in v1.5.0 

func (s *DescribeInstancesOutput) SetInstances(v []*Instance) *DescribeInstancesOutput

SetInstances sets the Instances field's value.

func (*DescribeInstancesOutput) SetNextToken added in v1.5.0 

func (s *DescribeInstancesOutput) SetNextToken(v string) *DescribeInstancesOutput

SetNextToken sets the NextToken field's value.

func (DescribeInstancesOutput) String added in v1.4.17 

func (s DescribeInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMatchmakingConfigurationsInput added in v1.10.27 

type DescribeMatchmakingConfigurationsInput struct {

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

	// A unique identifier for the matchmaking configuration(s) to retrieve. You
	// can use either the configuration name or ARN value. To request all existing
	// configurations, leave this parameter empty.
	Names []*string `type:"list"`

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

	// A unique identifier for the matchmaking rule set. You can use either the
	// rule set name or ARN value. Use this parameter to retrieve all matchmaking
	// configurations that use this rule set.
	RuleSetName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMatchmakingConfigurationsInput) GoString added in v1.10.27 

func (s DescribeMatchmakingConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMatchmakingConfigurationsInput) SetLimit added in v1.10.27 

func (s *DescribeMatchmakingConfigurationsInput) SetLimit(v int64) *DescribeMatchmakingConfigurationsInput

SetLimit sets the Limit field's value.

func (*DescribeMatchmakingConfigurationsInput) SetNames added in v1.10.27 

func (s *DescribeMatchmakingConfigurationsInput) SetNames(v []*string) *DescribeMatchmakingConfigurationsInput

SetNames sets the Names field's value.

func (*DescribeMatchmakingConfigurationsInput) SetNextToken added in v1.10.27 

func (s *DescribeMatchmakingConfigurationsInput) SetNextToken(v string) *DescribeMatchmakingConfigurationsInput

SetNextToken sets the NextToken field's value.

func (*DescribeMatchmakingConfigurationsInput) SetRuleSetName added in v1.10.27 

func (s *DescribeMatchmakingConfigurationsInput) SetRuleSetName(v string) *DescribeMatchmakingConfigurationsInput

SetRuleSetName sets the RuleSetName field's value.

func (DescribeMatchmakingConfigurationsInput) String added in v1.10.27 

func (s DescribeMatchmakingConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMatchmakingConfigurationsInput) Validate added in v1.10.27 

func (s *DescribeMatchmakingConfigurationsInput) Validate() error

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

type DescribeMatchmakingConfigurationsOutput added in v1.10.27 

type DescribeMatchmakingConfigurationsOutput struct {

	// A collection of requested matchmaking configurations.
	Configurations []*MatchmakingConfiguration `type:"list"`

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

func (DescribeMatchmakingConfigurationsOutput) GoString added in v1.10.27 

func (s DescribeMatchmakingConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMatchmakingConfigurationsOutput) SetConfigurations added in v1.10.27 

func (s *DescribeMatchmakingConfigurationsOutput) SetConfigurations(v []*MatchmakingConfiguration) *DescribeMatchmakingConfigurationsOutput

SetConfigurations sets the Configurations field's value.

func (*DescribeMatchmakingConfigurationsOutput) SetNextToken added in v1.10.27 

func (s *DescribeMatchmakingConfigurationsOutput) SetNextToken(v string) *DescribeMatchmakingConfigurationsOutput

SetNextToken sets the NextToken field's value.

func (DescribeMatchmakingConfigurationsOutput) String added in v1.10.27 

func (s DescribeMatchmakingConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMatchmakingInput added in v1.10.27 

type DescribeMatchmakingInput struct {

	// A unique identifier for a matchmaking ticket. You can include up to 10 ID
	// values.
	//
	// TicketIds is a required field
	TicketIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMatchmakingInput) GoString added in v1.10.27 

func (s DescribeMatchmakingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMatchmakingInput) SetTicketIds added in v1.10.27 

func (s *DescribeMatchmakingInput) SetTicketIds(v []*string) *DescribeMatchmakingInput

SetTicketIds sets the TicketIds field's value.

func (DescribeMatchmakingInput) String added in v1.10.27 

func (s DescribeMatchmakingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMatchmakingInput) Validate added in v1.10.27 

func (s *DescribeMatchmakingInput) Validate() error

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

type DescribeMatchmakingOutput added in v1.10.27 

type DescribeMatchmakingOutput struct {

	// A collection of existing matchmaking ticket objects matching the request.
	TicketList []*MatchmakingTicket `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeMatchmakingOutput) GoString added in v1.10.27 

func (s DescribeMatchmakingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMatchmakingOutput) SetTicketList added in v1.10.27 

func (s *DescribeMatchmakingOutput) SetTicketList(v []*MatchmakingTicket) *DescribeMatchmakingOutput

SetTicketList sets the TicketList field's value.

func (DescribeMatchmakingOutput) String added in v1.10.27 

func (s DescribeMatchmakingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMatchmakingRuleSetsInput added in v1.10.27 

type DescribeMatchmakingRuleSetsInput struct {

	// The 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"`

	// A list of one or more matchmaking rule set names to retrieve details for.
	// (Note: The rule set name is different from the optional "name" field in the
	// rule set body.) You can use either the rule set name or ARN value.
	Names []*string `min:"1" type:"list"`

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

func (DescribeMatchmakingRuleSetsInput) GoString added in v1.10.27 

func (s DescribeMatchmakingRuleSetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMatchmakingRuleSetsInput) SetLimit added in v1.10.27 

func (s *DescribeMatchmakingRuleSetsInput) SetLimit(v int64) *DescribeMatchmakingRuleSetsInput

SetLimit sets the Limit field's value.

func (*DescribeMatchmakingRuleSetsInput) SetNames added in v1.10.27 

func (s *DescribeMatchmakingRuleSetsInput) SetNames(v []*string) *DescribeMatchmakingRuleSetsInput

SetNames sets the Names field's value.

func (*DescribeMatchmakingRuleSetsInput) SetNextToken added in v1.10.27 

func (s *DescribeMatchmakingRuleSetsInput) SetNextToken(v string) *DescribeMatchmakingRuleSetsInput

SetNextToken sets the NextToken field's value.

func (DescribeMatchmakingRuleSetsInput) String added in v1.10.27 

func (s DescribeMatchmakingRuleSetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMatchmakingRuleSetsInput) Validate added in v1.10.27 

func (s *DescribeMatchmakingRuleSetsInput) Validate() error

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

type DescribeMatchmakingRuleSetsOutput added in v1.10.27 

type DescribeMatchmakingRuleSetsOutput struct {

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

	// A collection of requested matchmaking rule set objects.
	//
	// RuleSets is a required field
	RuleSets []*MatchmakingRuleSet `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMatchmakingRuleSetsOutput) GoString added in v1.10.27 

func (s DescribeMatchmakingRuleSetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMatchmakingRuleSetsOutput) SetNextToken added in v1.10.27 

func (s *DescribeMatchmakingRuleSetsOutput) SetNextToken(v string) *DescribeMatchmakingRuleSetsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeMatchmakingRuleSetsOutput) SetRuleSets added in v1.10.27 

func (s *DescribeMatchmakingRuleSetsOutput) SetRuleSets(v []*MatchmakingRuleSet) *DescribeMatchmakingRuleSetsOutput

SetRuleSets sets the RuleSets field's value.

func (DescribeMatchmakingRuleSetsOutput) String added in v1.10.27 

func (s DescribeMatchmakingRuleSetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePlayerSessionsInput 

type DescribePlayerSessionsInput struct {

	// A unique identifier for the game session to retrieve player sessions for.
	GameSessionId *string `min:"1" type:"string"`

	// The 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"`

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

	// A unique identifier for a player to retrieve player sessions for.
	//
	// PlayerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribePlayerSessionsInput's
	// String and GoString methods.
	PlayerId *string `min:"1" type:"string" sensitive:"true"`

	// A unique identifier for a player session to retrieve.
	PlayerSessionId *string `type:"string"`

	// Player session status to filter results on. Note that when a PlayerSessionId
	// or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter
	// has no effect on the response.
	//
	// 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 timeout limit (60 seconds).
	PlayerSessionStatusFilter *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribePlayerSessionsInput) GoString 

func (s DescribePlayerSessionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePlayerSessionsInput) SetGameSessionId added in v1.5.0 

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

SetGameSessionId sets the GameSessionId field's value.

func (*DescribePlayerSessionsInput) SetLimit added in v1.5.0 

func (s *DescribePlayerSessionsInput) SetLimit(v int64) *DescribePlayerSessionsInput

SetLimit sets the Limit field's value.

func (*DescribePlayerSessionsInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribePlayerSessionsInput) SetPlayerId added in v1.5.0 

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

SetPlayerId sets the PlayerId field's value.

func (*DescribePlayerSessionsInput) SetPlayerSessionId added in v1.5.0 

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

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 

func (s DescribePlayerSessionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

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

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

func (DescribePlayerSessionsOutput) GoString 

func (s DescribePlayerSessionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePlayerSessionsOutput) SetNextToken added in v1.5.0 

func (s *DescribePlayerSessionsOutput) SetNextToken(v string) *DescribePlayerSessionsOutput

SetNextToken sets the NextToken field's value.

func (*DescribePlayerSessionsOutput) SetPlayerSessions added in v1.5.0 

func (s *DescribePlayerSessionsOutput) SetPlayerSessions(v []*PlayerSession) *DescribePlayerSessionsOutput

SetPlayerSessions sets the PlayerSessions field's value.

func (DescribePlayerSessionsOutput) String 

func (s DescribePlayerSessionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeRuntimeConfigurationInput added in v1.2.1 

type DescribeRuntimeConfigurationInput struct {

	// A unique identifier for the fleet to get the runtime configuration for. You
	// can use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRuntimeConfigurationInput) GoString added in v1.2.1 

func (s DescribeRuntimeConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuntimeConfigurationInput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (DescribeRuntimeConfigurationInput) String added in v1.2.1 

func (s DescribeRuntimeConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuntimeConfigurationInput) Validate added in v1.2.1 

func (s *DescribeRuntimeConfigurationInput) Validate() error

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

type DescribeRuntimeConfigurationOutput added in v1.2.1 

type DescribeRuntimeConfigurationOutput struct {

	// Instructions that describe how server processes are launched and maintained
	// on computes in the fleet.
	RuntimeConfiguration *RuntimeConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeRuntimeConfigurationOutput) GoString added in v1.2.1 

func (s DescribeRuntimeConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuntimeConfigurationOutput) SetRuntimeConfiguration added in v1.5.0 

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

SetRuntimeConfiguration sets the RuntimeConfiguration field's value.

func (DescribeRuntimeConfigurationOutput) String added in v1.2.1 

func (s DescribeRuntimeConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScalingPoliciesInput added in v1.1.10 

type DescribeScalingPoliciesInput struct {

	// A unique identifier for the fleet for which to retrieve scaling policies.
	// You can use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The 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"`

	// The fleet location. If you don't specify this value, the response contains
	// the scaling policies of every location in the fleet.
	Location *string `min:"1" type:"string"`

	// A token that indicates the start of the next sequential page of results.
	// Use the token that is returned with a previous call to this operation. To
	// start at the beginning of the result set, do not specify a value.
	NextToken *string `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
}

func (DescribeScalingPoliciesInput) GoString added in v1.1.10 

func (s DescribeScalingPoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalingPoliciesInput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (*DescribeScalingPoliciesInput) SetLimit added in v1.5.0 

func (s *DescribeScalingPoliciesInput) SetLimit(v int64) *DescribeScalingPoliciesInput

SetLimit sets the Limit field's value.

func (*DescribeScalingPoliciesInput) SetLocation added in v1.37.32 

func (s *DescribeScalingPoliciesInput) SetLocation(v string) *DescribeScalingPoliciesInput

SetLocation sets the Location field's value.

func (*DescribeScalingPoliciesInput) SetNextToken added in v1.5.0 

func (s *DescribeScalingPoliciesInput) SetNextToken(v string) *DescribeScalingPoliciesInput

SetNextToken sets the NextToken field's value.

func (*DescribeScalingPoliciesInput) SetStatusFilter added in v1.5.0 

func (s *DescribeScalingPoliciesInput) SetStatusFilter(v string) *DescribeScalingPoliciesInput

SetStatusFilter sets the StatusFilter field's value.

func (DescribeScalingPoliciesInput) String added in v1.1.10 

func (s DescribeScalingPoliciesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

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

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

func (DescribeScalingPoliciesOutput) GoString added in v1.1.10 

func (s DescribeScalingPoliciesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalingPoliciesOutput) SetNextToken added in v1.5.0 

func (s *DescribeScalingPoliciesOutput) SetNextToken(v string) *DescribeScalingPoliciesOutput

SetNextToken sets the NextToken field's value.

func (*DescribeScalingPoliciesOutput) SetScalingPolicies added in v1.5.0 

func (s *DescribeScalingPoliciesOutput) SetScalingPolicies(v []*ScalingPolicy) *DescribeScalingPoliciesOutput

SetScalingPolicies sets the ScalingPolicies field's value.

func (DescribeScalingPoliciesOutput) String added in v1.1.10 

func (s DescribeScalingPoliciesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScriptInput added in v1.19.18 

type DescribeScriptInput struct {

	// A unique identifier for the Realtime script to retrieve properties for. You
	// can use either the script ID or ARN value.
	//
	// ScriptId is a required field
	ScriptId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeScriptInput) GoString added in v1.19.18 

func (s DescribeScriptInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScriptInput) SetScriptId added in v1.19.18 

func (s *DescribeScriptInput) SetScriptId(v string) *DescribeScriptInput

SetScriptId sets the ScriptId field's value.

func (DescribeScriptInput) String added in v1.19.18 

func (s DescribeScriptInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScriptInput) Validate added in v1.19.18 

func (s *DescribeScriptInput) Validate() error

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

type DescribeScriptOutput added in v1.19.18 

type DescribeScriptOutput struct {

	// A set of properties describing the requested script.
	Script *Script `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeScriptOutput) GoString added in v1.19.18 

func (s DescribeScriptOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScriptOutput) SetScript added in v1.19.18 

func (s *DescribeScriptOutput) SetScript(v *Script) *DescribeScriptOutput

SetScript sets the Script field's value.

func (DescribeScriptOutput) String added in v1.19.18 

func (s DescribeScriptOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeVpcPeeringAuthorizationsInput added in v1.10.37 

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

func (DescribeVpcPeeringAuthorizationsInput) GoString added in v1.10.37 

func (s DescribeVpcPeeringAuthorizationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeVpcPeeringAuthorizationsInput) String added in v1.10.37 

func (s DescribeVpcPeeringAuthorizationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeVpcPeeringAuthorizationsOutput added in v1.10.37 

type DescribeVpcPeeringAuthorizationsOutput struct {

	// A collection of objects that describe all valid VPC peering operations for
	// the current Amazon Web Services account.
	VpcPeeringAuthorizations []*VpcPeeringAuthorization `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeVpcPeeringAuthorizationsOutput) GoString added in v1.10.37 

func (s DescribeVpcPeeringAuthorizationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeVpcPeeringAuthorizationsOutput) SetVpcPeeringAuthorizations added in v1.10.37 

func (s *DescribeVpcPeeringAuthorizationsOutput) SetVpcPeeringAuthorizations(v []*VpcPeeringAuthorization) *DescribeVpcPeeringAuthorizationsOutput

SetVpcPeeringAuthorizations sets the VpcPeeringAuthorizations field's value.

func (DescribeVpcPeeringAuthorizationsOutput) String added in v1.10.37 

func (s DescribeVpcPeeringAuthorizationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeVpcPeeringConnectionsInput added in v1.10.37 

type DescribeVpcPeeringConnectionsInput struct {

	// A unique identifier for the fleet. You can use either the fleet ID or ARN
	// value.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeVpcPeeringConnectionsInput) GoString added in v1.10.37 

func (s DescribeVpcPeeringConnectionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeVpcPeeringConnectionsInput) SetFleetId added in v1.10.37 

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

SetFleetId sets the FleetId field's value.

func (DescribeVpcPeeringConnectionsInput) String added in v1.10.37 

func (s DescribeVpcPeeringConnectionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeVpcPeeringConnectionsOutput added in v1.10.37 

type DescribeVpcPeeringConnectionsOutput struct {

	// A collection of VPC peering connection records that match the request.
	VpcPeeringConnections []*VpcPeeringConnection `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeVpcPeeringConnectionsOutput) GoString added in v1.10.37 

func (s DescribeVpcPeeringConnectionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeVpcPeeringConnectionsOutput) SetVpcPeeringConnections added in v1.10.37 

func (s *DescribeVpcPeeringConnectionsOutput) SetVpcPeeringConnections(v []*VpcPeeringConnection) *DescribeVpcPeeringConnectionsOutput

SetVpcPeeringConnections sets the VpcPeeringConnections field's value.

func (DescribeVpcPeeringConnectionsOutput) String added in v1.10.37 

func (s DescribeVpcPeeringConnectionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DesiredPlayerSession added in v1.6.27 

type DesiredPlayerSession struct {

	// Developer-defined information related to a player. Amazon GameLift does not
	// use this data, so it can be formatted as needed for use in the game.
	PlayerData *string `min:"1" type:"string"`

	// A unique identifier for a player to associate with the player session.
	//
	// PlayerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DesiredPlayerSession's
	// String and GoString methods.
	PlayerId *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Player information for use when creating player sessions using a game session placement request.

func (DesiredPlayerSession) GoString added in v1.6.27 

func (s DesiredPlayerSession) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DesiredPlayerSession) SetPlayerData added in v1.6.27 

func (s *DesiredPlayerSession) SetPlayerData(v string) *DesiredPlayerSession

SetPlayerData sets the PlayerData field's value.

func (*DesiredPlayerSession) SetPlayerId added in v1.6.27 

func (s *DesiredPlayerSession) SetPlayerId(v string) *DesiredPlayerSession

SetPlayerId sets the PlayerId field's value.

func (DesiredPlayerSession) String added in v1.6.27 

func (s DesiredPlayerSession) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DesiredPlayerSession) Validate added in v1.6.27 

func (s *DesiredPlayerSession) Validate() error

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

type EC2InstanceCounts 

type EC2InstanceCounts struct {

	// Actual number of instances that are ready to host game sessions.
	ACTIVE *int64 `type:"integer"`

	// Requested number of active instances. Amazon GameLift takes action as needed
	// to maintain the desired number of instances. Capacity is scaled up or down
	// by changing the desired instances. A change in the desired instances value
	// can take up to 1 minute to be reflected when viewing a fleet's capacity settings.
	DESIRED *int64 `type:"integer"`

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

	// The maximum instance count value allowed.
	MAXIMUM *int64 `type:"integer"`

	// The minimum instance count value allowed.
	MINIMUM *int64 `type:"integer"`

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

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

Resource capacity settings. Fleet capacity is measured in Amazon EC2 instances. Pending and terminating counts are non-zero when the fleet capacity is adjusting to a scaling event or if access to resources is temporarily affected.

func (EC2InstanceCounts) GoString 

func (s EC2InstanceCounts) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EC2InstanceLimit 

type EC2InstanceLimit struct {

	// The number of instances for the specified type and location that are currently
	// being used by the Amazon Web Services account.
	CurrentInstances *int64 `type:"integer"`

	// The name of an Amazon EC2 instance type. See Amazon Elastic Compute Cloud
	// Instance Types (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions.
	EC2InstanceType *string `type:"string" enum:"EC2InstanceType"`

	// The number of instances that is allowed for the specified instance type and
	// location.
	InstanceLimit *int64 `type:"integer"`

	// An Amazon Web Services Region code, such as us-west-2.
	Location *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Amazon GameLift service limits for an Amazon EC2 instance type and current utilization. Amazon GameLift allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region or location, for use with Amazon GameLift. You can request an limit increase for your account by using the Service limits page in the Amazon GameLift console.

func (EC2InstanceLimit) GoString 

func (s EC2InstanceLimit) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetLocation added in v1.37.32 

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

SetLocation sets the Location field's value.

func (EC2InstanceLimit) String 

func (s EC2InstanceLimit) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Event 

type Event struct {

	// The number of times that this event occurred.
	Count *int64 `min:"1" type:"long"`

	// The type of event being logged.
	//
	// Fleet state transition events:
	//
	//    * FLEET_CREATED -- A fleet resource was successfully created with a status
	//    of NEW. Event messaging includes the fleet ID.
	//
	//    * FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING.
	//    The compressed build has started downloading to a fleet instance for installation.
	//
	//    * FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING.
	//    Amazon GameLift has successfully downloaded the build and is now validating
	//    the build files.
	//
	//    * FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING.
	//    Amazon GameLift has successfully verified the build files and is now running
	//    the installation scripts.
	//
	//    * FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING.
	//    Amazon GameLift is trying to launch an instance and test the connectivity
	//    between the build and the Amazon GameLift Service via the Server SDK.
	//
	//    * FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to
	//    ACTIVE. The fleet is now ready to host game sessions.
	//
	//    * FLEET_STATE_ERROR -- The Fleet's status changed to ERROR. Describe the
	//    fleet event message for more details.
	//
	// Fleet creation events (ordered by fleet creation activity):
	//
	//    * FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the
	//    fleet instance.
	//
	//    * FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully
	//    downloaded to an instance, and the build files are now being extracted
	//    from the uploaded build and saved to an instance. Failure at this stage
	//    prevents a fleet from moving to ACTIVE status. Logs for this stage display
	//    a list of the files that are extracted and saved on the instance. Access
	//    the logs by using the URL in PreSignedLogUrl.
	//
	//    * FLEET_CREATION_RUNNING_INSTALLER -- The game server build files were
	//    successfully extracted, and the GameLift is now running the build's install
	//    script (if one is included). Failure in this stage prevents a fleet from
	//    moving to ACTIVE status. Logs for this stage list the installation steps
	//    and whether or not the install completed successfully. Access the logs
	//    by using the URL in PreSignedLogUrl.
	//
	//    * FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful,
	//    and the GameLift is now verifying that the game server launch paths, which
	//    are specified in the fleet's runtime configuration, exist. If any listed
	//    launch path exists, Amazon GameLift tries to launch a game server process
	//    and waits for the process to report ready. Failures in this stage prevent
	//    a fleet from moving to ACTIVE status. Logs for this stage list the launch
	//    paths in the runtime configuration and indicate whether each is found.
	//    Access the logs by using the URL in PreSignedLogUrl.
	//
	//    * FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime
	//    configuration failed because the executable specified in a launch path
	//    does not exist on the instance.
	//
	//    * FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime
	//    configuration failed because the executable specified in a launch path
	//    failed to run on the fleet instance.
	//
	//    * FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of
	//    creation timed out. Try fleet creation again.
	//
	//    * FLEET_ACTIVATION_FAILED -- The fleet failed to successfully complete
	//    one of the steps in the fleet activation process. This event code indicates
	//    that the game build was successfully downloaded to a fleet instance, built,
	//    and validated, but was not able to start a server process. For more information,
	//    see Debug Fleet Creation Issues (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation).
	//
	//    * FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able
	//    to obtain any instances based on the input fleet attributes. Try again
	//    at a different time or choose a different combination of fleet attributes
	//    such as fleet type, instance type, etc.
	//
	//    * FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet
	//    creation. Describe the fleet event message for more details.
	//
	// VPC peering events:
	//
	//    * FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established
	//    between the VPC for an Amazon GameLift fleet and a VPC in your Amazon
	//    Web Services account.
	//
	//    * FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed.
	//    Event details and status information provide additional detail. A common
	//    reason for peering failure is that the two VPCs have overlapping CIDR
	//    blocks of IPv4 addresses. To resolve this, change the CIDR block for the
	//    VPC in your Amazon Web Services account. For more information on VPC peering
	//    failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html
	//    (https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html)
	//
	//    * FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully
	//    deleted.
	//
	// Spot instance events:
	//
	//    * INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with
	//    a two-minute notification.
	//
	//    * INSTANCE_RECYCLED -- A spot instance was determined to have a high risk
	//    of interruption and is scheduled to be recycled once it has no active
	//    game sessions.
	//
	// Server process events:
	//
	//    * SERVER_PROCESS_INVALID_PATH -- The game server executable or script
	//    could not be found based on the Fleet runtime configuration. Check that
	//    the launch path is correct based on the operating system of the Fleet.
	//
	//    * SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did
	//    not call InitSDK() within the time expected (5 minutes). Check your game
	//    session log to see why InitSDK() was not called in time.
	//
	//    * SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call
	//    ProcessReady() within the time expected (5 minutes) after calling InitSDK().
	//    Check your game session log to see why ProcessReady() was not called in
	//    time.
	//
	//    * SERVER_PROCESS_CRASHED -- The server process exited without calling
	//    ProcessEnding(). Check your game session log to see why ProcessEnding()
	//    was not called.
	//
	//    * SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report
	//    a valid health check for too long and was therefore terminated by GameLift.
	//    Check your game session log to see if the thread became stuck processing
	//    a synchronous task for too long.
	//
	//    * SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly
	//    within the time expected after OnProcessTerminate() was sent. Check your
	//    game session log to see why termination took longer than expected.
	//
	//    * SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit
	//    cleanly within the time expected (30 seconds) after calling ProcessEnding().
	//    Check your game session log to see why termination took longer than expected.
	//
	// Game session events:
	//
	//    * GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within
	//    the expected time. Check your game session log to see why ActivateGameSession()
	//    took longer to complete than expected.
	//
	// Other fleet events:
	//
	//    * FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings
	//    (desired instances, minimum/maximum scaling limits). Event messaging includes
	//    the new capacity settings.
	//
	//    * FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made
	//    to the fleet's game session protection policy setting. Event messaging
	//    includes both the old and new policy setting.
	//
	//    * FLEET_DELETED -- A request to delete a fleet was initiated.
	//
	//    * GENERIC_EVENT -- An unspecified event has occurred.
	EventCode *string `type:"string" enum:"EventCode"`

	// A 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 (for example "1469498468.057").
	EventTime *time.Time `type:"timestamp"`

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

	// Location of stored logs with additional detail that is related to the event.
	// This is useful for debugging issues. The URL is valid for 15 minutes. You
	// can also access fleet creation logs through the Amazon GameLift console.
	PreSignedLogUrl *string `min:"1" type:"string"`

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

Log entry describing an event that involves 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Event) SetCount added in v1.51.28 

func (s *Event) SetCount(v int64) *Event

SetCount sets the Count field's value.

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) SetPreSignedLogUrl added in v1.10.5 

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

SetPreSignedLogUrl sets the PreSignedLogUrl 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FilterConfiguration added in v1.37.32 

type FilterConfiguration struct {

	// A list of locations to allow game session placement in, in the form of Amazon
	// Web Services Region codes such as us-west-2.
	AllowedLocations []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

A list of fleet locations where a game session queue can place new game sessions. You can use a filter to temporarily turn off placements for specific locations. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.

func (FilterConfiguration) GoString added in v1.37.32 

func (s FilterConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FilterConfiguration) SetAllowedLocations added in v1.37.32 

func (s *FilterConfiguration) SetAllowedLocations(v []*string) *FilterConfiguration

SetAllowedLocations sets the AllowedLocations field's value.

func (FilterConfiguration) String added in v1.37.32 

func (s FilterConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FilterConfiguration) Validate added in v1.37.32 

func (s *FilterConfiguration) Validate() error

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

type FleetAttributes 

type FleetAttributes struct {

	// This property is used with the Amazon GameLift containers feature, which
	// is currently in public preview. A set of attributes that describe the container
	// groups that are deployed on the fleet. These attributes are included for
	// fleets with compute type CONTAINER only. This attribute is used with fleets
	// where ComputeType is "Container".
	AnywhereConfiguration *AnywhereConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// associated with the Amazon GameLift build resource that is deployed on instances
	// in this fleet. In a GameLift build ARN, the resource ID matches the BuildId
	// value. This attribute is used with fleets where ComputeType is "EC2".
	BuildArn *string `type:"string"`

	// A unique identifier for the build resource that is deployed on instances
	// in this fleet. This attribute is used with fleets where ComputeType is "EC2".
	BuildId *string `type:"string"`

	// Determines whether a TLS/SSL certificate is generated for a fleet. This feature
	// must be enabled when creating the fleet. All instances in a fleet share the
	// same certificate.
	CertificateConfiguration *CertificateConfiguration `type:"structure"`

	// The type of compute resource used to host your game servers. You can use
	// your own compute resources with Amazon GameLift Anywhere or use Amazon EC2
	// instances with managed Amazon GameLift.
	ComputeType *string `type:"string" enum:"ComputeType"`

	// A set of properties that describe the container groups that are deployed
	// to the fleet. These attributes are included for fleets with compute type
	// CONTAINER.
	ContainerGroupsAttributes *ContainerGroupsAttributes `type:"structure"`

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

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

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	// In a GameLift fleet ARN, the resource ID matches the FleetId value.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet.
	FleetId *string `type:"string"`

	// Indicates whether the fleet uses On-Demand or Spot instances. For more information,
	// see On-Demand versus Spot Instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot).
	// This fleet property can't be changed after the fleet is created.
	FleetType *string `type:"string" enum:"FleetType"`

	// A unique identifier for an IAM role with access permissions to other Amazon
	// Web Services services. Any application that runs on an instance in the fleet--including
	// install scripts, server processes, and other processes--can use these permissions
	// to interact with Amazon Web Services resources that you own or have access
	// to. For more information about using the role with your game server builds,
	// see Communicate with other Amazon Web Services resources from your fleets
	// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html).
	// This attribute is used with fleets where ComputeType is "EC2" or "Container".
	InstanceRoleArn *string `min:"1" type:"string"`

	// Indicates that fleet instances maintain a shared credentials file for the
	// IAM role defined in InstanceRoleArn. Shared credentials allow applications
	// that are deployed with the game server executable to communicate with other
	// Amazon Web Services resources. This property is used only when the game server
	// is integrated with the server SDK version 5.x. For more information about
	// using shared credentials, see Communicate with other Amazon Web Services
	// resources from your fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html).
	// This attribute is used with fleets where ComputeType is "EC2" or "Container".
	InstanceRoleCredentialsProvider *string `type:"string" enum:"InstanceRoleCredentialsProvider"`

	// The Amazon EC2 instance type that the fleet uses. Instance type determines
	// the computing resources of each instance in the fleet, including CPU, memory,
	// storage, and networking capacity. See Amazon Elastic Compute Cloud Instance
	// Types (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions.
	// This attribute is used with fleets where ComputeType is "EC2" or "Container".
	InstanceType *string `type:"string" enum:"EC2InstanceType"`

	// This parameter is no longer used. Game session log paths are now defined
	// using the Amazon GameLift server API ProcessReady() logParameters. See more
	// information in the Server API Reference (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process).
	LogPaths []*string `type:"list"`

	// Name of a metric group that metrics for this fleet are added to. In Amazon
	// CloudWatch, you can view aggregated metrics for fleets that are in a metric
	// group. A fleet can be included in only one metric group at a time. This attribute
	// is used with fleets where ComputeType is "EC2" or "Container".
	MetricGroups []*string `type:"list"`

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

	// The type of game session protection to set on all new instances that are
	// started in the fleet. This attribute is used with fleets where ComputeType
	// is "EC2" or "Container".
	//
	//    * 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"`

	// The operating system of the fleet's computing resources. A fleet's operating
	// system is determined by the OS of the build or script that is deployed on
	// this fleet. This attribute is used with fleets where ComputeType is "EC2"
	// or "Container".
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// A policy that puts limits on the number of game sessions that a player can
	// create within a specified span of time. With this policy, you can control
	// players' ability to consume available resources.
	//
	// The policy is evaluated when a player tries to create a new game session.
	// On receiving a CreateGameSession request, Amazon GameLift checks that the
	// player (identified by CreatorId) has created fewer than game session limit
	// in the specified time period.
	ResourceCreationLimitPolicy *ResourceCreationLimitPolicy `type:"structure"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// associated with the GameLift script resource that is deployed on instances
	// in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId
	// value.
	ScriptArn *string `type:"string"`

	// A unique identifier for the Realtime script resource that is deployed on
	// instances in this fleet. This attribute is used with fleets where ComputeType
	// is "EC2".
	ScriptId *string `type:"string"`

	// This parameter is no longer used. Server launch parameters are now defined
	// using the fleet's runtime configuration . Requests that use this parameter
	// continue to be valid.
	ServerLaunchParameters *string `min:"1" type:"string"`

	// This parameter is no longer used. Server launch paths are now defined using
	// the fleet's RuntimeConfiguration (https://docs.aws.amazon.com/gamelift/latest/apireference/RuntimeConfiguration.html)
	// . Requests that use this parameter continue to be valid.
	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 -- Amazon GameLift is setting
	//    up the new fleet, creating new instances with the game build or Realtime
	//    script 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"`

	// A list of fleet activity that has been suspended using StopFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html).
	// This includes fleet auto-scaling. This attribute is used with fleets where
	// ComputeType is "EC2" or "Container".
	StoppedActions []*string `min:"1" type:"list" enum:"FleetAction"`

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

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Describes an Amazon GameLift fleet of game hosting resources. Attributes differ based on the fleet's compute type, as follows:

  • EC2 fleet attributes identify a Build resource (for fleets with customer game server builds) or a Script resource (for Realtime Servers fleets).

  • Container fleets have ContainerGroupsAttributes, which identify the fleet's ContainerGroupDefinition resources.

  • Amazon GameLift Anywhere fleets have an abbreviated set of attributes, because most fleet configurations are set directly on the fleet's computes. Attributes include fleet identifiers and descriptive properties, creation/termination time, and fleet status.

Returned by: DescribeFleetAttributes

func (FleetAttributes) GoString 

func (s FleetAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FleetAttributes) SetAnywhereConfiguration added in v1.44.151 

func (s *FleetAttributes) SetAnywhereConfiguration(v *AnywhereConfiguration) *FleetAttributes

SetAnywhereConfiguration sets the AnywhereConfiguration field's value.

func (*FleetAttributes) SetBuildArn added in v1.26.6 

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

SetBuildArn sets the BuildArn field's value.

func (*FleetAttributes) SetBuildId added in v1.5.0 

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

SetBuildId sets the BuildId field's value.

func (*FleetAttributes) SetCertificateConfiguration added in v1.23.14 

func (s *FleetAttributes) SetCertificateConfiguration(v *CertificateConfiguration) *FleetAttributes

SetCertificateConfiguration sets the CertificateConfiguration field's value.

func (*FleetAttributes) SetComputeType added in v1.44.151 

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

SetComputeType sets the ComputeType field's value.

func (*FleetAttributes) SetContainerGroupsAttributes added in v1.51.28 

func (s *FleetAttributes) SetContainerGroupsAttributes(v *ContainerGroupsAttributes) *FleetAttributes

SetContainerGroupsAttributes sets the ContainerGroupsAttributes 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) SetFleetArn added in v1.6.27 

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

SetFleetArn sets the FleetArn 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) SetFleetType added in v1.12.78 

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

SetFleetType sets the FleetType field's value.

func (*FleetAttributes) SetInstanceRoleArn added in v1.17.13 

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

SetInstanceRoleArn sets the InstanceRoleArn field's value.

func (*FleetAttributes) SetInstanceRoleCredentialsProvider added in v1.47.2 

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

SetInstanceRoleCredentialsProvider sets the InstanceRoleCredentialsProvider field's value.

func (*FleetAttributes) SetInstanceType added in v1.12.78 

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

SetInstanceType sets the InstanceType 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) SetMetricGroups added in v1.8.24 

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

SetMetricGroups sets the MetricGroups 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) SetScriptArn added in v1.26.6 

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

SetScriptArn sets the ScriptArn field's value.

func (*FleetAttributes) SetScriptId added in v1.19.18 

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

SetScriptId sets the ScriptId 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) SetStoppedActions added in v1.13.46 

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

SetStoppedActions sets the StoppedActions 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FleetCapacity 

type FleetCapacity struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet associated with the location.
	FleetId *string `type:"string"`

	// The current number of instances in the fleet, listed by instance status.
	// Counts for pending and terminating instances might be non-zero if the fleet
	// is adjusting to a scaling event or if access to resources is temporarily
	// affected.
	InstanceCounts *EC2InstanceCounts `type:"structure"`

	// The Amazon EC2 instance type that is used for instances in a fleet. Instance
	// type determines the computing resources in use, including CPU, memory, storage,
	// and networking capacity. See Amazon Elastic Compute Cloud Instance Types
	// (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions.
	InstanceType *string `type:"string" enum:"EC2InstanceType"`

	// The fleet location for the instance count information, expressed as an Amazon
	// Web Services Region code, such as us-west-2.
	Location *string `min:"1" type:"string"`

	// This property is used with the Amazon GameLift containers feature, which
	// is currently in public preview. The number and status of replica container
	// groups in a container fleet.
	ReplicaContainerGroupCounts *ReplicaContainerGroupCounts `type:"structure"`
	// contains filtered or unexported fields
}

Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

Returned by: DescribeFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html), DescribeFleetLocationCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html), UpdateFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html)

func (FleetCapacity) GoString 

func (s FleetCapacity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FleetCapacity) SetFleetArn added in v1.37.32 

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

SetFleetArn sets the FleetArn field's value.

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) SetLocation added in v1.37.32 

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

SetLocation sets the Location field's value.

func (*FleetCapacity) SetReplicaContainerGroupCounts added in v1.51.28 

func (s *FleetCapacity) SetReplicaContainerGroupCounts(v *ReplicaContainerGroupCounts) *FleetCapacity

SetReplicaContainerGroupCounts sets the ReplicaContainerGroupCounts field's value.

func (FleetCapacity) String 

func (s FleetCapacity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FleetCapacityExceededException added in v1.28.0 

type FleetCapacityExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*FleetCapacityExceededException) Code added in v1.28.0 

func (s *FleetCapacityExceededException) Code() string

Code returns the exception type name.

func (*FleetCapacityExceededException) Error added in v1.28.0 

func (s *FleetCapacityExceededException) Error() string

func (FleetCapacityExceededException) GoString added in v1.28.0 

func (s FleetCapacityExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FleetCapacityExceededException) Message added in v1.28.0 

func (s *FleetCapacityExceededException) Message() string

Message returns the exception's message.

func (*FleetCapacityExceededException) OrigErr added in v1.28.0 

func (s *FleetCapacityExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*FleetCapacityExceededException) RequestID added in v1.28.0 

func (s *FleetCapacityExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*FleetCapacityExceededException) StatusCode added in v1.28.0 

func (s *FleetCapacityExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (FleetCapacityExceededException) String added in v1.28.0 

func (s FleetCapacityExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FleetUtilization 

type FleetUtilization struct {

	// The number of active game sessions that are currently being hosted across
	// all instances in the fleet location.
	ActiveGameSessionCount *int64 `type:"integer"`

	// The number of server processes in ACTIVE status that are currently running
	// across all instances in the fleet location.
	ActiveServerProcessCount *int64 `type:"integer"`

	// The number of active player sessions that are currently being hosted across
	// all instances in the fleet location.
	CurrentPlayerSessionCount *int64 `type:"integer"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet associated with the location.
	FleetId *string `type:"string"`

	// The fleet location for the fleet utilization information, expressed as an
	// Amazon Web Services Region code, such as us-west-2.
	Location *string `min:"1" type:"string"`

	// The maximum number of players allowed across all game sessions that are currently
	// being hosted across all instances in the fleet location.
	MaximumPlayerSessionCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Current resource utilization statistics in a specified fleet or location. The location value might refer to a fleet's remote location or its home region.

func (FleetUtilization) GoString 

func (s FleetUtilization) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetFleetArn added in v1.37.32 

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

SetFleetArn sets the FleetArn 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) SetLocation added in v1.37.32 

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

SetLocation sets the Location 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GameLift 

type GameLift struct {
	*client.Client
}

GameLift provides the API operation methods for making requests to Amazon GameLift. See this package's package overview docs for details on the service.

GameLift methods are safe to use concurrently. It is not safe to modify mutate any of the struct'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: 

mySession := session.Must(session.NewSession())

// 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) AcceptMatch added in v1.10.27 

func (c *GameLift) AcceptMatch(input *AcceptMatchInput) (*AcceptMatchOutput, error)

AcceptMatch API operation for Amazon GameLift.

Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in each ticket. Calls to this action are only valid for tickets that are in this status; calls for tickets not in this status result in an error.

To register acceptance, specify the ticket ID, one or more players, and an acceptance response. When all players have accepted, Amazon GameLift advances the matchmaking tickets to status PLACING, and attempts to create a new game session for the match.

If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. Each matchmaking ticket in the failed match is handled as follows:

  • If the ticket has one or more players who rejected the match or failed to respond, the ticket status is set CANCELLED and processing is terminated.

  • If all players in the ticket accepted the match, the ticket status is returned to SEARCHING to find a new match.

Learn more 

Add FlexMatch to a game client (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html)

FlexMatch events (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html)
(reference)

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 AcceptMatch for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/AcceptMatch

func (*GameLift) AcceptMatchRequest added in v1.10.27 

func (c *GameLift) AcceptMatchRequest(input *AcceptMatchInput) (req *request.Request, output *AcceptMatchOutput)

AcceptMatchRequest generates a "aws/request.Request" representing the client's request for the AcceptMatch operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AcceptMatch for more information on using the AcceptMatch API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/AcceptMatch

func (*GameLift) AcceptMatchWithContext added in v1.10.27 

func (c *GameLift) AcceptMatchWithContext(ctx aws.Context, input *AcceptMatchInput, opts ...request.Option) (*AcceptMatchOutput, error)

AcceptMatchWithContext is the same as AcceptMatch with the addition of the ability to pass a context and additional request options.

See AcceptMatch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ClaimGameServer added in v1.30.3 

func (c *GameLift) ClaimGameServer(input *ClaimGameServerInput) (*ClaimGameServerOutput, error)

ClaimGameServer API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, Amazon GameLift FleetIQ locates an available game server, places it in CLAIMED status for 60 seconds, and returns connection information that players can use to connect to the game server.

To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses Amazon GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information. Add filter options to further restrict how a game server is chosen, such as only allowing game servers on ACTIVE instances to be claimed.

When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. This time period gives the game server time to update its status to UTILIZED after players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable.

If you try to claim a specific game server, this request will fail in the following cases:

  • If the game server utilization status is UTILIZED.

  • If the game server claim status is CLAIMED.

  • If the game server is running on an instance in DRAINING status and the provided filter option does not allow placing on DRAINING instances.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 ClaimGameServer for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • OutOfCapacityException The specified game server group has no available game servers to fulfill a ClaimGameServer request. Clients can retry such requests immediately or after a waiting period.

  • UnauthorizedException The client failed authentication. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ClaimGameServer

func (*GameLift) ClaimGameServerRequest added in v1.30.3 

func (c *GameLift) ClaimGameServerRequest(input *ClaimGameServerInput) (req *request.Request, output *ClaimGameServerOutput)

ClaimGameServerRequest generates a "aws/request.Request" representing the client's request for the ClaimGameServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ClaimGameServer for more information on using the ClaimGameServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ClaimGameServer

func (*GameLift) ClaimGameServerWithContext added in v1.30.3 

func (c *GameLift) ClaimGameServerWithContext(ctx aws.Context, input *ClaimGameServerInput, opts ...request.Option) (*ClaimGameServerOutput, error)

ClaimGameServerWithContext is the same as ClaimGameServer with the addition of the ability to pass a context and additional request options.

See ClaimGameServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateAlias 

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

CreateAlias API operation for Amazon GameLift.

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build.

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling UpdateAlias.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateAlias

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAlias for more information on using the CreateAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateAlias

func (*GameLift) CreateAliasWithContext added in v1.8.0 

func (c *GameLift) CreateAliasWithContext(ctx aws.Context, input *CreateAliasInput, opts ...request.Option) (*CreateAliasOutput, error)

CreateAliasWithContext is the same as CreateAlias with the addition of the ability to pass a context and additional request options.

See CreateAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateBuild 

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

CreateBuild API operation for Amazon GameLift.

Creates a new Amazon GameLift build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift.

When setting up a new game build for Amazon GameLift, we recommend using the CLI command upload-build (https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html) . This helper command combines two tasks: (1) it uploads your build files from a file directory to an Amazon GameLift Amazon S3 location, and (2) it creates a new build resource.

You can use the CreateBuild operation in the following scenarios:

  • Create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, specify a build name, operating system, and the Amazon S3 storage location of your game build.

  • Upload your build files to a Amazon GameLift Amazon S3 location. To use this option, specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see Uploading Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html) in the Amazon S3 Developer Guide. After you upload build files to the Amazon GameLift Amazon S3 location, you can't update them.

If successful, this operation creates a new build resource with a unique build ID and places it in INITIALIZED status. A build must be in READY status before you can create fleets with it.

Learn more

Uploading Your Game (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) 

Create a Build with Files in Amazon S3 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateBuild

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBuild for more information on using the CreateBuild API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateBuild

func (*GameLift) CreateBuildWithContext added in v1.8.0 

func (c *GameLift) CreateBuildWithContext(ctx aws.Context, input *CreateBuildInput, opts ...request.Option) (*CreateBuildOutput, error)

CreateBuildWithContext is the same as CreateBuild with the addition of the ability to pass a context and additional request options.

See CreateBuild for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateContainerGroupDefinition added in v1.51.28 

func (c *GameLift) CreateContainerGroupDefinition(input *CreateContainerGroupDefinitionInput) (*CreateContainerGroupDefinitionOutput, error)

CreateContainerGroupDefinition API operation for Amazon GameLift.

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Creates a ContainerGroupDefinition resource that describes a set of containers for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon GameLift container group is similar to a container "task" and "pod". Each container group can have one or more containers.

Use container group definitions when you create a container fleet. Container group definitions determine how Amazon GameLift deploys your containers to each instance in a container fleet.

You can create two types of container groups, based on scheduling strategy:

  • A replica container group manages the containers that run your game server application and supporting software. Replica container groups might be replicated multiple times on each fleet instance, depending on instance resources.

  • A daemon container group manages containers that run other software, such as background services, logging, or test processes. You might use a daemon container group for processes that need to run only once per fleet instance, or processes that need to persist independently of the replica container group.

To create a container group definition, specify a group name, a list of container definitions, and maximum total CPU and memory requirements for the container group. Specify an operating system and scheduling strategy or use the default values. When using the Amazon Web Services CLI tool, you can pass in your container definitions as a JSON file.

This operation requires Identity and Access Management (IAM) permissions to access container images in Amazon ECR repositories. See IAM permissions for Amazon GameLift (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html) for help setting the appropriate permissions.

If successful, this operation creates a new ContainerGroupDefinition resource with an ARN value assigned. You can't change the properties of a container group definition. Instead, create a new one.

Learn more

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 CreateContainerGroupDefinition for usage and error information.

Returned Error Types:

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

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. 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.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateContainerGroupDefinition

func (*GameLift) CreateContainerGroupDefinitionRequest added in v1.51.28 

func (c *GameLift) CreateContainerGroupDefinitionRequest(input *CreateContainerGroupDefinitionInput) (req *request.Request, output *CreateContainerGroupDefinitionOutput)

CreateContainerGroupDefinitionRequest generates a "aws/request.Request" representing the client's request for the CreateContainerGroupDefinition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateContainerGroupDefinition for more information on using the CreateContainerGroupDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateContainerGroupDefinition

func (*GameLift) CreateContainerGroupDefinitionWithContext added in v1.51.28 

func (c *GameLift) CreateContainerGroupDefinitionWithContext(ctx aws.Context, input *CreateContainerGroupDefinitionInput, opts ...request.Option) (*CreateContainerGroupDefinitionOutput, error)

CreateContainerGroupDefinitionWithContext is the same as CreateContainerGroupDefinition with the addition of the ability to pass a context and additional request options.

See CreateContainerGroupDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateFleet 

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

CreateFleet API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Creates a fleet of compute resources to host your game servers. Use this operation to set up the following types of fleets based on compute type:

Managed EC2 fleet

An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the lifecycle of game server processes, which host game sessions for players. EC2 fleets can have instances in multiple locations. Each instance in the fleet is designated a Compute.

To create an EC2 fleet, provide these required parameters:

  • Either BuildId or ScriptId

  • ComputeType set to EC2 (the default value)

  • EC2InboundPermissions

  • EC2InstanceType

  • FleetType

  • Name

  • RuntimeConfiguration with at least one ServerProcesses configuration

If successful, this operation creates a new fleet resource and places it in NEW status while Amazon GameLift initiates the fleet creation workflow (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow). To debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create a development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.

Managed container fleet

A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your container architecture is deployed to each fleet instance based on the fleet configuration. Amazon GameLift manages the containers on each fleet instance and controls the lifecycle of game server processes, which host game sessions for players. Container fleets can have instances in multiple locations. Each container on an instance that runs game server processes is registered as a Compute.

To create a container fleet, provide these required parameters:

  • ComputeType set to CONTAINER

  • ContainerGroupsConfiguration

  • EC2InboundPermissions

  • EC2InstanceType

  • FleetType set to ON_DEMAND

  • Name

  • RuntimeConfiguration with at least one ServerProcesses configuration

If successful, this operation creates a new fleet resource and places it in NEW status while Amazon GameLift initiates the fleet creation workflow (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow).

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.

Anywhere fleet

An Anywhere fleet represents compute resources that are not owned or managed by Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use one to host game servers with on-premises hardware or other game hosting solutions.

To create an Anywhere fleet, provide these required parameters:

  • ComputeType set to ANYWHERE

  • Locations specifying a custom location

  • Name

If successful, this operation creates a new fleet resource and places it in ACTIVE status. You can register computes with a fleet in ACTIVE status.

Learn more

Setting up fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

Setting up a container fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-build-fleet.html)

Debug fleet creation issues (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation)

Multi-location fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • NotReadyException The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter (http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/).

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleet

func (*GameLift) CreateFleetLocations added in v1.37.32 

func (c *GameLift) CreateFleetLocations(input *CreateFleetLocationsInput) (*CreateFleetLocationsOutput, error)

CreateFleetLocations API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Adds remote locations to an EC2 or container fleet and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.

You can't add remote locations to a fleet that resides in an Amazon Web Services Region that doesn't support multiple locations. Fleets created prior to March 2021 can't support multiple locations.

To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.

If successful, this operation returns the list of added locations with their status set to NEW. Amazon GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html).

Learn more

Setting up fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

Multi-location fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 CreateFleetLocations for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

  • NotReadyException The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter (http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/).

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleetLocations

func (*GameLift) CreateFleetLocationsRequest added in v1.37.32 

func (c *GameLift) CreateFleetLocationsRequest(input *CreateFleetLocationsInput) (req *request.Request, output *CreateFleetLocationsOutput)

CreateFleetLocationsRequest generates a "aws/request.Request" representing the client's request for the CreateFleetLocations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFleetLocations for more information on using the CreateFleetLocations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleetLocations

func (*GameLift) CreateFleetLocationsWithContext added in v1.37.32 

func (c *GameLift) CreateFleetLocationsWithContext(ctx aws.Context, input *CreateFleetLocationsInput, opts ...request.Option) (*CreateFleetLocationsOutput, error)

CreateFleetLocationsWithContext is the same as CreateFleetLocations with the addition of the ability to pass a context and additional request options.

See CreateFleetLocations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFleet for more information on using the CreateFleet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleet

func (*GameLift) CreateFleetWithContext added in v1.8.0 

func (c *GameLift) CreateFleetWithContext(ctx aws.Context, input *CreateFleetInput, opts ...request.Option) (*CreateFleetOutput, error)

CreateFleetWithContext is the same as CreateFleet with the addition of the ability to pass a context and additional request options.

See CreateFleet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateGameServerGroup added in v1.30.3 

func (c *GameLift) CreateGameServerGroup(input *CreateGameServerGroupInput) (*CreateGameServerGroupOutput, error)

CreateGameServerGroup API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Creates a Amazon GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the Amazon GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.

Before creating a new game server group, you must have the following:

To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a Amazon GameLift FleetIQ metric.

Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by Amazon GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 CreateGameServerGroup for usage and error information.

Returned Error Types:

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

  • UnauthorizedException The client failed authentication. 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameServerGroup

func (*GameLift) CreateGameServerGroupRequest added in v1.30.3 

func (c *GameLift) CreateGameServerGroupRequest(input *CreateGameServerGroupInput) (req *request.Request, output *CreateGameServerGroupOutput)

CreateGameServerGroupRequest generates a "aws/request.Request" representing the client's request for the CreateGameServerGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGameServerGroup for more information on using the CreateGameServerGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameServerGroup

func (*GameLift) CreateGameServerGroupWithContext added in v1.30.3 

func (c *GameLift) CreateGameServerGroupWithContext(ctx aws.Context, input *CreateGameServerGroupInput, opts ...request.Option) (*CreateGameServerGroupOutput, error)

CreateGameServerGroupWithContext is the same as CreateGameServerGroup with the addition of the ability to pass a context and additional request options.

See CreateGameServerGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateGameSession 

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

CreateGameSession API operation for Amazon GameLift.

Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the Amazon GameLift game session placement feature with StartGameSessionPlacement (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) , which uses the FleetIQ algorithm and queues to optimize the placement process.

When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The target fleet must be in ACTIVE status.

You can use this operation in the following ways:

  • To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration.

  • To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration.

  • To create a game session on an instance in an Anywhere fleet, specify the fleet's custom location.

If successful, Amazon GameLift initiates a workflow to start a new game session and returns a GameSession object containing the game session configuration and status. When the game session status is ACTIVE, it is updated with connection information and you can create player sessions for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) to change the game session's player session creation policy.

Amazon GameLift retains logs for active for 14 days. To access the logs, call GetGameSessionLogUrl (https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html) to download the log files.

Available in Amazon GameLift Local.

Learn more

Start a game session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSession

func (*GameLift) CreateGameSessionQueue added in v1.6.27 

func (c *GameLift) CreateGameSessionQueue(input *CreateGameSessionQueueInput) (*CreateGameSessionQueueOutput, error)

CreateGameSessionQueue API operation for Amazon GameLift.

Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.

A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.

The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.

To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.

If successful, a new GameSessionQueue object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) or StartMatchmaking (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchmaking.html), reference a queue's name or ARN.

Learn more 

Design a game session queue (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html)

Create a game session queue (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html)

CreateGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html) | DescribeGameSessionQueues (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html) | UpdateGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html) | DeleteGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html) | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 CreateGameSessionQueue for usage and error information.

Returned Error Types:

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

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSessionQueue

func (*GameLift) CreateGameSessionQueueRequest added in v1.6.27 

func (c *GameLift) CreateGameSessionQueueRequest(input *CreateGameSessionQueueInput) (req *request.Request, output *CreateGameSessionQueueOutput)

CreateGameSessionQueueRequest generates a "aws/request.Request" representing the client's request for the CreateGameSessionQueue operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGameSessionQueue for more information on using the CreateGameSessionQueue API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSessionQueue

func (*GameLift) CreateGameSessionQueueWithContext added in v1.8.0 

func (c *GameLift) CreateGameSessionQueueWithContext(ctx aws.Context, input *CreateGameSessionQueueInput, opts ...request.Option) (*CreateGameSessionQueueOutput, error)

CreateGameSessionQueueWithContext is the same as CreateGameSessionQueue with the addition of the ability to pass a context and additional request options.

See CreateGameSessionQueue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGameSession for more information on using the CreateGameSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSession

func (*GameLift) CreateGameSessionWithContext added in v1.8.0 

func (c *GameLift) CreateGameSessionWithContext(ctx aws.Context, input *CreateGameSessionInput, opts ...request.Option) (*CreateGameSessionOutput, error)

CreateGameSessionWithContext is the same as CreateGameSession with the addition of the ability to pass a context and additional request options.

See CreateGameSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateLocation added in v1.44.151 

func (c *GameLift) CreateLocation(input *CreateLocationInput) (*CreateLocationOutput, error)

CreateLocation API operation for Amazon GameLift.

Creates a custom location for use in an Anywhere 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 CreateLocation for usage and error information.

Returned Error Types:

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

  • LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue 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.

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateLocation

func (*GameLift) CreateLocationRequest added in v1.44.151 

func (c *GameLift) CreateLocationRequest(input *CreateLocationInput) (req *request.Request, output *CreateLocationOutput)

CreateLocationRequest generates a "aws/request.Request" representing the client's request for the CreateLocation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLocation for more information on using the CreateLocation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateLocation

func (*GameLift) CreateLocationWithContext added in v1.44.151 

func (c *GameLift) CreateLocationWithContext(ctx aws.Context, input *CreateLocationInput, opts ...request.Option) (*CreateLocationOutput, error)

CreateLocationWithContext is the same as CreateLocation with the addition of the ability to pass a context and additional request options.

See CreateLocation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateMatchmakingConfiguration added in v1.10.27 

func (c *GameLift) CreateMatchmakingConfiguration(input *CreateMatchmakingConfigurationInput) (*CreateMatchmakingConfigurationOutput, error)

CreateMatchmakingConfiguration API operation for Amazon GameLift.

Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration.

To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without Amazon GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with Amazon GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.

In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.

Learn more 

Design a FlexMatch matchmaker (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html)

Set up FlexMatch event notification (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html)

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 CreateMatchmakingConfiguration for usage and error information.

Returned Error Types:

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

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingConfiguration

func (*GameLift) CreateMatchmakingConfigurationRequest added in v1.10.27 

func (c *GameLift) CreateMatchmakingConfigurationRequest(input *CreateMatchmakingConfigurationInput) (req *request.Request, output *CreateMatchmakingConfigurationOutput)

CreateMatchmakingConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreateMatchmakingConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMatchmakingConfiguration for more information on using the CreateMatchmakingConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingConfiguration

func (*GameLift) CreateMatchmakingConfigurationWithContext added in v1.10.27 

func (c *GameLift) CreateMatchmakingConfigurationWithContext(ctx aws.Context, input *CreateMatchmakingConfigurationInput, opts ...request.Option) (*CreateMatchmakingConfigurationOutput, error)

CreateMatchmakingConfigurationWithContext is the same as CreateMatchmakingConfiguration with the addition of the ability to pass a context and additional request options.

See CreateMatchmakingConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateMatchmakingRuleSet added in v1.10.27 

func (c *GameLift) CreateMatchmakingRuleSet(input *CreateMatchmakingRuleSetInput) (*CreateMatchmakingRuleSetOutput, error)

CreateMatchmakingRuleSet API operation for Amazon GameLift.

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.

To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet (https://docs.aws.amazon.com/gamelift/latest/apireference/API_ValidateMatchmakingRuleSet.html) before creating a new rule set.

Learn more

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 CreateMatchmakingRuleSet for usage and error information.

Returned Error Types:

  • InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingRuleSet

func (*GameLift) CreateMatchmakingRuleSetRequest added in v1.10.27 

func (c *GameLift) CreateMatchmakingRuleSetRequest(input *CreateMatchmakingRuleSetInput) (req *request.Request, output *CreateMatchmakingRuleSetOutput)

CreateMatchmakingRuleSetRequest generates a "aws/request.Request" representing the client's request for the CreateMatchmakingRuleSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMatchmakingRuleSet for more information on using the CreateMatchmakingRuleSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingRuleSet

func (*GameLift) CreateMatchmakingRuleSetWithContext added in v1.10.27 

func (c *GameLift) CreateMatchmakingRuleSetWithContext(ctx aws.Context, input *CreateMatchmakingRuleSetInput, opts ...request.Option) (*CreateMatchmakingRuleSetOutput, error)

CreateMatchmakingRuleSetWithContext is the same as CreateMatchmakingRuleSet with the addition of the ability to pass a context and additional request options.

See CreateMatchmakingRuleSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreatePlayerSession 

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

CreatePlayerSession API operation for Amazon GameLift.

Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. You can add a group of players to a game session with CreatePlayerSessions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html) .

To create a player session, specify a game session ID, player ID, and optionally a set of player data.

If successful, a slot is reserved in the game session for the player and a new PlayerSessions object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.

The maximum number of players per game session is 200. It is not adjustable.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreatePlayerSession

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePlayerSession for more information on using the CreatePlayerSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreatePlayerSession

func (*GameLift) CreatePlayerSessionWithContext added in v1.8.0 

func (c *GameLift) CreatePlayerSessionWithContext(ctx aws.Context, input *CreatePlayerSessionInput, opts ...request.Option) (*CreatePlayerSessionOutput, error)

CreatePlayerSessionWithContext is the same as CreatePlayerSession with the addition of the ability to pass a context and additional request options.

See CreatePlayerSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreatePlayerSessions 

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

CreatePlayerSessions API operation for Amazon GameLift.

Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html)

To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.

If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.

The maximum number of players per game session is 200. It is not adjustable.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreatePlayerSessions

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePlayerSessions for more information on using the CreatePlayerSessions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreatePlayerSessions

func (*GameLift) CreatePlayerSessionsWithContext added in v1.8.0 

func (c *GameLift) CreatePlayerSessionsWithContext(ctx aws.Context, input *CreatePlayerSessionsInput, opts ...request.Option) (*CreatePlayerSessionsOutput, error)

CreatePlayerSessionsWithContext is the same as CreatePlayerSessions with the addition of the ability to pass a context and additional request options.

See CreatePlayerSessions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateScript added in v1.19.18 

func (c *GameLift) CreateScript(input *CreateScriptInput) (*CreateScriptOutput, error)

CreateScript API operation for Amazon GameLift.

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.

To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:

  • A locally available directory. Use the ZipFile parameter for this option.

  • An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.

If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.

Learn more

Amazon GameLift Realtime Servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html)

Set Up a Role for Amazon GameLift Access (https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 CreateScript for usage and error information.

Returned Error Types:

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateScript

func (*GameLift) CreateScriptRequest added in v1.19.18 

func (c *GameLift) CreateScriptRequest(input *CreateScriptInput) (req *request.Request, output *CreateScriptOutput)

CreateScriptRequest generates a "aws/request.Request" representing the client's request for the CreateScript operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateScript for more information on using the CreateScript API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateScript

func (*GameLift) CreateScriptWithContext added in v1.19.18 

func (c *GameLift) CreateScriptWithContext(ctx aws.Context, input *CreateScriptInput, opts ...request.Option) (*CreateScriptOutput, error)

CreateScriptWithContext is the same as CreateScript with the addition of the ability to pass a context and additional request options.

See CreateScript for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateVpcPeeringAuthorization added in v1.10.37 

func (c *GameLift) CreateVpcPeeringAuthorization(input *CreateVpcPeeringAuthorizationInput) (*CreateVpcPeeringAuthorizationOutput, error)

CreateVpcPeeringAuthorization API operation for Amazon GameLift.

Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html) to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html).

You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.

To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 CreateVpcPeeringAuthorization for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateVpcPeeringAuthorization

func (*GameLift) CreateVpcPeeringAuthorizationRequest added in v1.10.37 

func (c *GameLift) CreateVpcPeeringAuthorizationRequest(input *CreateVpcPeeringAuthorizationInput) (req *request.Request, output *CreateVpcPeeringAuthorizationOutput)

CreateVpcPeeringAuthorizationRequest generates a "aws/request.Request" representing the client's request for the CreateVpcPeeringAuthorization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateVpcPeeringAuthorization for more information on using the CreateVpcPeeringAuthorization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateVpcPeeringAuthorization

func (*GameLift) CreateVpcPeeringAuthorizationWithContext added in v1.10.37 

func (c *GameLift) CreateVpcPeeringAuthorizationWithContext(ctx aws.Context, input *CreateVpcPeeringAuthorizationInput, opts ...request.Option) (*CreateVpcPeeringAuthorizationOutput, error)

CreateVpcPeeringAuthorizationWithContext is the same as CreateVpcPeeringAuthorization with the addition of the ability to pass a context and additional request options.

See CreateVpcPeeringAuthorization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) CreateVpcPeeringConnection added in v1.10.37 

func (c *GameLift) CreateVpcPeeringConnection(input *CreateVpcPeeringConnectionInput) (*CreateVpcPeeringConnectionOutput, error)

CreateVpcPeeringConnection API operation for Amazon GameLift.

Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html).

Before calling this operation to establish the peering connection, you first need to use CreateVpcPeeringAuthorization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html) and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.

To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html) , or by monitoring fleet events for success or failure using DescribeFleetEvents (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html) .

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 CreateVpcPeeringConnection for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateVpcPeeringConnection

func (*GameLift) CreateVpcPeeringConnectionRequest added in v1.10.37 

func (c *GameLift) CreateVpcPeeringConnectionRequest(input *CreateVpcPeeringConnectionInput) (req *request.Request, output *CreateVpcPeeringConnectionOutput)

CreateVpcPeeringConnectionRequest generates a "aws/request.Request" representing the client's request for the CreateVpcPeeringConnection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateVpcPeeringConnection for more information on using the CreateVpcPeeringConnection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateVpcPeeringConnection

func (*GameLift) CreateVpcPeeringConnectionWithContext added in v1.10.37 

func (c *GameLift) CreateVpcPeeringConnectionWithContext(ctx aws.Context, input *CreateVpcPeeringConnectionInput, opts ...request.Option) (*CreateVpcPeeringConnectionOutput, error)

CreateVpcPeeringConnectionWithContext is the same as CreateVpcPeeringConnection with the addition of the ability to pass a context and additional request options.

See CreateVpcPeeringConnection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteAlias 

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

DeleteAlias API operation for Amazon GameLift.

Deletes an alias. This operation 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.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteAlias

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAlias for more information on using the DeleteAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteAlias

func (*GameLift) DeleteAliasWithContext added in v1.8.0 

func (c *GameLift) DeleteAliasWithContext(ctx aws.Context, input *DeleteAliasInput, opts ...request.Option) (*DeleteAliasOutput, error)

DeleteAliasWithContext is the same as DeleteAlias with the addition of the ability to pass a context and additional request options.

See DeleteAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteBuild 

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

DeleteBuild API operation for Amazon GameLift.

Deletes a build. This operation permanently deletes the build resource and any uploaded build files. 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.

To delete a build, specify the build ID.

Learn more 

Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteBuild

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBuild for more information on using the DeleteBuild API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteBuild

func (*GameLift) DeleteBuildWithContext added in v1.8.0 

func (c *GameLift) DeleteBuildWithContext(ctx aws.Context, input *DeleteBuildInput, opts ...request.Option) (*DeleteBuildOutput, error)

DeleteBuildWithContext is the same as DeleteBuild with the addition of the ability to pass a context and additional request options.

See DeleteBuild for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteContainerGroupDefinition added in v1.51.28 

func (c *GameLift) DeleteContainerGroupDefinition(input *DeleteContainerGroupDefinitionInput) (*DeleteContainerGroupDefinitionOutput, error)

DeleteContainerGroupDefinition API operation for Amazon GameLift.

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Deletes a container group definition resource. You can delete a container group definition if there are no fleets using the definition.

To delete a container group definition, identify the resource to delete.

Learn more

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 DeleteContainerGroupDefinition for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteContainerGroupDefinition

func (*GameLift) DeleteContainerGroupDefinitionRequest added in v1.51.28 

func (c *GameLift) DeleteContainerGroupDefinitionRequest(input *DeleteContainerGroupDefinitionInput) (req *request.Request, output *DeleteContainerGroupDefinitionOutput)

DeleteContainerGroupDefinitionRequest generates a "aws/request.Request" representing the client's request for the DeleteContainerGroupDefinition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteContainerGroupDefinition for more information on using the DeleteContainerGroupDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteContainerGroupDefinition

func (*GameLift) DeleteContainerGroupDefinitionWithContext added in v1.51.28 

func (c *GameLift) DeleteContainerGroupDefinitionWithContext(ctx aws.Context, input *DeleteContainerGroupDefinitionInput, opts ...request.Option) (*DeleteContainerGroupDefinitionOutput, error)

DeleteContainerGroupDefinitionWithContext is the same as DeleteContainerGroupDefinition with the addition of the ability to pass a context and additional request options.

See DeleteContainerGroupDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteFleet 

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

DeleteFleet API operation for Amazon GameLift.

Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.

If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html). You don't need to explicitly delete the VPC peering connection.

To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is emitted.

Learn more

Setting up Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 Types:

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteFleet

func (*GameLift) DeleteFleetLocations added in v1.37.32 

func (c *GameLift) DeleteFleetLocations(input *DeleteFleetLocationsInput) (*DeleteFleetLocationsOutput, error)

DeleteFleetLocations API operation for Amazon GameLift.

Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down.

To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted.

If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 DeleteFleetLocations for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteFleetLocations

func (*GameLift) DeleteFleetLocationsRequest added in v1.37.32 

func (c *GameLift) DeleteFleetLocationsRequest(input *DeleteFleetLocationsInput) (req *request.Request, output *DeleteFleetLocationsOutput)

DeleteFleetLocationsRequest generates a "aws/request.Request" representing the client's request for the DeleteFleetLocations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFleetLocations for more information on using the DeleteFleetLocations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteFleetLocations

func (*GameLift) DeleteFleetLocationsWithContext added in v1.37.32 

func (c *GameLift) DeleteFleetLocationsWithContext(ctx aws.Context, input *DeleteFleetLocationsInput, opts ...request.Option) (*DeleteFleetLocationsOutput, error)

DeleteFleetLocationsWithContext is the same as DeleteFleetLocations with the addition of the ability to pass a context and additional request options.

See DeleteFleetLocations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFleet for more information on using the DeleteFleet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteFleet

func (*GameLift) DeleteFleetWithContext added in v1.8.0 

func (c *GameLift) DeleteFleetWithContext(ctx aws.Context, input *DeleteFleetInput, opts ...request.Option) (*DeleteFleetOutput, error)

DeleteFleetWithContext is the same as DeleteFleet with the addition of the ability to pass a context and additional request options.

See DeleteFleet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteGameServerGroup added in v1.30.3 

func (c *GameLift) DeleteGameServerGroup(input *DeleteGameServerGroupInput) (*DeleteGameServerGroupOutput, error)

DeleteGameServerGroup API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:

  • The game server group

  • The corresponding Auto Scaling group

  • All game servers that are currently running in the group

To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.

If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, Amazon GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.

Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 DeleteGameServerGroup for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • UnauthorizedException The client failed authentication. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameServerGroup

func (*GameLift) DeleteGameServerGroupRequest added in v1.30.3 

func (c *GameLift) DeleteGameServerGroupRequest(input *DeleteGameServerGroupInput) (req *request.Request, output *DeleteGameServerGroupOutput)

DeleteGameServerGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteGameServerGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGameServerGroup for more information on using the DeleteGameServerGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameServerGroup

func (*GameLift) DeleteGameServerGroupWithContext added in v1.30.3 

func (c *GameLift) DeleteGameServerGroupWithContext(ctx aws.Context, input *DeleteGameServerGroupInput, opts ...request.Option) (*DeleteGameServerGroupOutput, error)

DeleteGameServerGroupWithContext is the same as DeleteGameServerGroup with the addition of the ability to pass a context and additional request options.

See DeleteGameServerGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteGameSessionQueue added in v1.6.27 

func (c *GameLift) DeleteGameSessionQueue(input *DeleteGameSessionQueueInput) (*DeleteGameSessionQueueOutput, error)

DeleteGameSessionQueue API operation for Amazon GameLift.

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) requests that reference the queue will fail. To delete a queue, specify the queue name.

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 DeleteGameSessionQueue for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameSessionQueue

func (*GameLift) DeleteGameSessionQueueRequest added in v1.6.27 

func (c *GameLift) DeleteGameSessionQueueRequest(input *DeleteGameSessionQueueInput) (req *request.Request, output *DeleteGameSessionQueueOutput)

DeleteGameSessionQueueRequest generates a "aws/request.Request" representing the client's request for the DeleteGameSessionQueue operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGameSessionQueue for more information on using the DeleteGameSessionQueue API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameSessionQueue

func (*GameLift) DeleteGameSessionQueueWithContext added in v1.8.0 

func (c *GameLift) DeleteGameSessionQueueWithContext(ctx aws.Context, input *DeleteGameSessionQueueInput, opts ...request.Option) (*DeleteGameSessionQueueOutput, error)

DeleteGameSessionQueueWithContext is the same as DeleteGameSessionQueue with the addition of the ability to pass a context and additional request options.

See DeleteGameSessionQueue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteLocation added in v1.44.151 

func (c *GameLift) DeleteLocation(input *DeleteLocationInput) (*DeleteLocationOutput, error)

DeleteLocation API operation for Amazon GameLift.

Deletes a custom location.

Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it is in use. For more information, see DeregisterCompute (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeregisterCompute.html).

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 DeleteLocation for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteLocation

func (*GameLift) DeleteLocationRequest added in v1.44.151 

func (c *GameLift) DeleteLocationRequest(input *DeleteLocationInput) (req *request.Request, output *DeleteLocationOutput)

DeleteLocationRequest generates a "aws/request.Request" representing the client's request for the DeleteLocation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLocation for more information on using the DeleteLocation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteLocation

func (*GameLift) DeleteLocationWithContext added in v1.44.151 

func (c *GameLift) DeleteLocationWithContext(ctx aws.Context, input *DeleteLocationInput, opts ...request.Option) (*DeleteLocationOutput, error)

DeleteLocationWithContext is the same as DeleteLocation with the addition of the ability to pass a context and additional request options.

See DeleteLocation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteMatchmakingConfiguration added in v1.10.27 

func (c *GameLift) DeleteMatchmakingConfiguration(input *DeleteMatchmakingConfigurationInput) (*DeleteMatchmakingConfigurationOutput, error)

DeleteMatchmakingConfiguration API operation for Amazon GameLift.

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.

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 DeleteMatchmakingConfiguration for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteMatchmakingConfiguration

func (*GameLift) DeleteMatchmakingConfigurationRequest added in v1.10.27 

func (c *GameLift) DeleteMatchmakingConfigurationRequest(input *DeleteMatchmakingConfigurationInput) (req *request.Request, output *DeleteMatchmakingConfigurationOutput)

DeleteMatchmakingConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteMatchmakingConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMatchmakingConfiguration for more information on using the DeleteMatchmakingConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteMatchmakingConfiguration

func (*GameLift) DeleteMatchmakingConfigurationWithContext added in v1.10.27 

func (c *GameLift) DeleteMatchmakingConfigurationWithContext(ctx aws.Context, input *DeleteMatchmakingConfigurationInput, opts ...request.Option) (*DeleteMatchmakingConfigurationOutput, error)

DeleteMatchmakingConfigurationWithContext is the same as DeleteMatchmakingConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteMatchmakingConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteMatchmakingRuleSet added in v1.16.30 

func (c *GameLift) DeleteMatchmakingRuleSet(input *DeleteMatchmakingRuleSetInput) (*DeleteMatchmakingRuleSetOutput, error)

DeleteMatchmakingRuleSet API operation for Amazon GameLift.

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.

Learn more

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 DeleteMatchmakingRuleSet for usage and error information.

Returned Error Types:

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteMatchmakingRuleSet

func (*GameLift) DeleteMatchmakingRuleSetRequest added in v1.16.30 

func (c *GameLift) DeleteMatchmakingRuleSetRequest(input *DeleteMatchmakingRuleSetInput) (req *request.Request, output *DeleteMatchmakingRuleSetOutput)

DeleteMatchmakingRuleSetRequest generates a "aws/request.Request" representing the client's request for the DeleteMatchmakingRuleSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMatchmakingRuleSet for more information on using the DeleteMatchmakingRuleSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteMatchmakingRuleSet

func (*GameLift) DeleteMatchmakingRuleSetWithContext added in v1.16.30 

func (c *GameLift) DeleteMatchmakingRuleSetWithContext(ctx aws.Context, input *DeleteMatchmakingRuleSetInput, opts ...request.Option) (*DeleteMatchmakingRuleSetOutput, error)

DeleteMatchmakingRuleSetWithContext is the same as DeleteMatchmakingRuleSet with the addition of the ability to pass a context and additional request options.

See DeleteMatchmakingRuleSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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. Once deleted, the policy is no longer in force and Amazon GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

To temporarily suspend scaling policies, use StopFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html). This operation suspends all policies 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 DeleteScalingPolicy for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScalingPolicy

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteScalingPolicy for more information on using the DeleteScalingPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScalingPolicy

func (*GameLift) DeleteScalingPolicyWithContext added in v1.8.0 

func (c *GameLift) DeleteScalingPolicyWithContext(ctx aws.Context, input *DeleteScalingPolicyInput, opts ...request.Option) (*DeleteScalingPolicyOutput, error)

DeleteScalingPolicyWithContext is the same as DeleteScalingPolicy with the addition of the ability to pass a context and additional request options.

See DeleteScalingPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteScript added in v1.19.18 

func (c *GameLift) DeleteScript(input *DeleteScriptInput) (*DeleteScriptOutput, error)

DeleteScript API operation for Amazon GameLift.

Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).

To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.

Learn more

Amazon GameLift Realtime Servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 DeleteScript for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScript

func (*GameLift) DeleteScriptRequest added in v1.19.18 

func (c *GameLift) DeleteScriptRequest(input *DeleteScriptInput) (req *request.Request, output *DeleteScriptOutput)

DeleteScriptRequest generates a "aws/request.Request" representing the client's request for the DeleteScript operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteScript for more information on using the DeleteScript API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScript

func (*GameLift) DeleteScriptWithContext added in v1.19.18 

func (c *GameLift) DeleteScriptWithContext(ctx aws.Context, input *DeleteScriptInput, opts ...request.Option) (*DeleteScriptOutput, error)

DeleteScriptWithContext is the same as DeleteScript with the addition of the ability to pass a context and additional request options.

See DeleteScript for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteVpcPeeringAuthorization added in v1.10.37 

func (c *GameLift) DeleteVpcPeeringAuthorization(input *DeleteVpcPeeringAuthorizationInput) (*DeleteVpcPeeringAuthorizationOutput, error)

DeleteVpcPeeringAuthorization API operation for Amazon GameLift.

Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html).

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 DeleteVpcPeeringAuthorization for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteVpcPeeringAuthorization

func (*GameLift) DeleteVpcPeeringAuthorizationRequest added in v1.10.37 

func (c *GameLift) DeleteVpcPeeringAuthorizationRequest(input *DeleteVpcPeeringAuthorizationInput) (req *request.Request, output *DeleteVpcPeeringAuthorizationOutput)

DeleteVpcPeeringAuthorizationRequest generates a "aws/request.Request" representing the client's request for the DeleteVpcPeeringAuthorization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteVpcPeeringAuthorization for more information on using the DeleteVpcPeeringAuthorization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteVpcPeeringAuthorization

func (*GameLift) DeleteVpcPeeringAuthorizationWithContext added in v1.10.37 

func (c *GameLift) DeleteVpcPeeringAuthorizationWithContext(ctx aws.Context, input *DeleteVpcPeeringAuthorizationInput, opts ...request.Option) (*DeleteVpcPeeringAuthorizationOutput, error)

DeleteVpcPeeringAuthorizationWithContext is the same as DeleteVpcPeeringAuthorization with the addition of the ability to pass a context and additional request options.

See DeleteVpcPeeringAuthorization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeleteVpcPeeringConnection added in v1.10.37 

func (c *GameLift) DeleteVpcPeeringConnection(input *DeleteVpcPeeringConnectionInput) (*DeleteVpcPeeringConnectionOutput, error)

DeleteVpcPeeringConnection API operation for Amazon GameLift.

Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete..

Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 DeleteVpcPeeringConnection for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteVpcPeeringConnection

func (*GameLift) DeleteVpcPeeringConnectionRequest added in v1.10.37 

func (c *GameLift) DeleteVpcPeeringConnectionRequest(input *DeleteVpcPeeringConnectionInput) (req *request.Request, output *DeleteVpcPeeringConnectionOutput)

DeleteVpcPeeringConnectionRequest generates a "aws/request.Request" representing the client's request for the DeleteVpcPeeringConnection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteVpcPeeringConnection for more information on using the DeleteVpcPeeringConnection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteVpcPeeringConnection

func (*GameLift) DeleteVpcPeeringConnectionWithContext added in v1.10.37 

func (c *GameLift) DeleteVpcPeeringConnectionWithContext(ctx aws.Context, input *DeleteVpcPeeringConnectionInput, opts ...request.Option) (*DeleteVpcPeeringConnectionOutput, error)

DeleteVpcPeeringConnectionWithContext is the same as DeleteVpcPeeringConnection with the addition of the ability to pass a context and additional request options.

See DeleteVpcPeeringConnection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeregisterCompute added in v1.44.151 

func (c *GameLift) DeregisterCompute(input *DeregisterComputeInput) (*DeregisterComputeOutput, error)

DeregisterCompute API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Removes a compute resource from an Amazon GameLift Anywhere fleet or container fleet. Deregistered computes can no longer host game sessions through Amazon GameLift.

For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to deregister fleet computes.

To deregister a compute, call this operation from the compute that's being deregistered and specify the compute name and the fleet ID.

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 DeregisterCompute for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterCompute

func (*GameLift) DeregisterComputeRequest added in v1.44.151 

func (c *GameLift) DeregisterComputeRequest(input *DeregisterComputeInput) (req *request.Request, output *DeregisterComputeOutput)

DeregisterComputeRequest generates a "aws/request.Request" representing the client's request for the DeregisterCompute operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterCompute for more information on using the DeregisterCompute API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterCompute

func (*GameLift) DeregisterComputeWithContext added in v1.44.151 

func (c *GameLift) DeregisterComputeWithContext(ctx aws.Context, input *DeregisterComputeInput, opts ...request.Option) (*DeregisterComputeOutput, error)

DeregisterComputeWithContext is the same as DeregisterCompute with the addition of the ability to pass a context and additional request options.

See DeregisterCompute for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DeregisterGameServer added in v1.30.3 

func (c *GameLift) DeregisterGameServer(input *DeregisterGameServerInput) (*DeregisterGameServerOutput, error)

DeregisterGameServer API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.

To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 DeregisterGameServer for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • UnauthorizedException The client failed authentication. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterGameServer

func (*GameLift) DeregisterGameServerRequest added in v1.30.3 

func (c *GameLift) DeregisterGameServerRequest(input *DeregisterGameServerInput) (req *request.Request, output *DeregisterGameServerOutput)

DeregisterGameServerRequest generates a "aws/request.Request" representing the client's request for the DeregisterGameServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterGameServer for more information on using the DeregisterGameServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterGameServer

func (*GameLift) DeregisterGameServerWithContext added in v1.30.3 

func (c *GameLift) DeregisterGameServerWithContext(ctx aws.Context, input *DeregisterGameServerInput, opts ...request.Option) (*DeregisterGameServerOutput, error)

DeregisterGameServerWithContext is the same as DeregisterGameServer with the addition of the ability to pass a context and additional request options.

See DeregisterGameServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeAlias 

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

DescribeAlias API operation for Amazon GameLift.

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeAlias

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAlias for more information on using the DescribeAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeAlias

func (*GameLift) DescribeAliasWithContext added in v1.8.0 

func (c *GameLift) DescribeAliasWithContext(ctx aws.Context, input *DescribeAliasInput, opts ...request.Option) (*DescribeAliasOutput, error)

DescribeAliasWithContext is the same as DescribeAlias with the addition of the ability to pass a context and additional request options.

See DescribeAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeBuild 

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

DescribeBuild API operation for Amazon GameLift.

Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.

Learn more 

Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeBuild

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBuild for more information on using the DescribeBuild API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeBuild

func (*GameLift) DescribeBuildWithContext added in v1.8.0 

func (c *GameLift) DescribeBuildWithContext(ctx aws.Context, input *DescribeBuildInput, opts ...request.Option) (*DescribeBuildOutput, error)

DescribeBuildWithContext is the same as DescribeBuild with the addition of the ability to pass a context and additional request options.

See DescribeBuild for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeCompute added in v1.44.151 

func (c *GameLift) DescribeCompute(input *DescribeComputeInput) (*DescribeComputeOutput, error)

DescribeCompute API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all computes in a fleet, call ListCompute.

To request information on a specific compute, provide the fleet ID and compute name.

If successful, this operation returns details for the requested compute resource. Depending on the fleet's compute type, the result includes the following information:

  • For EC2 fleets, this operation returns information about the EC2 instance.

  • For ANYWHERE fleets, this operation returns information about the registered compute.

  • For CONTAINER fleets, this operation returns information about the container that's registered as a compute, and the instance it's running on. The compute name is the container name.

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 DescribeCompute for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeCompute

func (*GameLift) DescribeComputeRequest added in v1.44.151 

func (c *GameLift) DescribeComputeRequest(input *DescribeComputeInput) (req *request.Request, output *DescribeComputeOutput)

DescribeComputeRequest generates a "aws/request.Request" representing the client's request for the DescribeCompute operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCompute for more information on using the DescribeCompute API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeCompute

func (*GameLift) DescribeComputeWithContext added in v1.44.151 

func (c *GameLift) DescribeComputeWithContext(ctx aws.Context, input *DescribeComputeInput, opts ...request.Option) (*DescribeComputeOutput, error)

DescribeComputeWithContext is the same as DescribeCompute with the addition of the ability to pass a context and additional request options.

See DescribeCompute for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeContainerGroupDefinition added in v1.51.28 

func (c *GameLift) DescribeContainerGroupDefinition(input *DescribeContainerGroupDefinitionInput) (*DescribeContainerGroupDefinitionOutput, error)

DescribeContainerGroupDefinition API operation for Amazon GameLift.

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves the properties of a container group definition, including all container definitions in the group.

To retrieve a container group definition, provide a resource identifier. If successful, this operation returns the complete properties of the container group definition.

Learn more

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 DescribeContainerGroupDefinition for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeContainerGroupDefinition

func (*GameLift) DescribeContainerGroupDefinitionRequest added in v1.51.28 

func (c *GameLift) DescribeContainerGroupDefinitionRequest(input *DescribeContainerGroupDefinitionInput) (req *request.Request, output *DescribeContainerGroupDefinitionOutput)

DescribeContainerGroupDefinitionRequest generates a "aws/request.Request" representing the client's request for the DescribeContainerGroupDefinition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeContainerGroupDefinition for more information on using the DescribeContainerGroupDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeContainerGroupDefinition

func (*GameLift) DescribeContainerGroupDefinitionWithContext added in v1.51.28 

func (c *GameLift) DescribeContainerGroupDefinitionWithContext(ctx aws.Context, input *DescribeContainerGroupDefinitionInput, opts ...request.Option) (*DescribeContainerGroupDefinitionOutput, error)

DescribeContainerGroupDefinitionWithContext is the same as DescribeContainerGroupDefinition with the addition of the ability to pass a context and additional request options.

See DescribeContainerGroupDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeEC2InstanceLimits 

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

DescribeEC2InstanceLimits API operation for Amazon GameLift.

Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types (http://aws.amazon.com/ec2/instance-types/). The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your Amazon GameLift fleets. You can request a limit increase for your account by using the Service limits page in the Amazon GameLift console.

Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:

  • Request specifies the Region ap-northeast-1 with no location. The result is limits and usage data on all instance types that are deployed in us-east-2, by all of the fleets that reside in ap-northeast-1.

  • Request specifies the Region us-east-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to ca-central-1.

  • Request specifies the Region eu-west-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in eu-west-1.

This operation can be used in the following ways:

  • To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.

  • To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.

If successful, an EC2InstanceLimits object is returned with limits and usage data for each requested instance type.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 Types:

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeEC2InstanceLimits

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEC2InstanceLimits for more information on using the DescribeEC2InstanceLimits API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeEC2InstanceLimits

func (*GameLift) DescribeEC2InstanceLimitsWithContext added in v1.8.0 

func (c *GameLift) DescribeEC2InstanceLimitsWithContext(ctx aws.Context, input *DescribeEC2InstanceLimitsInput, opts ...request.Option) (*DescribeEC2InstanceLimitsOutput, error)

DescribeEC2InstanceLimitsWithContext is the same as DescribeEC2InstanceLimits with the addition of the ability to pass a context and additional request options.

See DescribeEC2InstanceLimits for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeFleetAttributes 

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

DescribeFleetAttributes API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet.

You can use this operation in the following ways:

  • To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.

  • To get attributes for all fleets, do not provide a fleet identifier.

When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.

Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetAttributes

func (*GameLift) DescribeFleetAttributesPages added in v1.34.12 

func (c *GameLift) DescribeFleetAttributesPages(input *DescribeFleetAttributesInput, fn func(*DescribeFleetAttributesOutput, bool) bool) error

DescribeFleetAttributesPages iterates over the pages of a DescribeFleetAttributes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeFleetAttributes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeFleetAttributes operation.
pageNum := 0
err := client.DescribeFleetAttributesPages(params,
    func(page *gamelift.DescribeFleetAttributesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeFleetAttributesPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeFleetAttributesPagesWithContext(ctx aws.Context, input *DescribeFleetAttributesInput, fn func(*DescribeFleetAttributesOutput, bool) bool, opts ...request.Option) error

DescribeFleetAttributesPagesWithContext same as DescribeFleetAttributesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFleetAttributes for more information on using the DescribeFleetAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetAttributes

func (*GameLift) DescribeFleetAttributesWithContext added in v1.8.0 

func (c *GameLift) DescribeFleetAttributesWithContext(ctx aws.Context, input *DescribeFleetAttributesInput, opts ...request.Option) (*DescribeFleetAttributesOutput, error)

DescribeFleetAttributesWithContext is the same as DescribeFleetAttributes with the addition of the ability to pass a context and additional request options.

See DescribeFleetAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeFleetCapacity 

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

DescribeFleetCapacity API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for replica container groups.

With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity.

This operation can be used in the following ways:

  • To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.

  • To get capacity data for all fleets, do not provide a fleet identifier.

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. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. Capacity values are returned only for fleets that currently exist.

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

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-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 DescribeFleetCapacity for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetCapacity

func (*GameLift) DescribeFleetCapacityPages added in v1.34.12 

func (c *GameLift) DescribeFleetCapacityPages(input *DescribeFleetCapacityInput, fn func(*DescribeFleetCapacityOutput, bool) bool) error

DescribeFleetCapacityPages iterates over the pages of a DescribeFleetCapacity operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeFleetCapacity method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeFleetCapacity operation.
pageNum := 0
err := client.DescribeFleetCapacityPages(params,
    func(page *gamelift.DescribeFleetCapacityOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeFleetCapacityPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeFleetCapacityPagesWithContext(ctx aws.Context, input *DescribeFleetCapacityInput, fn func(*DescribeFleetCapacityOutput, bool) bool, opts ...request.Option) error

DescribeFleetCapacityPagesWithContext same as DescribeFleetCapacityPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFleetCapacity for more information on using the DescribeFleetCapacity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetCapacity

func (*GameLift) DescribeFleetCapacityWithContext added in v1.8.0 

func (c *GameLift) DescribeFleetCapacityWithContext(ctx aws.Context, input *DescribeFleetCapacityInput, opts ...request.Option) (*DescribeFleetCapacityOutput, error)

DescribeFleetCapacityWithContext is the same as DescribeFleetCapacity with the addition of the ability to pass a context and additional request options.

See DescribeFleetCapacity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeFleetEvents 

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

DescribeFleetEvents API operation for Amazon GameLift.

Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.

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.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 Types:

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetEvents

func (*GameLift) DescribeFleetEventsPages added in v1.34.12 

func (c *GameLift) DescribeFleetEventsPages(input *DescribeFleetEventsInput, fn func(*DescribeFleetEventsOutput, bool) bool) error

DescribeFleetEventsPages iterates over the pages of a DescribeFleetEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeFleetEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeFleetEvents operation.
pageNum := 0
err := client.DescribeFleetEventsPages(params,
    func(page *gamelift.DescribeFleetEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeFleetEventsPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeFleetEventsPagesWithContext(ctx aws.Context, input *DescribeFleetEventsInput, fn func(*DescribeFleetEventsOutput, bool) bool, opts ...request.Option) error

DescribeFleetEventsPagesWithContext same as DescribeFleetEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFleetEvents for more information on using the DescribeFleetEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetEvents

func (*GameLift) DescribeFleetEventsWithContext added in v1.8.0 

func (c *GameLift) DescribeFleetEventsWithContext(ctx aws.Context, input *DescribeFleetEventsInput, opts ...request.Option) (*DescribeFleetEventsOutput, error)

DescribeFleetEventsWithContext is the same as DescribeFleetEvents with the addition of the ability to pass a context and additional request options.

See DescribeFleetEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeFleetLocationAttributes added in v1.37.32 

func (c *GameLift) DescribeFleetLocationAttributes(input *DescribeFleetLocationAttributesInput) (*DescribeFleetLocationAttributesOutput, error)

DescribeFleetLocationAttributes API operation for Amazon GameLift.

Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.

This operation can be used in the following ways:

  • To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.

  • To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.

When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 DescribeFleetLocationAttributes for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetLocationAttributes

func (*GameLift) DescribeFleetLocationAttributesPages added in v1.37.32 

func (c *GameLift) DescribeFleetLocationAttributesPages(input *DescribeFleetLocationAttributesInput, fn func(*DescribeFleetLocationAttributesOutput, bool) bool) error

DescribeFleetLocationAttributesPages iterates over the pages of a DescribeFleetLocationAttributes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeFleetLocationAttributes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeFleetLocationAttributes operation.
pageNum := 0
err := client.DescribeFleetLocationAttributesPages(params,
    func(page *gamelift.DescribeFleetLocationAttributesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeFleetLocationAttributesPagesWithContext added in v1.37.32 

func (c *GameLift) DescribeFleetLocationAttributesPagesWithContext(ctx aws.Context, input *DescribeFleetLocationAttributesInput, fn func(*DescribeFleetLocationAttributesOutput, bool) bool, opts ...request.Option) error

DescribeFleetLocationAttributesPagesWithContext same as DescribeFleetLocationAttributesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeFleetLocationAttributesRequest added in v1.37.32 

func (c *GameLift) DescribeFleetLocationAttributesRequest(input *DescribeFleetLocationAttributesInput) (req *request.Request, output *DescribeFleetLocationAttributesOutput)

DescribeFleetLocationAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeFleetLocationAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFleetLocationAttributes for more information on using the DescribeFleetLocationAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetLocationAttributes

func (*GameLift) DescribeFleetLocationAttributesWithContext added in v1.37.32 

func (c *GameLift) DescribeFleetLocationAttributesWithContext(ctx aws.Context, input *DescribeFleetLocationAttributesInput, opts ...request.Option) (*DescribeFleetLocationAttributesOutput, error)

DescribeFleetLocationAttributesWithContext is the same as DescribeFleetLocationAttributes with the addition of the ability to pass a context and additional request options.

See DescribeFleetLocationAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeFleetLocationCapacity added in v1.37.32 

func (c *GameLift) DescribeFleetLocationCapacity(input *DescribeFleetLocationCapacityInput) (*DescribeFleetLocationCapacityOutput, error)

DescribeFleetLocationCapacity API operation for Amazon GameLift.

Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a container fleet, this operation also returns counts for replica container groups.

Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).

To retrieve capacity data, identify a fleet and location.

If successful, a FleetCapacity object is returned for the requested fleet location.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-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 DescribeFleetLocationCapacity for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetLocationCapacity

func (*GameLift) DescribeFleetLocationCapacityRequest added in v1.37.32 

func (c *GameLift) DescribeFleetLocationCapacityRequest(input *DescribeFleetLocationCapacityInput) (req *request.Request, output *DescribeFleetLocationCapacityOutput)

DescribeFleetLocationCapacityRequest generates a "aws/request.Request" representing the client's request for the DescribeFleetLocationCapacity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFleetLocationCapacity for more information on using the DescribeFleetLocationCapacity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetLocationCapacity

func (*GameLift) DescribeFleetLocationCapacityWithContext added in v1.37.32 

func (c *GameLift) DescribeFleetLocationCapacityWithContext(ctx aws.Context, input *DescribeFleetLocationCapacityInput, opts ...request.Option) (*DescribeFleetLocationCapacityOutput, error)

DescribeFleetLocationCapacityWithContext is the same as DescribeFleetLocationCapacity with the addition of the ability to pass a context and additional request options.

See DescribeFleetLocationCapacity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeFleetLocationUtilization added in v1.37.32 

func (c *GameLift) DescribeFleetLocationUtilization(input *DescribeFleetLocationUtilizationInput) (*DescribeFleetLocationUtilizationOutput, error)

DescribeFleetLocationUtilization API operation for Amazon GameLift.

Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).

To retrieve utilization data, identify a fleet and location.

If successful, a FleetUtilization object is returned for the requested fleet location.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-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 DescribeFleetLocationUtilization for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetLocationUtilization

func (*GameLift) DescribeFleetLocationUtilizationRequest added in v1.37.32 

func (c *GameLift) DescribeFleetLocationUtilizationRequest(input *DescribeFleetLocationUtilizationInput) (req *request.Request, output *DescribeFleetLocationUtilizationOutput)

DescribeFleetLocationUtilizationRequest generates a "aws/request.Request" representing the client's request for the DescribeFleetLocationUtilization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFleetLocationUtilization for more information on using the DescribeFleetLocationUtilization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetLocationUtilization

func (*GameLift) DescribeFleetLocationUtilizationWithContext added in v1.37.32 

func (c *GameLift) DescribeFleetLocationUtilizationWithContext(ctx aws.Context, input *DescribeFleetLocationUtilizationInput, opts ...request.Option) (*DescribeFleetLocationUtilizationOutput, error)

DescribeFleetLocationUtilizationWithContext is the same as DescribeFleetLocationUtilization with the addition of the ability to pass a context and additional request options.

See DescribeFleetLocationUtilization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeFleetPortSettings 

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

DescribeFleetPortSettings API operation for Amazon GameLift.

Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. To connect to game server processes on a container fleet, the port settings should include one or more of the fleet's connection ports.

Use this operation in the following ways:

  • To retrieve the port settings for a fleet, identify the fleet's unique identifier.

  • To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.

If successful, a set of IpPermission objects is returned for the requested fleet ID. When specifying a location, this operation returns a pending status. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetPortSettings

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFleetPortSettings for more information on using the DescribeFleetPortSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetPortSettings

func (*GameLift) DescribeFleetPortSettingsWithContext added in v1.8.0 

func (c *GameLift) DescribeFleetPortSettingsWithContext(ctx aws.Context, input *DescribeFleetPortSettingsInput, opts ...request.Option) (*DescribeFleetPortSettingsOutput, error)

DescribeFleetPortSettingsWithContext is the same as DescribeFleetPortSettings with the addition of the ability to pass a context and additional request options.

See DescribeFleetPortSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html) to get utilization statistics for a fleet's remote locations.

This operation can be used in the following ways:

  • To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.

  • To get utilization data for all fleets, do not provide a fleet identifier.

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetUtilization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_FleetUtilization.html) object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region.

Some API operations 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.

Learn more

Setting up Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

GameLift Metrics for Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-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 DescribeFleetUtilization for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetUtilization

func (*GameLift) DescribeFleetUtilizationPages added in v1.34.12 

func (c *GameLift) DescribeFleetUtilizationPages(input *DescribeFleetUtilizationInput, fn func(*DescribeFleetUtilizationOutput, bool) bool) error

DescribeFleetUtilizationPages iterates over the pages of a DescribeFleetUtilization operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeFleetUtilization method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeFleetUtilization operation.
pageNum := 0
err := client.DescribeFleetUtilizationPages(params,
    func(page *gamelift.DescribeFleetUtilizationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeFleetUtilizationPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeFleetUtilizationPagesWithContext(ctx aws.Context, input *DescribeFleetUtilizationInput, fn func(*DescribeFleetUtilizationOutput, bool) bool, opts ...request.Option) error

DescribeFleetUtilizationPagesWithContext same as DescribeFleetUtilizationPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFleetUtilization for more information on using the DescribeFleetUtilization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetUtilization

func (*GameLift) DescribeFleetUtilizationWithContext added in v1.8.0 

func (c *GameLift) DescribeFleetUtilizationWithContext(ctx aws.Context, input *DescribeFleetUtilizationInput, opts ...request.Option) (*DescribeFleetUtilizationOutput, error)

DescribeFleetUtilizationWithContext is the same as DescribeFleetUtilization with the addition of the ability to pass a context and additional request options.

See DescribeFleetUtilization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeGameServer added in v1.30.3 

func (c *GameLift) DescribeGameServer(input *DescribeGameServerInput) (*DescribeGameServerOutput, error)

DescribeGameServer API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.

To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 DescribeGameServer for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • UnauthorizedException The client failed authentication. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServer

func (*GameLift) DescribeGameServerGroup added in v1.30.3 

func (c *GameLift) DescribeGameServerGroup(input *DescribeGameServerGroupInput) (*DescribeGameServerGroupOutput, error)

DescribeGameServerGroup API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.

To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 DescribeGameServerGroup for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • UnauthorizedException The client failed authentication. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServerGroup

func (*GameLift) DescribeGameServerGroupRequest added in v1.30.3 

func (c *GameLift) DescribeGameServerGroupRequest(input *DescribeGameServerGroupInput) (req *request.Request, output *DescribeGameServerGroupOutput)

DescribeGameServerGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeGameServerGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGameServerGroup for more information on using the DescribeGameServerGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServerGroup

func (*GameLift) DescribeGameServerGroupWithContext added in v1.30.3 

func (c *GameLift) DescribeGameServerGroupWithContext(ctx aws.Context, input *DescribeGameServerGroupInput, opts ...request.Option) (*DescribeGameServerGroupOutput, error)

DescribeGameServerGroupWithContext is the same as DescribeGameServerGroup with the addition of the ability to pass a context and additional request options.

See DescribeGameServerGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeGameServerInstances added in v1.34.12 

func (c *GameLift) DescribeGameServerInstances(input *DescribeGameServerInstancesInput) (*DescribeGameServerInstancesOutput, error)

DescribeGameServerInstances API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.

To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned.

This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 DescribeGameServerInstances for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • UnauthorizedException The client failed authentication. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServerInstances

func (*GameLift) DescribeGameServerInstancesPages added in v1.34.12 

func (c *GameLift) DescribeGameServerInstancesPages(input *DescribeGameServerInstancesInput, fn func(*DescribeGameServerInstancesOutput, bool) bool) error

DescribeGameServerInstancesPages iterates over the pages of a DescribeGameServerInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeGameServerInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeGameServerInstances operation.
pageNum := 0
err := client.DescribeGameServerInstancesPages(params,
    func(page *gamelift.DescribeGameServerInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeGameServerInstancesPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeGameServerInstancesPagesWithContext(ctx aws.Context, input *DescribeGameServerInstancesInput, fn func(*DescribeGameServerInstancesOutput, bool) bool, opts ...request.Option) error

DescribeGameServerInstancesPagesWithContext same as DescribeGameServerInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeGameServerInstancesRequest added in v1.34.12 

func (c *GameLift) DescribeGameServerInstancesRequest(input *DescribeGameServerInstancesInput) (req *request.Request, output *DescribeGameServerInstancesOutput)

DescribeGameServerInstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeGameServerInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGameServerInstances for more information on using the DescribeGameServerInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServerInstances

func (*GameLift) DescribeGameServerInstancesWithContext added in v1.34.12 

func (c *GameLift) DescribeGameServerInstancesWithContext(ctx aws.Context, input *DescribeGameServerInstancesInput, opts ...request.Option) (*DescribeGameServerInstancesOutput, error)

DescribeGameServerInstancesWithContext is the same as DescribeGameServerInstances with the addition of the ability to pass a context and additional request options.

See DescribeGameServerInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeGameServerRequest added in v1.30.3 

func (c *GameLift) DescribeGameServerRequest(input *DescribeGameServerInput) (req *request.Request, output *DescribeGameServerOutput)

DescribeGameServerRequest generates a "aws/request.Request" representing the client's request for the DescribeGameServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGameServer for more information on using the DescribeGameServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServer

func (*GameLift) DescribeGameServerWithContext added in v1.30.3 

func (c *GameLift) DescribeGameServerWithContext(ctx aws.Context, input *DescribeGameServerInput, opts ...request.Option) (*DescribeGameServerOutput, error)

DescribeGameServerWithContext is the same as DescribeGameServer with the addition of the ability to pass a context and additional request options.

See DescribeGameServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeGameSessionDetails added in v1.1.10 

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

DescribeGameSessionDetails API operation for Amazon GameLift.

Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.

This operation can be used in the following ways:

  • To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.

  • To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.

  • To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSessionDetail object is returned for each game session that matches the request.

Learn more

Find a game session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionDetails

func (*GameLift) DescribeGameSessionDetailsPages added in v1.34.12 

func (c *GameLift) DescribeGameSessionDetailsPages(input *DescribeGameSessionDetailsInput, fn func(*DescribeGameSessionDetailsOutput, bool) bool) error

DescribeGameSessionDetailsPages iterates over the pages of a DescribeGameSessionDetails operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeGameSessionDetails method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeGameSessionDetails operation.
pageNum := 0
err := client.DescribeGameSessionDetailsPages(params,
    func(page *gamelift.DescribeGameSessionDetailsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeGameSessionDetailsPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeGameSessionDetailsPagesWithContext(ctx aws.Context, input *DescribeGameSessionDetailsInput, fn func(*DescribeGameSessionDetailsOutput, bool) bool, opts ...request.Option) error

DescribeGameSessionDetailsPagesWithContext same as DescribeGameSessionDetailsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGameSessionDetails for more information on using the DescribeGameSessionDetails API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionDetails

func (*GameLift) DescribeGameSessionDetailsWithContext added in v1.8.0 

func (c *GameLift) DescribeGameSessionDetailsWithContext(ctx aws.Context, input *DescribeGameSessionDetailsInput, opts ...request.Option) (*DescribeGameSessionDetailsOutput, error)

DescribeGameSessionDetailsWithContext is the same as DescribeGameSessionDetails with the addition of the ability to pass a context and additional request options.

See DescribeGameSessionDetails for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeGameSessionPlacement added in v1.6.27 

func (c *GameLift) DescribeGameSessionPlacement(input *DescribeGameSessionPlacementInput) (*DescribeGameSessionPlacementOutput, error)

DescribeGameSessionPlacement API operation for Amazon GameLift.

Retrieves information, including current status, about a game session placement request.

To get game session placement details, specify the placement ID.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.

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 DescribeGameSessionPlacement for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionPlacement

func (*GameLift) DescribeGameSessionPlacementRequest added in v1.6.27 

func (c *GameLift) DescribeGameSessionPlacementRequest(input *DescribeGameSessionPlacementInput) (req *request.Request, output *DescribeGameSessionPlacementOutput)

DescribeGameSessionPlacementRequest generates a "aws/request.Request" representing the client's request for the DescribeGameSessionPlacement operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGameSessionPlacement for more information on using the DescribeGameSessionPlacement API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionPlacement

func (*GameLift) DescribeGameSessionPlacementWithContext added in v1.8.0 

func (c *GameLift) DescribeGameSessionPlacementWithContext(ctx aws.Context, input *DescribeGameSessionPlacementInput, opts ...request.Option) (*DescribeGameSessionPlacementOutput, error)

DescribeGameSessionPlacementWithContext is the same as DescribeGameSessionPlacement with the addition of the ability to pass a context and additional request options.

See DescribeGameSessionPlacement for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeGameSessionQueues added in v1.6.27 

func (c *GameLift) DescribeGameSessionQueues(input *DescribeGameSessionQueuesInput) (*DescribeGameSessionQueuesOutput, error)

DescribeGameSessionQueues API operation for Amazon GameLift.

Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.

Learn more 

View Your Queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html)

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 DescribeGameSessionQueues for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionQueues

func (*GameLift) DescribeGameSessionQueuesPages added in v1.34.12 

func (c *GameLift) DescribeGameSessionQueuesPages(input *DescribeGameSessionQueuesInput, fn func(*DescribeGameSessionQueuesOutput, bool) bool) error

DescribeGameSessionQueuesPages iterates over the pages of a DescribeGameSessionQueues operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeGameSessionQueues method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeGameSessionQueues operation.
pageNum := 0
err := client.DescribeGameSessionQueuesPages(params,
    func(page *gamelift.DescribeGameSessionQueuesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeGameSessionQueuesPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeGameSessionQueuesPagesWithContext(ctx aws.Context, input *DescribeGameSessionQueuesInput, fn func(*DescribeGameSessionQueuesOutput, bool) bool, opts ...request.Option) error

DescribeGameSessionQueuesPagesWithContext same as DescribeGameSessionQueuesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeGameSessionQueuesRequest added in v1.6.27 

func (c *GameLift) DescribeGameSessionQueuesRequest(input *DescribeGameSessionQueuesInput) (req *request.Request, output *DescribeGameSessionQueuesOutput)

DescribeGameSessionQueuesRequest generates a "aws/request.Request" representing the client's request for the DescribeGameSessionQueues operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGameSessionQueues for more information on using the DescribeGameSessionQueues API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionQueues

func (*GameLift) DescribeGameSessionQueuesWithContext added in v1.8.0 

func (c *GameLift) DescribeGameSessionQueuesWithContext(ctx aws.Context, input *DescribeGameSessionQueuesInput, opts ...request.Option) (*DescribeGameSessionQueuesOutput, error)

DescribeGameSessionQueuesWithContext is the same as DescribeGameSessionQueues with the addition of the ability to pass a context and additional request options.

See DescribeGameSessionQueues for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 in a specific fleet location. You can optionally filter the results by current game session status.

This operation can be used in the following ways:

  • To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.

  • To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.

  • To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSession object is returned for each game session that matches the request.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessions should only be used for games in development with low game session usage.

Available in Amazon GameLift Local.

Learn more

Find a game session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessions

func (*GameLift) DescribeGameSessionsPages added in v1.34.12 

func (c *GameLift) DescribeGameSessionsPages(input *DescribeGameSessionsInput, fn func(*DescribeGameSessionsOutput, bool) bool) error

DescribeGameSessionsPages iterates over the pages of a DescribeGameSessions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeGameSessions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeGameSessions operation.
pageNum := 0
err := client.DescribeGameSessionsPages(params,
    func(page *gamelift.DescribeGameSessionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeGameSessionsPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeGameSessionsPagesWithContext(ctx aws.Context, input *DescribeGameSessionsInput, fn func(*DescribeGameSessionsOutput, bool) bool, opts ...request.Option) error

DescribeGameSessionsPagesWithContext same as DescribeGameSessionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGameSessions for more information on using the DescribeGameSessions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessions

func (*GameLift) DescribeGameSessionsWithContext added in v1.8.0 

func (c *GameLift) DescribeGameSessionsWithContext(ctx aws.Context, input *DescribeGameSessionsInput, opts ...request.Option) (*DescribeGameSessionsOutput, error)

DescribeGameSessionsWithContext is the same as DescribeGameSessions with the addition of the ability to pass a context and additional request options.

See DescribeGameSessions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeInstances added in v1.4.17 

func (c *GameLift) DescribeInstances(input *DescribeInstancesInput) (*DescribeInstancesOutput, error)

DescribeInstances API operation for Amazon GameLift.

Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations ListCompute and DescribeCompute to retrieve information for compute resources, including EC2 and Anywhere fleets.

You can call this operation in the following ways:

  • To get information on all instances in a fleet's home Region, specify the fleet ID.

  • To get information on all instances in a fleet's remote location, specify the fleet ID and location name.

  • To get information on a specific instance in a fleet, specify the fleet ID and instance ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, this operation returns Instance objects for each requested instance, listed in no particular order. If you call this operation for an Anywhere fleet, you receive an InvalidRequestException.

Learn more

Remotely connect to fleet instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html)

Debug fleet issues (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeInstances

func (*GameLift) DescribeInstancesPages added in v1.34.12 

func (c *GameLift) DescribeInstancesPages(input *DescribeInstancesInput, fn func(*DescribeInstancesOutput, bool) bool) error

DescribeInstancesPages iterates over the pages of a DescribeInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeInstances operation.
pageNum := 0
err := client.DescribeInstancesPages(params,
    func(page *gamelift.DescribeInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeInstancesPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeInstancesPagesWithContext(ctx aws.Context, input *DescribeInstancesInput, fn func(*DescribeInstancesOutput, bool) bool, opts ...request.Option) error

DescribeInstancesPagesWithContext same as DescribeInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeInstancesRequest added in v1.4.17 

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeInstances for more information on using the DescribeInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeInstances

func (*GameLift) DescribeInstancesWithContext added in v1.8.0 

func (c *GameLift) DescribeInstancesWithContext(ctx aws.Context, input *DescribeInstancesInput, opts ...request.Option) (*DescribeInstancesOutput, error)

DescribeInstancesWithContext is the same as DescribeInstances with the addition of the ability to pass a context and additional request options.

See DescribeInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeMatchmaking added in v1.10.27 

func (c *GameLift) DescribeMatchmaking(input *DescribeMatchmakingInput) (*DescribeMatchmakingOutput, error)

DescribeMatchmaking API operation for Amazon GameLift.

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session.

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.

This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration.

Learn more 

Add FlexMatch to a game client (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html)

Set Up FlexMatch event notification (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html)

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 DescribeMatchmaking for usage and error information.

Returned Error Types:

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmaking

func (*GameLift) DescribeMatchmakingConfigurations added in v1.10.27 

func (c *GameLift) DescribeMatchmakingConfigurations(input *DescribeMatchmakingConfigurationsInput) (*DescribeMatchmakingConfigurationsOutput, error)

DescribeMatchmakingConfigurations API operation for Amazon GameLift.

Retrieves the details of FlexMatch matchmaking configurations.

This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

Learn more 

Setting up FlexMatch matchmakers (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html)

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 DescribeMatchmakingConfigurations for usage and error information.

Returned Error Types:

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingConfigurations

func (*GameLift) DescribeMatchmakingConfigurationsPages added in v1.34.12 

func (c *GameLift) DescribeMatchmakingConfigurationsPages(input *DescribeMatchmakingConfigurationsInput, fn func(*DescribeMatchmakingConfigurationsOutput, bool) bool) error

DescribeMatchmakingConfigurationsPages iterates over the pages of a DescribeMatchmakingConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeMatchmakingConfigurations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeMatchmakingConfigurations operation.
pageNum := 0
err := client.DescribeMatchmakingConfigurationsPages(params,
    func(page *gamelift.DescribeMatchmakingConfigurationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeMatchmakingConfigurationsPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeMatchmakingConfigurationsPagesWithContext(ctx aws.Context, input *DescribeMatchmakingConfigurationsInput, fn func(*DescribeMatchmakingConfigurationsOutput, bool) bool, opts ...request.Option) error

DescribeMatchmakingConfigurationsPagesWithContext same as DescribeMatchmakingConfigurationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeMatchmakingConfigurationsRequest added in v1.10.27 

func (c *GameLift) DescribeMatchmakingConfigurationsRequest(input *DescribeMatchmakingConfigurationsInput) (req *request.Request, output *DescribeMatchmakingConfigurationsOutput)

DescribeMatchmakingConfigurationsRequest generates a "aws/request.Request" representing the client's request for the DescribeMatchmakingConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMatchmakingConfigurations for more information on using the DescribeMatchmakingConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingConfigurations

func (*GameLift) DescribeMatchmakingConfigurationsWithContext added in v1.10.27 

func (c *GameLift) DescribeMatchmakingConfigurationsWithContext(ctx aws.Context, input *DescribeMatchmakingConfigurationsInput, opts ...request.Option) (*DescribeMatchmakingConfigurationsOutput, error)

DescribeMatchmakingConfigurationsWithContext is the same as DescribeMatchmakingConfigurations with the addition of the ability to pass a context and additional request options.

See DescribeMatchmakingConfigurations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeMatchmakingRequest added in v1.10.27 

func (c *GameLift) DescribeMatchmakingRequest(input *DescribeMatchmakingInput) (req *request.Request, output *DescribeMatchmakingOutput)

DescribeMatchmakingRequest generates a "aws/request.Request" representing the client's request for the DescribeMatchmaking operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMatchmaking for more information on using the DescribeMatchmaking API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmaking

func (*GameLift) DescribeMatchmakingRuleSets added in v1.10.27 

func (c *GameLift) DescribeMatchmakingRuleSets(input *DescribeMatchmakingRuleSetsInput) (*DescribeMatchmakingRuleSetsOutput, error)

DescribeMatchmakingRuleSets API operation for Amazon GameLift.

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.

Learn more

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 DescribeMatchmakingRuleSets for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingRuleSets

func (*GameLift) DescribeMatchmakingRuleSetsPages added in v1.34.12 

func (c *GameLift) DescribeMatchmakingRuleSetsPages(input *DescribeMatchmakingRuleSetsInput, fn func(*DescribeMatchmakingRuleSetsOutput, bool) bool) error

DescribeMatchmakingRuleSetsPages iterates over the pages of a DescribeMatchmakingRuleSets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeMatchmakingRuleSets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeMatchmakingRuleSets operation.
pageNum := 0
err := client.DescribeMatchmakingRuleSetsPages(params,
    func(page *gamelift.DescribeMatchmakingRuleSetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeMatchmakingRuleSetsPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeMatchmakingRuleSetsPagesWithContext(ctx aws.Context, input *DescribeMatchmakingRuleSetsInput, fn func(*DescribeMatchmakingRuleSetsOutput, bool) bool, opts ...request.Option) error

DescribeMatchmakingRuleSetsPagesWithContext same as DescribeMatchmakingRuleSetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeMatchmakingRuleSetsRequest added in v1.10.27 

func (c *GameLift) DescribeMatchmakingRuleSetsRequest(input *DescribeMatchmakingRuleSetsInput) (req *request.Request, output *DescribeMatchmakingRuleSetsOutput)

DescribeMatchmakingRuleSetsRequest generates a "aws/request.Request" representing the client's request for the DescribeMatchmakingRuleSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMatchmakingRuleSets for more information on using the DescribeMatchmakingRuleSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingRuleSets

func (*GameLift) DescribeMatchmakingRuleSetsWithContext added in v1.10.27 

func (c *GameLift) DescribeMatchmakingRuleSetsWithContext(ctx aws.Context, input *DescribeMatchmakingRuleSetsInput, opts ...request.Option) (*DescribeMatchmakingRuleSetsOutput, error)

DescribeMatchmakingRuleSetsWithContext is the same as DescribeMatchmakingRuleSets with the addition of the ability to pass a context and additional request options.

See DescribeMatchmakingRuleSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeMatchmakingWithContext added in v1.10.27 

func (c *GameLift) DescribeMatchmakingWithContext(ctx aws.Context, input *DescribeMatchmakingInput, opts ...request.Option) (*DescribeMatchmakingOutput, error)

DescribeMatchmakingWithContext is the same as DescribeMatchmaking with the addition of the ability to pass a context and additional request options.

See DescribeMatchmaking for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 the following ways:

  • To retrieve a specific player session, provide the player session ID only.

  • To retrieve all player sessions in a game session, provide the game session ID only.

  • To retrieve all player sessions for a specific player, provide a player ID only.

To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. If you provide a specific PlayerSessionId or PlayerId, Amazon GameLift ignores the filter criteria. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a PlayerSession object is returned for each session that matches the request.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribePlayerSessions

func (*GameLift) DescribePlayerSessionsPages added in v1.34.12 

func (c *GameLift) DescribePlayerSessionsPages(input *DescribePlayerSessionsInput, fn func(*DescribePlayerSessionsOutput, bool) bool) error

DescribePlayerSessionsPages iterates over the pages of a DescribePlayerSessions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribePlayerSessions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribePlayerSessions operation.
pageNum := 0
err := client.DescribePlayerSessionsPages(params,
    func(page *gamelift.DescribePlayerSessionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribePlayerSessionsPagesWithContext added in v1.34.12 

func (c *GameLift) DescribePlayerSessionsPagesWithContext(ctx aws.Context, input *DescribePlayerSessionsInput, fn func(*DescribePlayerSessionsOutput, bool) bool, opts ...request.Option) error

DescribePlayerSessionsPagesWithContext same as DescribePlayerSessionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePlayerSessions for more information on using the DescribePlayerSessions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribePlayerSessions

func (*GameLift) DescribePlayerSessionsWithContext added in v1.8.0 

func (c *GameLift) DescribePlayerSessionsWithContext(ctx aws.Context, input *DescribePlayerSessionsInput, opts ...request.Option) (*DescribePlayerSessionsOutput, error)

DescribePlayerSessionsWithContext is the same as DescribePlayerSessions with the addition of the ability to pass a context and additional request options.

See DescribePlayerSessions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeRuntimeConfiguration added in v1.2.1 

func (c *GameLift) DescribeRuntimeConfiguration(input *DescribeRuntimeConfigurationInput) (*DescribeRuntimeConfigurationOutput, error)

DescribeRuntimeConfiguration API operation for Amazon GameLift.

Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the runtime configuration describes server processes that run on each fleet instance. For container fleets, the runtime configuration describes server processes that run in each replica container group. You can update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration.

To get the current runtime configuration for a fleet, provide the fleet ID.

If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

Running multiple processes on a fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeRuntimeConfiguration

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRuntimeConfiguration for more information on using the DescribeRuntimeConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeRuntimeConfiguration

func (*GameLift) DescribeRuntimeConfigurationWithContext added in v1.8.0 

func (c *GameLift) DescribeRuntimeConfigurationWithContext(ctx aws.Context, input *DescribeRuntimeConfigurationInput, opts ...request.Option) (*DescribeRuntimeConfigurationOutput, error)

DescribeRuntimeConfigurationWithContext is the same as DescribeRuntimeConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeRuntimeConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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.

A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE.

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeScalingPolicies

func (*GameLift) DescribeScalingPoliciesPages added in v1.34.12 

func (c *GameLift) DescribeScalingPoliciesPages(input *DescribeScalingPoliciesInput, fn func(*DescribeScalingPoliciesOutput, bool) bool) error

DescribeScalingPoliciesPages iterates over the pages of a DescribeScalingPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeScalingPolicies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeScalingPolicies operation.
pageNum := 0
err := client.DescribeScalingPoliciesPages(params,
    func(page *gamelift.DescribeScalingPoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) DescribeScalingPoliciesPagesWithContext added in v1.34.12 

func (c *GameLift) DescribeScalingPoliciesPagesWithContext(ctx aws.Context, input *DescribeScalingPoliciesInput, fn func(*DescribeScalingPoliciesOutput, bool) bool, opts ...request.Option) error

DescribeScalingPoliciesPagesWithContext same as DescribeScalingPoliciesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeScalingPolicies for more information on using the DescribeScalingPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeScalingPolicies

func (*GameLift) DescribeScalingPoliciesWithContext added in v1.8.0 

func (c *GameLift) DescribeScalingPoliciesWithContext(ctx aws.Context, input *DescribeScalingPoliciesInput, opts ...request.Option) (*DescribeScalingPoliciesOutput, error)

DescribeScalingPoliciesWithContext is the same as DescribeScalingPolicies with the addition of the ability to pass a context and additional request options.

See DescribeScalingPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeScript added in v1.19.18 

func (c *GameLift) DescribeScript(input *DescribeScriptInput) (*DescribeScriptOutput, error)

DescribeScript API operation for Amazon GameLift.

Retrieves properties for a Realtime script.

To request a script record, specify the script ID. If successful, an object containing the script properties is returned.

Learn more

Amazon GameLift Realtime Servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 DescribeScript for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeScript

func (*GameLift) DescribeScriptRequest added in v1.19.18 

func (c *GameLift) DescribeScriptRequest(input *DescribeScriptInput) (req *request.Request, output *DescribeScriptOutput)

DescribeScriptRequest generates a "aws/request.Request" representing the client's request for the DescribeScript operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeScript for more information on using the DescribeScript API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeScript

func (*GameLift) DescribeScriptWithContext added in v1.19.18 

func (c *GameLift) DescribeScriptWithContext(ctx aws.Context, input *DescribeScriptInput, opts ...request.Option) (*DescribeScriptOutput, error)

DescribeScriptWithContext is the same as DescribeScript with the addition of the ability to pass a context and additional request options.

See DescribeScript for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeVpcPeeringAuthorizations added in v1.10.37 

func (c *GameLift) DescribeVpcPeeringAuthorizations(input *DescribeVpcPeeringAuthorizationsInput) (*DescribeVpcPeeringAuthorizationsOutput, error)

DescribeVpcPeeringAuthorizations API operation for Amazon GameLift.

Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 DescribeVpcPeeringAuthorizations for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeVpcPeeringAuthorizations

func (*GameLift) DescribeVpcPeeringAuthorizationsRequest added in v1.10.37 

func (c *GameLift) DescribeVpcPeeringAuthorizationsRequest(input *DescribeVpcPeeringAuthorizationsInput) (req *request.Request, output *DescribeVpcPeeringAuthorizationsOutput)

DescribeVpcPeeringAuthorizationsRequest generates a "aws/request.Request" representing the client's request for the DescribeVpcPeeringAuthorizations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeVpcPeeringAuthorizations for more information on using the DescribeVpcPeeringAuthorizations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeVpcPeeringAuthorizations

func (*GameLift) DescribeVpcPeeringAuthorizationsWithContext added in v1.10.37 

func (c *GameLift) DescribeVpcPeeringAuthorizationsWithContext(ctx aws.Context, input *DescribeVpcPeeringAuthorizationsInput, opts ...request.Option) (*DescribeVpcPeeringAuthorizationsOutput, error)

DescribeVpcPeeringAuthorizationsWithContext is the same as DescribeVpcPeeringAuthorizations with the addition of the ability to pass a context and additional request options.

See DescribeVpcPeeringAuthorizations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) DescribeVpcPeeringConnections added in v1.10.37 

func (c *GameLift) DescribeVpcPeeringConnections(input *DescribeVpcPeeringConnectionsInput) (*DescribeVpcPeeringConnectionsOutput, error)

DescribeVpcPeeringConnections API operation for Amazon GameLift.

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 DescribeVpcPeeringConnections for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeVpcPeeringConnections

func (*GameLift) DescribeVpcPeeringConnectionsRequest added in v1.10.37 

func (c *GameLift) DescribeVpcPeeringConnectionsRequest(input *DescribeVpcPeeringConnectionsInput) (req *request.Request, output *DescribeVpcPeeringConnectionsOutput)

DescribeVpcPeeringConnectionsRequest generates a "aws/request.Request" representing the client's request for the DescribeVpcPeeringConnections operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeVpcPeeringConnections for more information on using the DescribeVpcPeeringConnections API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeVpcPeeringConnections

func (*GameLift) DescribeVpcPeeringConnectionsWithContext added in v1.10.37 

func (c *GameLift) DescribeVpcPeeringConnectionsWithContext(ctx aws.Context, input *DescribeVpcPeeringConnectionsInput, opts ...request.Option) (*DescribeVpcPeeringConnectionsOutput, error)

DescribeVpcPeeringConnectionsWithContext is the same as DescribeVpcPeeringConnections with the addition of the ability to pass a context and additional request options.

See DescribeVpcPeeringConnections for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) GetComputeAccess added in v1.44.151 

func (c *GameLift) GetComputeAccess(input *GetComputeAccessInput) (*GetComputeAccessOutput, error)

GetComputeAccess API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet. This operation is not used with Amazon GameLift Anywhere fleets

To request access, specify the compute name and the fleet ID. If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token.

EC2 fleets

With an EC2 fleet (where compute type is EC2), use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html#sessions-start-cli) in the Amazon EC2 Systems Manager User Guide.

Container fleets

With a container fleet (where compute type is CONTAINER), use these credentials and the target value with SSM to connect to the fleet instance where the container is running. After you're connected to the instance, use Docker commands to interact with the container.

Learn more

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 GetComputeAccess for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccess

func (*GameLift) GetComputeAccessRequest added in v1.44.151 

func (c *GameLift) GetComputeAccessRequest(input *GetComputeAccessInput) (req *request.Request, output *GetComputeAccessOutput)

GetComputeAccessRequest generates a "aws/request.Request" representing the client's request for the GetComputeAccess operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetComputeAccess for more information on using the GetComputeAccess API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccess

func (*GameLift) GetComputeAccessWithContext added in v1.44.151 

func (c *GameLift) GetComputeAccessWithContext(ctx aws.Context, input *GetComputeAccessInput, opts ...request.Option) (*GetComputeAccessOutput, error)

GetComputeAccessWithContext is the same as GetComputeAccess with the addition of the ability to pass a context and additional request options.

See GetComputeAccess for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) GetComputeAuthToken added in v1.44.151 

func (c *GameLift) GetComputeAuthToken(input *GetComputeAuthTokenInput) (*GetComputeAuthTokenOutput, error)

GetComputeAuthToken API operation for Amazon GameLift.

Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift Anywhere fleet or container fleet. Game servers that are running on the compute use this token to communicate with the Amazon GameLift service, such as when calling the Amazon GameLift server SDK action InitSDK(). Authentication tokens are valid for a limited time span, so you need to request a fresh token before the current token expires.

Use this operation based on the fleet compute type:

  • For EC2 fleets, auth token retrieval and refresh is handled automatically. All game servers that are running on all fleet instances have access to a valid auth token.

  • For ANYWHERE and CONTAINER fleets, if you're using the Amazon GameLift Agent, auth token retrieval and refresh is handled automatically for any container or Anywhere compute where the Agent is running. If you're not using the Agent, create a mechanism to retrieve and refresh auth tokens for computes that are running game server processes.

Learn more

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 GetComputeAuthToken for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAuthToken

func (*GameLift) GetComputeAuthTokenRequest added in v1.44.151 

func (c *GameLift) GetComputeAuthTokenRequest(input *GetComputeAuthTokenInput) (req *request.Request, output *GetComputeAuthTokenOutput)

GetComputeAuthTokenRequest generates a "aws/request.Request" representing the client's request for the GetComputeAuthToken operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetComputeAuthToken for more information on using the GetComputeAuthToken API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAuthToken

func (*GameLift) GetComputeAuthTokenWithContext added in v1.44.151 

func (c *GameLift) GetComputeAuthTokenWithContext(ctx aws.Context, input *GetComputeAuthTokenInput, opts ...request.Option) (*GetComputeAuthTokenOutput, error)

GetComputeAuthTokenWithContext is the same as GetComputeAuthToken with the addition of the ability to pass a context and additional request options.

See GetComputeAuthToken for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 on Amazon GameLift managed fleets. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.

See the Amazon Web Services Service Limits (https://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.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetGameSessionLogUrl

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetGameSessionLogUrl for more information on using the GetGameSessionLogUrl API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetGameSessionLogUrl

func (*GameLift) GetGameSessionLogUrlWithContext added in v1.8.0 

func (c *GameLift) GetGameSessionLogUrlWithContext(ctx aws.Context, input *GetGameSessionLogUrlInput, opts ...request.Option) (*GetGameSessionLogUrlOutput, error)

GetGameSessionLogUrlWithContext is the same as GetGameSessionLogUrl with the addition of the ability to pass a context and additional request options.

See GetGameSessionLogUrl for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) GetInstanceAccess added in v1.5.8 

func (c *GameLift) GetInstanceAccess(input *GetInstanceAccessInput) (*GetInstanceAccessOutput, error)

GetInstanceAccess API operation for Amazon GameLift.

Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call GetComputeAccess.

To request access to an instance, specify IDs for the instance and the fleet it belongs to. You can retrieve instance IDs for a fleet by calling DescribeInstances (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html) with the fleet ID.

If successful, this operation returns an IP address and credentials. The returned credentials match the operating system of the instance, as follows:

Learn more

Remotely connect to fleet instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html)

Debug fleet issues (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetInstanceAccess

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceAccess for more information on using the GetInstanceAccess API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetInstanceAccess

func (*GameLift) GetInstanceAccessWithContext added in v1.8.0 

func (c *GameLift) GetInstanceAccessWithContext(ctx aws.Context, input *GetInstanceAccessInput, opts ...request.Option) (*GetInstanceAccessOutput, error)

GetInstanceAccessWithContext is the same as GetInstanceAccess with the addition of the ability to pass a context and additional request options.

See GetInstanceAccess for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListAliases 

func (c *GameLift) ListAliases(input *ListAliasesInput) (*ListAliasesOutput, error)

ListAliases API operation for Amazon GameLift.

Retrieves all aliases for this Amazon Web Services 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.

Returned aliases are not listed in any particular order.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListAliases

func (*GameLift) ListAliasesPages added in v1.34.12 

func (c *GameLift) ListAliasesPages(input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool) error

ListAliasesPages iterates over the pages of a ListAliases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAliases method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAliases operation.
pageNum := 0
err := client.ListAliasesPages(params,
    func(page *gamelift.ListAliasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) ListAliasesPagesWithContext added in v1.34.12 

func (c *GameLift) ListAliasesPagesWithContext(ctx aws.Context, input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool, opts ...request.Option) error

ListAliasesPagesWithContext same as ListAliasesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAliases for more information on using the ListAliases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListAliases

func (*GameLift) ListAliasesWithContext added in v1.8.0 

func (c *GameLift) ListAliasesWithContext(ctx aws.Context, input *ListAliasesInput, opts ...request.Option) (*ListAliasesOutput, error)

ListAliasesWithContext is the same as ListAliases with the addition of the ability to pass a context and additional request options.

See ListAliases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListBuilds 

func (c *GameLift) ListBuilds(input *ListBuildsInput) (*ListBuildsOutput, error)

ListBuilds API operation for Amazon GameLift.

Retrieves build resources for all builds associated with the Amazon Web Services 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 resources are not listed in any particular order.

Learn more 

Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListBuilds

func (*GameLift) ListBuildsPages added in v1.34.12 

func (c *GameLift) ListBuildsPages(input *ListBuildsInput, fn func(*ListBuildsOutput, bool) bool) error

ListBuildsPages iterates over the pages of a ListBuilds operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBuilds method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListBuilds operation.
pageNum := 0
err := client.ListBuildsPages(params,
    func(page *gamelift.ListBuildsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) ListBuildsPagesWithContext added in v1.34.12 

func (c *GameLift) ListBuildsPagesWithContext(ctx aws.Context, input *ListBuildsInput, fn func(*ListBuildsOutput, bool) bool, opts ...request.Option) error

ListBuildsPagesWithContext same as ListBuildsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBuilds for more information on using the ListBuilds API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListBuilds

func (*GameLift) ListBuildsWithContext added in v1.8.0 

func (c *GameLift) ListBuildsWithContext(ctx aws.Context, input *ListBuildsInput, opts ...request.Option) (*ListBuildsOutput, error)

ListBuildsWithContext is the same as ListBuilds with the addition of the ability to pass a context and additional request options.

See ListBuilds for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListCompute added in v1.44.151 

func (c *GameLift) ListCompute(input *ListComputeInput) (*ListComputeOutput, error)

ListCompute API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves information on the compute resources in an Amazon GameLift fleet.

To request a list of computes, specify the fleet ID. Use the pagination parameters to retrieve results in a set of sequential pages.

You can filter the result set by location.

If successful, this operation returns information on all computes in the requested fleet. Depending on the fleet's compute type, the result includes the following information:

  • For EC2 fleets, this operation returns information about the EC2 instance. Compute names are instance IDs.

  • For ANYWHERE fleets, this operation returns the compute names and details provided when the compute was registered with RegisterCompute. The GameLiftServiceSdkEndpoint or GameLiftAgentEndpoint is included.

  • For CONTAINER fleets, this operation returns information about containers that are registered as computes, and the instances they're running on. Compute names are container names.

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 ListCompute for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListCompute

func (*GameLift) ListComputePages added in v1.44.151 

func (c *GameLift) ListComputePages(input *ListComputeInput, fn func(*ListComputeOutput, bool) bool) error

ListComputePages iterates over the pages of a ListCompute operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCompute method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListCompute operation.
pageNum := 0
err := client.ListComputePages(params,
    func(page *gamelift.ListComputeOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) ListComputePagesWithContext added in v1.44.151 

func (c *GameLift) ListComputePagesWithContext(ctx aws.Context, input *ListComputeInput, fn func(*ListComputeOutput, bool) bool, opts ...request.Option) error

ListComputePagesWithContext same as ListComputePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListComputeRequest added in v1.44.151 

func (c *GameLift) ListComputeRequest(input *ListComputeInput) (req *request.Request, output *ListComputeOutput)

ListComputeRequest generates a "aws/request.Request" representing the client's request for the ListCompute operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCompute for more information on using the ListCompute API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListCompute

func (*GameLift) ListComputeWithContext added in v1.44.151 

func (c *GameLift) ListComputeWithContext(ctx aws.Context, input *ListComputeInput, opts ...request.Option) (*ListComputeOutput, error)

ListComputeWithContext is the same as ListCompute with the addition of the ability to pass a context and additional request options.

See ListCompute for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListContainerGroupDefinitions added in v1.51.28 

func (c *GameLift) ListContainerGroupDefinitions(input *ListContainerGroupDefinitionsInput) (*ListContainerGroupDefinitionsOutput, error)

ListContainerGroupDefinitions API operation for Amazon GameLift.

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves all container group definitions for the Amazon Web Services account and Amazon Web Services Region that are currently in use. You can filter the result set by the container groups' scheduling strategy. Use the pagination parameters to retrieve results in a set of sequential pages.

This operation returns the list of container group definitions in no particular order.

Learn more

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 ListContainerGroupDefinitions for usage and error information.

Returned Error Types:

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListContainerGroupDefinitions

func (*GameLift) ListContainerGroupDefinitionsPages added in v1.51.28 

func (c *GameLift) ListContainerGroupDefinitionsPages(input *ListContainerGroupDefinitionsInput, fn func(*ListContainerGroupDefinitionsOutput, bool) bool) error

ListContainerGroupDefinitionsPages iterates over the pages of a ListContainerGroupDefinitions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListContainerGroupDefinitions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListContainerGroupDefinitions operation.
pageNum := 0
err := client.ListContainerGroupDefinitionsPages(params,
    func(page *gamelift.ListContainerGroupDefinitionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) ListContainerGroupDefinitionsPagesWithContext added in v1.51.28 

func (c *GameLift) ListContainerGroupDefinitionsPagesWithContext(ctx aws.Context, input *ListContainerGroupDefinitionsInput, fn func(*ListContainerGroupDefinitionsOutput, bool) bool, opts ...request.Option) error

ListContainerGroupDefinitionsPagesWithContext same as ListContainerGroupDefinitionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListContainerGroupDefinitionsRequest added in v1.51.28 

func (c *GameLift) ListContainerGroupDefinitionsRequest(input *ListContainerGroupDefinitionsInput) (req *request.Request, output *ListContainerGroupDefinitionsOutput)

ListContainerGroupDefinitionsRequest generates a "aws/request.Request" representing the client's request for the ListContainerGroupDefinitions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListContainerGroupDefinitions for more information on using the ListContainerGroupDefinitions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListContainerGroupDefinitions

func (*GameLift) ListContainerGroupDefinitionsWithContext added in v1.51.28 

func (c *GameLift) ListContainerGroupDefinitionsWithContext(ctx aws.Context, input *ListContainerGroupDefinitionsInput, opts ...request.Option) (*ListContainerGroupDefinitionsOutput, error)

ListContainerGroupDefinitionsWithContext is the same as ListContainerGroupDefinitions with the addition of the ability to pass a context and additional request options.

See ListContainerGroupDefinitions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListFleets 

func (c *GameLift) ListFleets(input *ListFleetsInput) (*ListFleetsOutput, error)

ListFleets API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.

You can use operation in the following ways:

  • To get a list of all fleets in a Region, don't provide a build or script identifier.

  • To get a list of all fleets where a specific game build is deployed, provide the build ID.

  • To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.

  • To get a list of all fleets with a specific container group definition, provide the ContainerGroupDefinition ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, this operation returns a list of fleet IDs that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve.

Fleet IDs are returned in no 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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListFleets

func (*GameLift) ListFleetsPages added in v1.34.12 

func (c *GameLift) ListFleetsPages(input *ListFleetsInput, fn func(*ListFleetsOutput, bool) bool) error

ListFleetsPages iterates over the pages of a ListFleets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFleets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListFleets operation.
pageNum := 0
err := client.ListFleetsPages(params,
    func(page *gamelift.ListFleetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) ListFleetsPagesWithContext added in v1.34.12 

func (c *GameLift) ListFleetsPagesWithContext(ctx aws.Context, input *ListFleetsInput, fn func(*ListFleetsOutput, bool) bool, opts ...request.Option) error

ListFleetsPagesWithContext same as ListFleetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFleets for more information on using the ListFleets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListFleets

func (*GameLift) ListFleetsWithContext added in v1.8.0 

func (c *GameLift) ListFleetsWithContext(ctx aws.Context, input *ListFleetsInput, opts ...request.Option) (*ListFleetsOutput, error)

ListFleetsWithContext is the same as ListFleets with the addition of the ability to pass a context and additional request options.

See ListFleets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListGameServerGroups added in v1.30.3 

func (c *GameLift) ListGameServerGroups(input *ListGameServerGroupsInput) (*ListGameServerGroupsOutput, error)

ListGameServerGroups API operation for Amazon GameLift.

Lists a game server groups.

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 ListGameServerGroups for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServerGroups

func (*GameLift) ListGameServerGroupsPages added in v1.34.12 

func (c *GameLift) ListGameServerGroupsPages(input *ListGameServerGroupsInput, fn func(*ListGameServerGroupsOutput, bool) bool) error

ListGameServerGroupsPages iterates over the pages of a ListGameServerGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGameServerGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListGameServerGroups operation.
pageNum := 0
err := client.ListGameServerGroupsPages(params,
    func(page *gamelift.ListGameServerGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) ListGameServerGroupsPagesWithContext added in v1.34.12 

func (c *GameLift) ListGameServerGroupsPagesWithContext(ctx aws.Context, input *ListGameServerGroupsInput, fn func(*ListGameServerGroupsOutput, bool) bool, opts ...request.Option) error

ListGameServerGroupsPagesWithContext same as ListGameServerGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListGameServerGroupsRequest added in v1.30.3 

func (c *GameLift) ListGameServerGroupsRequest(input *ListGameServerGroupsInput) (req *request.Request, output *ListGameServerGroupsOutput)

ListGameServerGroupsRequest generates a "aws/request.Request" representing the client's request for the ListGameServerGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGameServerGroups for more information on using the ListGameServerGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServerGroups

func (*GameLift) ListGameServerGroupsWithContext added in v1.30.3 

func (c *GameLift) ListGameServerGroupsWithContext(ctx aws.Context, input *ListGameServerGroupsInput, opts ...request.Option) (*ListGameServerGroupsOutput, error)

ListGameServerGroupsWithContext is the same as ListGameServerGroups with the addition of the ability to pass a context and additional request options.

See ListGameServerGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListGameServers added in v1.30.3 

func (c *GameLift) ListGameServers(input *ListGameServersInput) (*ListGameServersOutput, error)

ListGameServers API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 ListGameServers for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServers

func (*GameLift) ListGameServersPages added in v1.34.12 

func (c *GameLift) ListGameServersPages(input *ListGameServersInput, fn func(*ListGameServersOutput, bool) bool) error

ListGameServersPages iterates over the pages of a ListGameServers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGameServers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListGameServers operation.
pageNum := 0
err := client.ListGameServersPages(params,
    func(page *gamelift.ListGameServersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) ListGameServersPagesWithContext added in v1.34.12 

func (c *GameLift) ListGameServersPagesWithContext(ctx aws.Context, input *ListGameServersInput, fn func(*ListGameServersOutput, bool) bool, opts ...request.Option) error

ListGameServersPagesWithContext same as ListGameServersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListGameServersRequest added in v1.30.3 

func (c *GameLift) ListGameServersRequest(input *ListGameServersInput) (req *request.Request, output *ListGameServersOutput)

ListGameServersRequest generates a "aws/request.Request" representing the client's request for the ListGameServers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGameServers for more information on using the ListGameServers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServers

func (*GameLift) ListGameServersWithContext added in v1.30.3 

func (c *GameLift) ListGameServersWithContext(ctx aws.Context, input *ListGameServersInput, opts ...request.Option) (*ListGameServersOutput, error)

ListGameServersWithContext is the same as ListGameServers with the addition of the ability to pass a context and additional request options.

See ListGameServers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListLocations added in v1.44.151 

func (c *GameLift) ListLocations(input *ListLocationsInput) (*ListLocationsOutput, error)

ListLocations API operation for Amazon GameLift.

Lists all custom and Amazon Web Services locations.

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 ListLocations for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListLocations

func (*GameLift) ListLocationsPages added in v1.44.151 

func (c *GameLift) ListLocationsPages(input *ListLocationsInput, fn func(*ListLocationsOutput, bool) bool) error

ListLocationsPages iterates over the pages of a ListLocations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListLocations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListLocations operation.
pageNum := 0
err := client.ListLocationsPages(params,
    func(page *gamelift.ListLocationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) ListLocationsPagesWithContext added in v1.44.151 

func (c *GameLift) ListLocationsPagesWithContext(ctx aws.Context, input *ListLocationsInput, fn func(*ListLocationsOutput, bool) bool, opts ...request.Option) error

ListLocationsPagesWithContext same as ListLocationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListLocationsRequest added in v1.44.151 

func (c *GameLift) ListLocationsRequest(input *ListLocationsInput) (req *request.Request, output *ListLocationsOutput)

ListLocationsRequest generates a "aws/request.Request" representing the client's request for the ListLocations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLocations for more information on using the ListLocations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListLocations

func (*GameLift) ListLocationsWithContext added in v1.44.151 

func (c *GameLift) ListLocationsWithContext(ctx aws.Context, input *ListLocationsInput, opts ...request.Option) (*ListLocationsOutput, error)

ListLocationsWithContext is the same as ListLocations with the addition of the ability to pass a context and additional request options.

See ListLocations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListScripts added in v1.19.18 

func (c *GameLift) ListScripts(input *ListScriptsInput) (*ListScriptsOutput, error)

ListScripts API operation for Amazon GameLift.

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.

Learn more

Amazon GameLift Realtime Servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 ListScripts for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListScripts

func (*GameLift) ListScriptsPages added in v1.34.12 

func (c *GameLift) ListScriptsPages(input *ListScriptsInput, fn func(*ListScriptsOutput, bool) bool) error

ListScriptsPages iterates over the pages of a ListScripts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListScripts method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListScripts operation.
pageNum := 0
err := client.ListScriptsPages(params,
    func(page *gamelift.ListScriptsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) ListScriptsPagesWithContext added in v1.34.12 

func (c *GameLift) ListScriptsPagesWithContext(ctx aws.Context, input *ListScriptsInput, fn func(*ListScriptsOutput, bool) bool, opts ...request.Option) error

ListScriptsPagesWithContext same as ListScriptsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListScriptsRequest added in v1.19.18 

func (c *GameLift) ListScriptsRequest(input *ListScriptsInput) (req *request.Request, output *ListScriptsOutput)

ListScriptsRequest generates a "aws/request.Request" representing the client's request for the ListScripts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListScripts for more information on using the ListScripts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListScripts

func (*GameLift) ListScriptsWithContext added in v1.19.18 

func (c *GameLift) ListScriptsWithContext(ctx aws.Context, input *ListScriptsInput, opts ...request.Option) (*ListScriptsOutput, error)

ListScriptsWithContext is the same as ListScripts with the addition of the ability to pass a context and additional request options.

See ListScripts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ListTagsForResource added in v1.26.6 

func (c *GameLift) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon GameLift.

Retrieves all tags assigned to a Amazon GameLift resource. Use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.

To list tags for a resource, specify the unique ARN value for the resource.

Learn more

Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference 

Amazon Web Services Tagging Strategies (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 ListTagsForResource for usage and error information.

Returned Error Types:

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListTagsForResource

func (*GameLift) ListTagsForResourceRequest added in v1.26.6 

func (c *GameLift) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListTagsForResource

func (*GameLift) ListTagsForResourceWithContext added in v1.26.6 

func (c *GameLift) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.

Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.

Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html).

Target-based policy

A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.

For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.

To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Rule-based policy

A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.

For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%."

A policy's rule statement has the following structure:

If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

To implement the example, the rule statement would look like this:

If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PutScalingPolicy

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutScalingPolicy for more information on using the PutScalingPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PutScalingPolicy

func (*GameLift) PutScalingPolicyWithContext added in v1.8.0 

func (c *GameLift) PutScalingPolicyWithContext(ctx aws.Context, input *PutScalingPolicyInput, opts ...request.Option) (*PutScalingPolicyOutput, error)

PutScalingPolicyWithContext is the same as PutScalingPolicy with the addition of the ability to pass a context and additional request options.

See PutScalingPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) RegisterCompute added in v1.44.151 

func (c *GameLift) RegisterCompute(input *RegisterComputeInput) (*RegisterComputeOutput, error)

RegisterCompute API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Registers a compute resource in an Amazon GameLift fleet. Register computes with an Amazon GameLift Anywhere fleet or a container fleet.

For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to register fleet computes.

To register a compute, give the compute a name (must be unique within the fleet) and specify the compute resource's DNS name or IP address. Provide a fleet ID and a fleet location to associate with the compute being registered. You can optionally include the path to a TLS certificate on the compute resource.

If successful, this operation returns compute details, including an Amazon GameLift SDK endpoint or Agent endpoint. Game server processes running on the compute can use this endpoint to communicate with the Amazon GameLift service. Each server process includes the SDK endpoint in its call to the Amazon GameLift server SDK action InitSDK().

To view compute details, call DescribeCompute (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute.html) with the compute name.

Learn more

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 RegisterCompute for usage and error information.

Returned Error Types:

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

  • NotReadyException The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter (http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/).

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterCompute

func (*GameLift) RegisterComputeRequest added in v1.44.151 

func (c *GameLift) RegisterComputeRequest(input *RegisterComputeInput) (req *request.Request, output *RegisterComputeOutput)

RegisterComputeRequest generates a "aws/request.Request" representing the client's request for the RegisterCompute operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterCompute for more information on using the RegisterCompute API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterCompute

func (*GameLift) RegisterComputeWithContext added in v1.44.151 

func (c *GameLift) RegisterComputeWithContext(ctx aws.Context, input *RegisterComputeInput, opts ...request.Option) (*RegisterComputeOutput, error)

RegisterComputeWithContext is the same as RegisterCompute with the addition of the ability to pass a context and additional request options.

See RegisterCompute for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) RegisterGameServer added in v1.30.3 

func (c *GameLift) RegisterGameServer(input *RegisterGameServerInput) (*RegisterGameServerOutput, error)

RegisterGameServer API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Creates a new game server resource and notifies Amazon GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables Amazon GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.

To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data.

Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 RegisterGameServer for usage and error information.

Returned Error Types:

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterGameServer

func (*GameLift) RegisterGameServerRequest added in v1.30.3 

func (c *GameLift) RegisterGameServerRequest(input *RegisterGameServerInput) (req *request.Request, output *RegisterGameServerOutput)

RegisterGameServerRequest generates a "aws/request.Request" representing the client's request for the RegisterGameServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterGameServer for more information on using the RegisterGameServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterGameServer

func (*GameLift) RegisterGameServerWithContext added in v1.30.3 

func (c *GameLift) RegisterGameServerWithContext(ctx aws.Context, input *RegisterGameServerInput, opts ...request.Option) (*RegisterGameServerOutput, error)

RegisterGameServerWithContext is the same as RegisterGameServer with the addition of the ability to pass a context and additional request options.

See RegisterGameServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) RequestUploadCredentials 

func (c *GameLift) RequestUploadCredentials(input *RequestUploadCredentialsInput) (*RequestUploadCredentialsOutput, error)

RequestUploadCredentials API operation for Amazon GameLift.

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html).

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

Learn more 

Create a Build with Files in S3 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RequestUploadCredentials

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RequestUploadCredentials for more information on using the RequestUploadCredentials API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RequestUploadCredentials

func (*GameLift) RequestUploadCredentialsWithContext added in v1.8.0 

func (c *GameLift) RequestUploadCredentialsWithContext(ctx aws.Context, input *RequestUploadCredentialsInput, opts ...request.Option) (*RequestUploadCredentialsOutput, error)

RequestUploadCredentialsWithContext is the same as RequestUploadCredentials with the addition of the ability to pass a context and additional request options.

See RequestUploadCredentials for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ResolveAlias 

func (c *GameLift) ResolveAlias(input *ResolveAliasInput) (*ResolveAliasOutput, error)

ResolveAlias API operation for Amazon GameLift.

Attempts to retrieve a fleet ID that is associated with an alias. Specify a unique alias identifier.

If the alias has a SIMPLE routing strategy, Amazon GameLift returns a fleet ID. If the alias has a TERMINAL routing strategy, the result is a TerminalRoutingStrategyException.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ResolveAlias

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResolveAlias for more information on using the ResolveAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ResolveAlias

func (*GameLift) ResolveAliasWithContext added in v1.8.0 

func (c *GameLift) ResolveAliasWithContext(ctx aws.Context, input *ResolveAliasInput, opts ...request.Option) (*ResolveAliasOutput, error)

ResolveAliasWithContext is the same as ResolveAlias with the addition of the ability to pass a context and additional request options.

See ResolveAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ResumeGameServerGroup added in v1.30.3 

func (c *GameLift) ResumeGameServerGroup(input *ResumeGameServerGroupInput) (*ResumeGameServerGroupOutput, error)

ResumeGameServerGroup API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the SuspendGameServerGroup (gamelift/latest/apireference/API_SuspendGameServerGroup.html) operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.

To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 ResumeGameServerGroup for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • UnauthorizedException The client failed authentication. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ResumeGameServerGroup

func (*GameLift) ResumeGameServerGroupRequest added in v1.30.3 

func (c *GameLift) ResumeGameServerGroupRequest(input *ResumeGameServerGroupInput) (req *request.Request, output *ResumeGameServerGroupOutput)

ResumeGameServerGroupRequest generates a "aws/request.Request" representing the client's request for the ResumeGameServerGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResumeGameServerGroup for more information on using the ResumeGameServerGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ResumeGameServerGroup

func (*GameLift) ResumeGameServerGroupWithContext added in v1.30.3 

func (c *GameLift) ResumeGameServerGroupWithContext(ctx aws.Context, input *ResumeGameServerGroupInput, opts ...request.Option) (*ResumeGameServerGroupOutput, error)

ResumeGameServerGroupWithContext is the same as ResumeGameServerGroup with the addition of the ability to pass a context and additional request options.

See ResumeGameServerGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) SearchGameSessions added in v1.3.1 

func (c *GameLift) SearchGameSessions(input *SearchGameSessionsInput) (*SearchGameSessionsOutput, error)

SearchGameSessions API operation for Amazon GameLift.

Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.

This operation is not designed to continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications from a matchmaker or a game session placement queue.

When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations.

This operation can be used in the following ways:

  • To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.

  • To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSession object is returned for each game session that matches the request. Search finds game sessions that are in ACTIVE status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html) .

To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic.

  • gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value.

  • gameSessionName -- Name assigned to a game session. Game session names do not need to be unique to a game session.

  • gameSessionProperties -- A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. The filter expression must specify the GameProperty -- a Key and a string Value to search for the game sessions. For example, to search for the above key-value pair, specify the following search filter: gameSessionProperties.difficulty = "novice". All game property values are searched as strings. For examples of searching game sessions, see the ones below, and also see Search game sessions by game property (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-search).

  • maximumSessions -- Maximum number of player sessions allowed for 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.

  • hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.

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.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SearchGameSessions

func (*GameLift) SearchGameSessionsPages added in v1.34.12 

func (c *GameLift) SearchGameSessionsPages(input *SearchGameSessionsInput, fn func(*SearchGameSessionsOutput, bool) bool) error

SearchGameSessionsPages iterates over the pages of a SearchGameSessions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchGameSessions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a SearchGameSessions operation.
pageNum := 0
err := client.SearchGameSessionsPages(params,
    func(page *gamelift.SearchGameSessionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GameLift) SearchGameSessionsPagesWithContext added in v1.34.12 

func (c *GameLift) SearchGameSessionsPagesWithContext(ctx aws.Context, input *SearchGameSessionsInput, fn func(*SearchGameSessionsOutput, bool) bool, opts ...request.Option) error

SearchGameSessionsPagesWithContext same as SearchGameSessionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchGameSessions for more information on using the SearchGameSessions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SearchGameSessions

func (*GameLift) SearchGameSessionsWithContext added in v1.8.0 

func (c *GameLift) SearchGameSessionsWithContext(ctx aws.Context, input *SearchGameSessionsInput, opts ...request.Option) (*SearchGameSessionsOutput, error)

SearchGameSessionsWithContext is the same as SearchGameSessions with the addition of the ability to pass a context and additional request options.

See SearchGameSessions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) StartFleetActions added in v1.13.46 

func (c *GameLift) StartFleetActions(input *StartFleetActionsInput) (*StartFleetActionsOutput, error)

StartFleetActions API operation for Amazon GameLift.

Resumes certain types of activity on fleet instances that were suspended with StopFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html). For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity.

This operation can be used in the following ways:

  • To restart actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to resume.

  • To restart actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to resume.

If successful, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 StartFleetActions for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartFleetActions

func (*GameLift) StartFleetActionsRequest added in v1.13.46 

func (c *GameLift) StartFleetActionsRequest(input *StartFleetActionsInput) (req *request.Request, output *StartFleetActionsOutput)

StartFleetActionsRequest generates a "aws/request.Request" representing the client's request for the StartFleetActions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartFleetActions for more information on using the StartFleetActions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartFleetActions

func (*GameLift) StartFleetActionsWithContext added in v1.13.46 

func (c *GameLift) StartFleetActionsWithContext(ctx aws.Context, input *StartFleetActionsInput, opts ...request.Option) (*StartFleetActionsOutput, error)

StartFleetActionsWithContext is the same as StartFleetActions with the addition of the ability to pass a context and additional request options.

See StartFleetActions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) StartGameSessionPlacement added in v1.6.27 

func (c *GameLift) StartGameSessionPlacement(input *StartGameSessionPlacementInput) (*StartGameSessionPlacementOutput, error)

StartGameSessionPlacement API operation for Amazon GameLift.

Places a request for a new game session in a queue. When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.

A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.

When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.

Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players.

To place a new game session request, specify the following:

  • The queue name and a set of game session properties and settings

  • A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request

  • (Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)

  • Latency data for all players (if you want to optimize game play for the players)

If successful, a new game session placement is created.

To track the status of a placement request, call DescribeGameSessionPlacement (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html) and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.

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 StartGameSessionPlacement for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartGameSessionPlacement

func (*GameLift) StartGameSessionPlacementRequest added in v1.6.27 

func (c *GameLift) StartGameSessionPlacementRequest(input *StartGameSessionPlacementInput) (req *request.Request, output *StartGameSessionPlacementOutput)

StartGameSessionPlacementRequest generates a "aws/request.Request" representing the client's request for the StartGameSessionPlacement operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartGameSessionPlacement for more information on using the StartGameSessionPlacement API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartGameSessionPlacement

func (*GameLift) StartGameSessionPlacementWithContext added in v1.8.0 

func (c *GameLift) StartGameSessionPlacementWithContext(ctx aws.Context, input *StartGameSessionPlacementInput, opts ...request.Option) (*StartGameSessionPlacementOutput, error)

StartGameSessionPlacementWithContext is the same as StartGameSessionPlacement with the addition of the ability to pass a context and additional request options.

See StartGameSessionPlacement for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) StartMatchBackfill added in v1.12.73 

func (c *GameLift) StartMatchBackfill(input *StartMatchBackfillInput) (*StartMatchBackfillOutput, error)

StartMatchBackfill API operation for Amazon GameLift.

Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.

When using FlexMatch with Amazon GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a GameSessions ID. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the GameSession resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.

When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.

To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the GameSession ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.

Only game sessions created by FlexMatch are supported for match backfill.

Learn more 

Backfill existing games with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html)

Matchmaking events (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html)
(reference)

How Amazon GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html)

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 StartMatchBackfill for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartMatchBackfill

func (*GameLift) StartMatchBackfillRequest added in v1.12.73 

func (c *GameLift) StartMatchBackfillRequest(input *StartMatchBackfillInput) (req *request.Request, output *StartMatchBackfillOutput)

StartMatchBackfillRequest generates a "aws/request.Request" representing the client's request for the StartMatchBackfill operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartMatchBackfill for more information on using the StartMatchBackfill API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartMatchBackfill

func (*GameLift) StartMatchBackfillWithContext added in v1.12.73 

func (c *GameLift) StartMatchBackfillWithContext(ctx aws.Context, input *StartMatchBackfillInput, opts ...request.Option) (*StartMatchBackfillOutput, error)

StartMatchBackfillWithContext is the same as StartMatchBackfill with the addition of the ability to pass a context and additional request options.

See StartMatchBackfill for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) StartMatchmaking added in v1.10.27 

func (c *GameLift) StartMatchmaking(input *StartMatchmakingInput) (*StartMatchmakingOutput, error)

StartMatchmaking API operation for Amazon GameLift.

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use Amazon GameLift managed hosting, this operation also triggers Amazon GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to QUEUED.

Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.

Learn more 

Add FlexMatch to a game client (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html)

Set Up FlexMatch event notification (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html)

How Amazon GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html)

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 StartMatchmaking for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartMatchmaking

func (*GameLift) StartMatchmakingRequest added in v1.10.27 

func (c *GameLift) StartMatchmakingRequest(input *StartMatchmakingInput) (req *request.Request, output *StartMatchmakingOutput)

StartMatchmakingRequest generates a "aws/request.Request" representing the client's request for the StartMatchmaking operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartMatchmaking for more information on using the StartMatchmaking API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartMatchmaking

func (*GameLift) StartMatchmakingWithContext added in v1.10.27 

func (c *GameLift) StartMatchmakingWithContext(ctx aws.Context, input *StartMatchmakingInput, opts ...request.Option) (*StartMatchmakingOutput, error)

StartMatchmakingWithContext is the same as StartMatchmaking with the addition of the ability to pass a context and additional request options.

See StartMatchmaking for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) StopFleetActions added in v1.13.46 

func (c *GameLift) StopFleetActions(input *StopFleetActionsInput) (*StopFleetActionsOutput, error)

StopFleetActions API operation for Amazon GameLift.

Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.

Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.

This operation can be used in the following ways:

  • To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend.

  • To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend.

If successful, Amazon GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html). To restart fleet actions again, call StartFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartFleetActions.html).

Learn more

Setting up Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 StopFleetActions for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopFleetActions

func (*GameLift) StopFleetActionsRequest added in v1.13.46 

func (c *GameLift) StopFleetActionsRequest(input *StopFleetActionsInput) (req *request.Request, output *StopFleetActionsOutput)

StopFleetActionsRequest generates a "aws/request.Request" representing the client's request for the StopFleetActions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopFleetActions for more information on using the StopFleetActions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopFleetActions

func (*GameLift) StopFleetActionsWithContext added in v1.13.46 

func (c *GameLift) StopFleetActionsWithContext(ctx aws.Context, input *StopFleetActionsInput, opts ...request.Option) (*StopFleetActionsOutput, error)

StopFleetActionsWithContext is the same as StopFleetActions with the addition of the ability to pass a context and additional request options.

See StopFleetActions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) StopGameSessionPlacement added in v1.6.27 

func (c *GameLift) StopGameSessionPlacement(input *StopGameSessionPlacementInput) (*StopGameSessionPlacementOutput, error)

StopGameSessionPlacement API operation for Amazon GameLift.

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

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 StopGameSessionPlacement for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopGameSessionPlacement

func (*GameLift) StopGameSessionPlacementRequest added in v1.6.27 

func (c *GameLift) StopGameSessionPlacementRequest(input *StopGameSessionPlacementInput) (req *request.Request, output *StopGameSessionPlacementOutput)

StopGameSessionPlacementRequest generates a "aws/request.Request" representing the client's request for the StopGameSessionPlacement operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopGameSessionPlacement for more information on using the StopGameSessionPlacement API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopGameSessionPlacement

func (*GameLift) StopGameSessionPlacementWithContext added in v1.8.0 

func (c *GameLift) StopGameSessionPlacementWithContext(ctx aws.Context, input *StopGameSessionPlacementInput, opts ...request.Option) (*StopGameSessionPlacementOutput, error)

StopGameSessionPlacementWithContext is the same as StopGameSessionPlacement with the addition of the ability to pass a context and additional request options.

See StopGameSessionPlacement for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) StopMatchmaking added in v1.10.27 

func (c *GameLift) StopMatchmaking(input *StopMatchmakingInput) (*StopMatchmakingOutput, error)

StopMatchmaking API operation for Amazon GameLift.

Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.

If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).

Learn more 

Add FlexMatch to a game client (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html)

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 StopMatchmaking for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopMatchmaking

func (*GameLift) StopMatchmakingRequest added in v1.10.27 

func (c *GameLift) StopMatchmakingRequest(input *StopMatchmakingInput) (req *request.Request, output *StopMatchmakingOutput)

StopMatchmakingRequest generates a "aws/request.Request" representing the client's request for the StopMatchmaking operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopMatchmaking for more information on using the StopMatchmaking API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopMatchmaking

func (*GameLift) StopMatchmakingWithContext added in v1.10.27 

func (c *GameLift) StopMatchmakingWithContext(ctx aws.Context, input *StopMatchmakingInput, opts ...request.Option) (*StopMatchmakingOutput, error)

StopMatchmakingWithContext is the same as StopMatchmaking with the addition of the ability to pass a context and additional request options.

See StopMatchmaking for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) SuspendGameServerGroup added in v1.30.3 

func (c *GameLift) SuspendGameServerGroup(input *SuspendGameServerGroupInput) (*SuspendGameServerGroupOutput, error)

SuspendGameServerGroup API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup (gamelift/latest/apireference/API_ResumeGameServerGroup.html). You can suspend the following activity:

  • Instance type replacement - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active.

To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a GameServerGroup object is returned showing that the activity is listed in SuspendedActions.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 SuspendGameServerGroup for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • UnauthorizedException The client failed authentication. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SuspendGameServerGroup

func (*GameLift) SuspendGameServerGroupRequest added in v1.30.3 

func (c *GameLift) SuspendGameServerGroupRequest(input *SuspendGameServerGroupInput) (req *request.Request, output *SuspendGameServerGroupOutput)

SuspendGameServerGroupRequest generates a "aws/request.Request" representing the client's request for the SuspendGameServerGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SuspendGameServerGroup for more information on using the SuspendGameServerGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SuspendGameServerGroup

func (*GameLift) SuspendGameServerGroupWithContext added in v1.30.3 

func (c *GameLift) SuspendGameServerGroupWithContext(ctx aws.Context, input *SuspendGameServerGroupInput, opts ...request.Option) (*SuspendGameServerGroupOutput, error)

SuspendGameServerGroupWithContext is the same as SuspendGameServerGroup with the addition of the ability to pass a context and additional request options.

See SuspendGameServerGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) TagResource added in v1.26.6 

func (c *GameLift) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon GameLift.

Assigns a tag to an Amazon GameLift resource. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, and more. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.

To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the resource.

Learn more

Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference 

Amazon Web Services Tagging Strategies (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 TagResource for usage and error information.

Returned Error Types:

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TagResource

func (*GameLift) TagResourceRequest added in v1.26.6 

func (c *GameLift) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TagResource

func (*GameLift) TagResourceWithContext added in v1.26.6 

func (c *GameLift) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UntagResource added in v1.26.6 

func (c *GameLift) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon GameLift.

Removes a tag assigned to a Amazon GameLift resource. You can use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.

To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to remove. This operation succeeds even if the list includes tags that aren't assigned to the resource.

Learn more

Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference 

Amazon Web Services Tagging Strategies (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 UntagResource for usage and error information.

Returned Error Types:

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UntagResource

func (*GameLift) UntagResourceRequest added in v1.26.6 

func (c *GameLift) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UntagResource

func (*GameLift) UntagResourceWithContext added in v1.26.6 

func (c *GameLift) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateAlias 

func (c *GameLift) UpdateAlias(input *UpdateAliasInput) (*UpdateAliasOutput, error)

UpdateAlias API operation for Amazon GameLift.

Updates properties for an alias. Specify the unique identifier of the alias to be updated and the new property values. When reassigning an alias to a new fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateAlias

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAlias for more information on using the UpdateAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateAlias

func (*GameLift) UpdateAliasWithContext added in v1.8.0 

func (c *GameLift) UpdateAliasWithContext(ctx aws.Context, input *UpdateAliasInput, opts ...request.Option) (*UpdateAliasOutput, error)

UpdateAliasWithContext is the same as UpdateAlias with the addition of the ability to pass a context and additional request options.

See UpdateAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateBuild 

func (c *GameLift) UpdateBuild(input *UpdateBuildInput) (*UpdateBuildOutput, error)

UpdateBuild API operation for Amazon GameLift.

Updates metadata in a build resource, 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.

Learn more 

Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateBuild

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateBuild for more information on using the UpdateBuild API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateBuild

func (*GameLift) UpdateBuildWithContext added in v1.8.0 

func (c *GameLift) UpdateBuildWithContext(ctx aws.Context, input *UpdateBuildInput, opts ...request.Option) (*UpdateBuildOutput, error)

UpdateBuildWithContext is the same as UpdateBuild with the addition of the ability to pass a context and additional request options.

See UpdateBuild for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateFleetAttributes 

func (c *GameLift) UpdateFleetAttributes(input *UpdateFleetAttributesInput) (*UpdateFleetAttributesOutput, error)

UpdateFleetAttributes API operation for Amazon GameLift.

Updates a fleet's mutable attributes, such as game session protection and resource creation limits.

To update fleet attributes, specify the fleet ID and the property values that you want to change. If successful, Amazon GameLift returns the identifiers for the updated fleet.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 Types:

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetAttributes

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFleetAttributes for more information on using the UpdateFleetAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetAttributes

func (*GameLift) UpdateFleetAttributesWithContext added in v1.8.0 

func (c *GameLift) UpdateFleetAttributesWithContext(ctx aws.Context, input *UpdateFleetAttributesInput, opts ...request.Option) (*UpdateFleetAttributesOutput, error)

UpdateFleetAttributesWithContext is the same as UpdateFleetAttributes with the addition of the ability to pass a context and additional request options.

See UpdateFleetAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateFleetCapacity 

func (c *GameLift) UpdateFleetCapacity(input *UpdateFleetCapacityInput) (*UpdateFleetCapacityOutput, error)

UpdateFleetCapacity API operation for Amazon GameLift.

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Updates capacity settings for a managed EC2 fleet or container fleet. For these fleets, you adjust capacity by changing the number of instances in the fleet. Fleet capacity determines the number of game sessions and players that the fleet can host based on its configuration. For fleets with multiple locations, use this operation to manage capacity settings in each location individually.

Use this operation to set these fleet capacity properties:

  • Minimum/maximum size: Set hard limits on the number of Amazon EC2 instances allowed. If Amazon GameLift receives a request--either through manual update or automatic scaling--it won't change the capacity to a value outside of this range.

  • Desired capacity: As an alternative to automatic scaling, manually set the number of Amazon EC2 instances to be maintained. Before changing a fleet's desired capacity, check the maximum capacity of the fleet's Amazon EC2 instance type by calling DescribeEC2InstanceLimits (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html).

To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the Location parameter. The fleet must be in ACTIVE status.

To update capacity for a fleet's remote location, set the Location parameter to the location to update. The location must be in ACTIVE status.

If successful, Amazon GameLift updates the capacity settings and returns the identifiers for the updated fleet and/or location. If a requested change to desired capacity exceeds the instance type's limit, the LimitExceeded exception occurs.

Updates often prompt an immediate change in fleet capacity, such as when current capacity is different than the new desired capacity or outside the new limits. In this scenario, Amazon GameLift automatically initiates steps to add or remove instances in the fleet location. You can track a fleet's current capacity by calling DescribeFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) or DescribeFleetLocationCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html).

Learn more

Scaling fleet capacity (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html)

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 Types:

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetCapacity

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFleetCapacity for more information on using the UpdateFleetCapacity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetCapacity

func (*GameLift) UpdateFleetCapacityWithContext added in v1.8.0 

func (c *GameLift) UpdateFleetCapacityWithContext(ctx aws.Context, input *UpdateFleetCapacityInput, opts ...request.Option) (*UpdateFleetCapacityOutput, error)

UpdateFleetCapacityWithContext is the same as UpdateFleetCapacity with the addition of the ability to pass a context and additional request options.

See UpdateFleetCapacity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateFleetPortSettings 

func (c *GameLift) UpdateFleetPortSettings(input *UpdateFleetPortSettingsInput) (*UpdateFleetPortSettingsOutput, error)

UpdateFleetPortSettings API operation for Amazon GameLift.

Updates permissions that allow inbound traffic to connect to game sessions in the fleet.

To update settings, specify the fleet ID to be updated and specify the changes to be made. 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.

For a container fleet, inbound permissions must specify port numbers that are defined in the fleet's connection port settings.

If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 Types:

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetPortSettings

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFleetPortSettings for more information on using the UpdateFleetPortSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetPortSettings

func (*GameLift) UpdateFleetPortSettingsWithContext added in v1.8.0 

func (c *GameLift) UpdateFleetPortSettingsWithContext(ctx aws.Context, input *UpdateFleetPortSettingsInput, opts ...request.Option) (*UpdateFleetPortSettingsOutput, error)

UpdateFleetPortSettingsWithContext is the same as UpdateFleetPortSettings with the addition of the ability to pass a context and additional request options.

See UpdateFleetPortSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateGameServer added in v1.30.3 

func (c *GameLift) UpdateGameServer(input *UpdateGameServerInput) (*UpdateGameServerOutput, error)

UpdateGameServer API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Updates information about a registered game server to help Amazon GameLift FleetIQ track game server availability. This operation is called by a game server process that is running on an instance in a game server group.

Use this operation to update the following types of game server information. You can make all three types of updates in the same request:

  • To update the game server's utilization status from AVAILABLE (when the game server is available to be claimed) to UTILIZED (when the game server is currently hosting games). Identify the game server and game server group and specify the new utilization status. You can't change the status from to UTILIZED to AVAILABLE .

  • To report health status, identify the game server and game server group and set health check to HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds.

  • To change game server metadata, provide updated game server data.

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 UpdateGameServer for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • UnauthorizedException The client failed authentication. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameServer

func (*GameLift) UpdateGameServerGroup added in v1.30.3 

func (c *GameLift) UpdateGameServerGroup(input *UpdateGameServerGroupInput) (*UpdateGameServerGroupOutput, error)

UpdateGameServerGroup API operation for Amazon GameLift.

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Updates Amazon GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.

To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that Amazon GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.

Learn more

Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)

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 UpdateGameServerGroup for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

  • UnauthorizedException The client failed authentication. 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameServerGroup

func (*GameLift) UpdateGameServerGroupRequest added in v1.30.3 

func (c *GameLift) UpdateGameServerGroupRequest(input *UpdateGameServerGroupInput) (req *request.Request, output *UpdateGameServerGroupOutput)

UpdateGameServerGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateGameServerGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGameServerGroup for more information on using the UpdateGameServerGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameServerGroup

func (*GameLift) UpdateGameServerGroupWithContext added in v1.30.3 

func (c *GameLift) UpdateGameServerGroupWithContext(ctx aws.Context, input *UpdateGameServerGroupInput, opts ...request.Option) (*UpdateGameServerGroupOutput, error)

UpdateGameServerGroupWithContext is the same as UpdateGameServerGroup with the addition of the ability to pass a context and additional request options.

See UpdateGameServerGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateGameServerRequest added in v1.30.3 

func (c *GameLift) UpdateGameServerRequest(input *UpdateGameServerInput) (req *request.Request, output *UpdateGameServerOutput)

UpdateGameServerRequest generates a "aws/request.Request" representing the client's request for the UpdateGameServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGameServer for more information on using the UpdateGameServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameServer

func (*GameLift) UpdateGameServerWithContext added in v1.30.3 

func (c *GameLift) UpdateGameServerWithContext(ctx aws.Context, input *UpdateGameServerInput, opts ...request.Option) (*UpdateGameServerOutput, error)

UpdateGameServerWithContext is the same as UpdateGameServer with the addition of the ability to pass a context and additional request options.

See UpdateGameServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateGameSession 

func (c *GameLift) UpdateGameSession(input *UpdateGameSessionInput) (*UpdateGameSessionOutput, error)

UpdateGameSession API operation for Amazon GameLift.

Updates the mutable properties of a game session.

To update a game session, specify the game session ID and the values you want to change.

If successful, the updated GameSession object is returned.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 Types:

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameSession

func (*GameLift) UpdateGameSessionQueue added in v1.6.27 

func (c *GameLift) UpdateGameSessionQueue(input *UpdateGameSessionQueueInput) (*UpdateGameSessionQueueOutput, error)

UpdateGameSessionQueue API operation for Amazon GameLift.

Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

Learn more 

Using Multi-Region Queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html)

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 UpdateGameSessionQueue for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameSessionQueue

func (*GameLift) UpdateGameSessionQueueRequest added in v1.6.27 

func (c *GameLift) UpdateGameSessionQueueRequest(input *UpdateGameSessionQueueInput) (req *request.Request, output *UpdateGameSessionQueueOutput)

UpdateGameSessionQueueRequest generates a "aws/request.Request" representing the client's request for the UpdateGameSessionQueue operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGameSessionQueue for more information on using the UpdateGameSessionQueue API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameSessionQueue

func (*GameLift) UpdateGameSessionQueueWithContext added in v1.8.0 

func (c *GameLift) UpdateGameSessionQueueWithContext(ctx aws.Context, input *UpdateGameSessionQueueInput, opts ...request.Option) (*UpdateGameSessionQueueOutput, error)

UpdateGameSessionQueueWithContext is the same as UpdateGameSessionQueue with the addition of the ability to pass a context and additional request options.

See UpdateGameSessionQueue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGameSession for more information on using the UpdateGameSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameSession

func (*GameLift) UpdateGameSessionWithContext added in v1.8.0 

func (c *GameLift) UpdateGameSessionWithContext(ctx aws.Context, input *UpdateGameSessionInput, opts ...request.Option) (*UpdateGameSessionOutput, error)

UpdateGameSessionWithContext is the same as UpdateGameSession with the addition of the ability to pass a context and additional request options.

See UpdateGameSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateMatchmakingConfiguration added in v1.10.27 

func (c *GameLift) UpdateMatchmakingConfiguration(input *UpdateMatchmakingConfigurationInput) (*UpdateMatchmakingConfigurationOutput, error)

UpdateMatchmakingConfiguration API operation for Amazon GameLift.

Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings.

Learn more 

Design a FlexMatch matchmaker (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html)

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 UpdateMatchmakingConfiguration for usage and error information.

Returned Error Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateMatchmakingConfiguration

func (*GameLift) UpdateMatchmakingConfigurationRequest added in v1.10.27 

func (c *GameLift) UpdateMatchmakingConfigurationRequest(input *UpdateMatchmakingConfigurationInput) (req *request.Request, output *UpdateMatchmakingConfigurationOutput)

UpdateMatchmakingConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateMatchmakingConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMatchmakingConfiguration for more information on using the UpdateMatchmakingConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateMatchmakingConfiguration

func (*GameLift) UpdateMatchmakingConfigurationWithContext added in v1.10.27 

func (c *GameLift) UpdateMatchmakingConfigurationWithContext(ctx aws.Context, input *UpdateMatchmakingConfigurationInput, opts ...request.Option) (*UpdateMatchmakingConfigurationOutput, error)

UpdateMatchmakingConfigurationWithContext is the same as UpdateMatchmakingConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateMatchmakingConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateRuntimeConfiguration added in v1.2.1 

func (c *GameLift) UpdateRuntimeConfiguration(input *UpdateRuntimeConfigurationInput) (*UpdateRuntimeConfigurationOutput, error)

UpdateRuntimeConfiguration API operation for Amazon GameLift.

Updates the runtime configuration for the specified fleet. The runtime configuration tells Amazon GameLift how to launch server processes on computes in the fleet. For managed EC2 fleets, it determines what server processes to run on each fleet instance. For container fleets, it describes what server processes to run in each replica container group. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in ACTIVE status.

To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration with an updated set of server process configurations.

If successful, the fleet's runtime configuration settings are updated. Fleet computes that run game server processes regularly check for and receive updated runtime configurations. The computes immediately take action to comply with the new configuration by launching new server processes or by not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.

Learn more

Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)

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 Types:

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

  • NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateRuntimeConfiguration

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRuntimeConfiguration for more information on using the UpdateRuntimeConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateRuntimeConfiguration

func (*GameLift) UpdateRuntimeConfigurationWithContext added in v1.8.0 

func (c *GameLift) UpdateRuntimeConfigurationWithContext(ctx aws.Context, input *UpdateRuntimeConfigurationInput, opts ...request.Option) (*UpdateRuntimeConfigurationOutput, error)

UpdateRuntimeConfigurationWithContext is the same as UpdateRuntimeConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateRuntimeConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) UpdateScript added in v1.19.18 

func (c *GameLift) UpdateScript(input *UpdateScriptInput) (*UpdateScriptOutput, error)

UpdateScript API operation for Amazon GameLift.

Updates Realtime script metadata and content.

To update script metadata, specify the script ID and provide updated name and/or version values.

To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script.

If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.

Learn more

Amazon GameLift Realtime Servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

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 UpdateScript for usage and error information.

Returned Error Types:

  • 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 THe requested resources was not found. The resource was either not created yet or deleted.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateScript

func (*GameLift) UpdateScriptRequest added in v1.19.18 

func (c *GameLift) UpdateScriptRequest(input *UpdateScriptInput) (req *request.Request, output *UpdateScriptOutput)

UpdateScriptRequest generates a "aws/request.Request" representing the client's request for the UpdateScript operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateScript for more information on using the UpdateScript API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateScript

func (*GameLift) UpdateScriptWithContext added in v1.19.18 

func (c *GameLift) UpdateScriptWithContext(ctx aws.Context, input *UpdateScriptInput, opts ...request.Option) (*UpdateScriptOutput, error)

UpdateScriptWithContext is the same as UpdateScript with the addition of the ability to pass a context and additional request options.

See UpdateScript for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GameLift) ValidateMatchmakingRuleSet added in v1.10.27 

func (c *GameLift) ValidateMatchmakingRuleSet(input *ValidateMatchmakingRuleSetInput) (*ValidateMatchmakingRuleSetOutput, error)

ValidateMatchmakingRuleSet API operation for Amazon GameLift.

Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.

Learn more

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 ValidateMatchmakingRuleSet for usage and error information.

Returned Error Types:

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

  • UnsupportedRegionException The requested operation is not supported in the Region specified.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ValidateMatchmakingRuleSet

func (*GameLift) ValidateMatchmakingRuleSetRequest added in v1.10.27 

func (c *GameLift) ValidateMatchmakingRuleSetRequest(input *ValidateMatchmakingRuleSetInput) (req *request.Request, output *ValidateMatchmakingRuleSetOutput)

ValidateMatchmakingRuleSetRequest generates a "aws/request.Request" representing the client's request for the ValidateMatchmakingRuleSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ValidateMatchmakingRuleSet for more information on using the ValidateMatchmakingRuleSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ValidateMatchmakingRuleSet

func (*GameLift) ValidateMatchmakingRuleSetWithContext added in v1.10.27 

func (c *GameLift) ValidateMatchmakingRuleSetWithContext(ctx aws.Context, input *ValidateMatchmakingRuleSetInput, opts ...request.Option) (*ValidateMatchmakingRuleSetOutput, error)

ValidateMatchmakingRuleSetWithContext is the same as ValidateMatchmakingRuleSet with the addition of the ability to pass a context and additional request options.

See ValidateMatchmakingRuleSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type GameProperty 

type GameProperty struct {

	// The game property identifier.
	//
	// Key is a required field
	Key *string `type:"string" required:"true"`

	// The game property value.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

This key-value pair can store custom data about a game session. For example, you might use a GameProperty to track a game session's map, level of difficulty, or remaining time. The difficulty level could be specified like this: {"Key": "difficulty", "Value":"Novice"}.

You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can't delete game properties from a game session.

For examples of working with game properties, see Create a game session with properties (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties).

func (GameProperty) GoString 

func (s GameProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 GameServer added in v1.30.3 

type GameServer struct {

	// Indicates when an available game server has been reserved for gameplay but
	// has not yet started hosting a game. Once it is claimed, the game server remains
	// in CLAIMED status for a maximum of one minute. During this time, game clients
	// connect to the game server to start the game and trigger the game server
	// to update its utilization status. After one minute, the game server claim
	// status reverts to null.
	ClaimStatus *string `type:"string" enum:"GameServerClaimStatus"`

	// The port and IP address that must be used to establish a client connection
	// to the game server.
	ConnectionInfo *string `min:"1" type:"string"`

	// A set of custom game server properties, formatted as a single string value.
	// This data is passed to a game client or service when it requests information
	// on game servers.
	GameServerData *string `min:"1" type:"string"`

	// The ARN identifier for the game server group where the game server is located.
	GameServerGroupArn *string `min:"1" type:"string"`

	// A unique identifier for the game server group where the game server is running.
	GameServerGroupName *string `min:"1" type:"string"`

	// A custom string that uniquely identifies the game server. Game server IDs
	// are developer-defined and are unique across all game server groups in an
	// Amazon Web Services account.
	GameServerId *string `min:"3" type:"string"`

	// The unique identifier for the instance where the game server is running.
	// This ID is available in the instance metadata. EC2 instance IDs use a 17-character
	// format, for example: i-1234567890abcdef0.
	InstanceId *string `min:"19" type:"string"`

	// Timestamp that indicates the last time the game server was claimed. The format
	// is a number expressed in Unix time as milliseconds (for example "1469498468.057").
	// This value is used to calculate when a claimed game server's status should
	// revert to null.
	LastClaimTime *time.Time `type:"timestamp"`

	// Timestamp that indicates the last time the game server was updated with health
	// status. The format is a number expressed in Unix time as milliseconds (for
	// example "1469498468.057"). After game server registration, this property
	// is only changed when a game server update specifies a health check value.
	LastHealthCheckTime *time.Time `type:"timestamp"`

	// Timestamp that indicates when the game server registered. The format is a
	// number expressed in Unix time as milliseconds (for example "1469498468.057").
	RegistrationTime *time.Time `type:"timestamp"`

	// Indicates whether the game server is currently available for new games or
	// is busy. Possible statuses include:
	//
	//    * AVAILABLE - The game server is available to be claimed. A game server
	//    that has been claimed remains in this status until it reports game hosting
	//    activity.
	//
	//    * UTILIZED - The game server is currently hosting a game session with
	//    players.
	UtilizationStatus *string `type:"string" enum:"GameServerUtilizationStatus"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Properties describing a game server that is running on an instance in a game server group.

A game server is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer. A game server is claimed to host a game session by calling ClaimGameServer.

func (GameServer) GoString added in v1.30.3 

func (s GameServer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameServer) SetClaimStatus added in v1.30.3 

func (s *GameServer) SetClaimStatus(v string) *GameServer

SetClaimStatus sets the ClaimStatus field's value.

func (*GameServer) SetConnectionInfo added in v1.30.3 

func (s *GameServer) SetConnectionInfo(v string) *GameServer

SetConnectionInfo sets the ConnectionInfo field's value.

func (*GameServer) SetGameServerData added in v1.30.3 

func (s *GameServer) SetGameServerData(v string) *GameServer

SetGameServerData sets the GameServerData field's value.

func (*GameServer) SetGameServerGroupArn added in v1.30.3 

func (s *GameServer) SetGameServerGroupArn(v string) *GameServer

SetGameServerGroupArn sets the GameServerGroupArn field's value.

func (*GameServer) SetGameServerGroupName added in v1.30.3 

func (s *GameServer) SetGameServerGroupName(v string) *GameServer

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*GameServer) SetGameServerId added in v1.30.3 

func (s *GameServer) SetGameServerId(v string) *GameServer

SetGameServerId sets the GameServerId field's value.

func (*GameServer) SetInstanceId added in v1.30.3 

func (s *GameServer) SetInstanceId(v string) *GameServer

SetInstanceId sets the InstanceId field's value.

func (*GameServer) SetLastClaimTime added in v1.30.3 

func (s *GameServer) SetLastClaimTime(v time.Time) *GameServer

SetLastClaimTime sets the LastClaimTime field's value.

func (*GameServer) SetLastHealthCheckTime added in v1.30.3 

func (s *GameServer) SetLastHealthCheckTime(v time.Time) *GameServer

SetLastHealthCheckTime sets the LastHealthCheckTime field's value.

func (*GameServer) SetRegistrationTime added in v1.30.3 

func (s *GameServer) SetRegistrationTime(v time.Time) *GameServer

SetRegistrationTime sets the RegistrationTime field's value.

func (*GameServer) SetUtilizationStatus added in v1.30.3 

func (s *GameServer) SetUtilizationStatus(v string) *GameServer

SetUtilizationStatus sets the UtilizationStatus field's value.

func (GameServer) String added in v1.30.3 

func (s GameServer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GameServerGroup added in v1.30.3 

type GameServerGroup struct {

	// A generated unique ID for the Amazon EC2 Auto Scaling group that is associated
	// with this game server group.
	AutoScalingGroupArn *string `type:"string"`

	// Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances
	// and On-Demand Instances in the game server group. Method options include
	// the following:
	//
	//    * SPOT_ONLY - Only Spot Instances are used in the game server group. If
	//    Spot Instances are unavailable or not viable for game hosting, the game
	//    server group provides no hosting capacity until Spot Instances can again
	//    be used. Until then, no new instances are started, and the existing nonviable
	//    Spot Instances are terminated (after current gameplay ends) and are not
	//    replaced.
	//
	//    * SPOT_PREFERRED - (default value) Spot Instances are used whenever available
	//    in the game server group. If Spot Instances are unavailable, the game
	//    server group continues to provide hosting capacity by falling back to
	//    On-Demand Instances. Existing nonviable Spot Instances are terminated
	//    (after current gameplay ends) and are replaced with new On-Demand Instances.
	//
	//    * ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server
	//    group. No Spot Instances are used, even when available, while this balancing
	//    strategy is in force.
	BalancingStrategy *string `type:"string" enum:"BalancingStrategy"`

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

	// A generated unique ID for the game server group.
	GameServerGroupArn *string `min:"1" type:"string"`

	// A developer-defined identifier for the game server group. The name is unique
	// for each Region in each Amazon Web Services account.
	GameServerGroupName *string `min:"1" type:"string"`

	// A flag that indicates whether instances in the game server group are protected
	// from early termination. Unprotected instances that have active game servers
	// running might be terminated during a scale-down event, causing players to
	// be dropped from the game. Protected instances cannot be terminated while
	// there are active game servers running except in the event of a forced game
	// server group deletion (see ). An exception to this is with Spot Instances,
	// which can be terminated by Amazon Web Services regardless of protection status.
	GameServerProtectionPolicy *string `type:"string" enum:"GameServerProtectionPolicy"`

	// The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use
	// when balancing and automatically scaling instances in the corresponding Auto
	// Scaling group.
	InstanceDefinitions []*InstanceDefinition `min:"2" type:"list"`

	// A timestamp that indicates when this game server group was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto
	// Scaling groups.
	RoleArn *string `min:"1" type:"string"`

	// The current status of the game server group. Possible statuses include:
	//
	//    * NEW - Amazon GameLift FleetIQ has validated the CreateGameServerGroup()
	//    request.
	//
	//    * ACTIVATING - Amazon GameLift FleetIQ is setting up a game server group,
	//    which includes creating an Auto Scaling group in your Amazon Web Services
	//    account.
	//
	//    * ACTIVE - The game server group has been successfully created.
	//
	//    * DELETE_SCHEDULED - A request to delete the game server group has been
	//    received.
	//
	//    * DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup()
	//    request and is processing it. Amazon GameLift FleetIQ must first complete
	//    and release hosts before it deletes the Auto Scaling group and the game
	//    server group.
	//
	//    * DELETED - The game server group has been successfully deleted.
	//
	//    * ERROR - The asynchronous processes of activating or deleting a game
	//    server group has failed, resulting in an error state.
	Status *string `type:"string" enum:"GameServerGroupStatus"`

	// Additional information about the current game server group status. This information
	// might provide additional insight on groups that are in ERROR status.
	StatusReason *string `min:"1" type:"string"`

	// A list of activities that are currently suspended for this game server group.
	// If this property is empty, all activities are occurring.
	SuspendedActions []*string `min:"1" type:"list" enum:"GameServerGroupAction"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding Amazon EC2 Auto Scaling group.

A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server group activity can be temporarily suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup, respectively.

func (GameServerGroup) GoString added in v1.30.3 

func (s GameServerGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameServerGroup) SetAutoScalingGroupArn added in v1.30.3 

func (s *GameServerGroup) SetAutoScalingGroupArn(v string) *GameServerGroup

SetAutoScalingGroupArn sets the AutoScalingGroupArn field's value.

func (*GameServerGroup) SetBalancingStrategy added in v1.30.3 

func (s *GameServerGroup) SetBalancingStrategy(v string) *GameServerGroup

SetBalancingStrategy sets the BalancingStrategy field's value.

func (*GameServerGroup) SetCreationTime added in v1.30.3 

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

SetCreationTime sets the CreationTime field's value.

func (*GameServerGroup) SetGameServerGroupArn added in v1.30.3 

func (s *GameServerGroup) SetGameServerGroupArn(v string) *GameServerGroup

SetGameServerGroupArn sets the GameServerGroupArn field's value.

func (*GameServerGroup) SetGameServerGroupName added in v1.30.3 

func (s *GameServerGroup) SetGameServerGroupName(v string) *GameServerGroup

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*GameServerGroup) SetGameServerProtectionPolicy added in v1.30.3 

func (s *GameServerGroup) SetGameServerProtectionPolicy(v string) *GameServerGroup

SetGameServerProtectionPolicy sets the GameServerProtectionPolicy field's value.

func (*GameServerGroup) SetInstanceDefinitions added in v1.30.3 

func (s *GameServerGroup) SetInstanceDefinitions(v []*InstanceDefinition) *GameServerGroup

SetInstanceDefinitions sets the InstanceDefinitions field's value.

func (*GameServerGroup) SetLastUpdatedTime added in v1.30.3 

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

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*GameServerGroup) SetRoleArn added in v1.30.3 

func (s *GameServerGroup) SetRoleArn(v string) *GameServerGroup

SetRoleArn sets the RoleArn field's value.

func (*GameServerGroup) SetStatus added in v1.30.3 

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

SetStatus sets the Status field's value.

func (*GameServerGroup) SetStatusReason added in v1.30.3 

func (s *GameServerGroup) SetStatusReason(v string) *GameServerGroup

SetStatusReason sets the StatusReason field's value.

func (*GameServerGroup) SetSuspendedActions added in v1.30.3 

func (s *GameServerGroup) SetSuspendedActions(v []*string) *GameServerGroup

SetSuspendedActions sets the SuspendedActions field's value.

func (GameServerGroup) String added in v1.30.3 

func (s GameServerGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GameServerGroupAutoScalingPolicy added in v1.30.3 

type GameServerGroupAutoScalingPolicy struct {

	// Length of time, in seconds, it takes for a new instance to start new game
	// server processes and register with Amazon GameLift FleetIQ. Specifying a
	// warm-up time can be useful, particularly with game servers that take a long
	// time to start up, because it avoids prematurely starting new instances.
	EstimatedInstanceWarmup *int64 `min:"1" type:"integer"`

	// Settings for a target-based scaling policy applied to Auto Scaling group.
	// These settings are used to create a target-based policy that tracks the Amazon
	// GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target
	// value for the metric. As player usage changes, the policy triggers to adjust
	// the game server group capacity so that the metric returns to the target value.
	//
	// TargetTrackingConfiguration is a required field
	TargetTrackingConfiguration *TargetTrackingConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Configuration settings for intelligent automatic scaling that uses target tracking. These settings are used to add an Auto Scaling policy when creating the corresponding Auto Scaling group. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group.

func (GameServerGroupAutoScalingPolicy) GoString added in v1.30.3 

func (s GameServerGroupAutoScalingPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameServerGroupAutoScalingPolicy) SetEstimatedInstanceWarmup added in v1.30.3 

func (s *GameServerGroupAutoScalingPolicy) SetEstimatedInstanceWarmup(v int64) *GameServerGroupAutoScalingPolicy

SetEstimatedInstanceWarmup sets the EstimatedInstanceWarmup field's value.

func (*GameServerGroupAutoScalingPolicy) SetTargetTrackingConfiguration added in v1.30.3 

func (s *GameServerGroupAutoScalingPolicy) SetTargetTrackingConfiguration(v *TargetTrackingConfiguration) *GameServerGroupAutoScalingPolicy

SetTargetTrackingConfiguration sets the TargetTrackingConfiguration field's value.

func (GameServerGroupAutoScalingPolicy) String added in v1.30.3 

func (s GameServerGroupAutoScalingPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameServerGroupAutoScalingPolicy) Validate added in v1.30.3 

func (s *GameServerGroupAutoScalingPolicy) Validate() error

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

type GameServerInstance added in v1.34.12 

type GameServerInstance struct {

	// A generated unique identifier for the game server group that includes the
	// game server instance.
	GameServerGroupArn *string `min:"1" type:"string"`

	// A developer-defined identifier for the game server group that includes the
	// game server instance. The name is unique for each Region in each Amazon Web
	// Services account.
	GameServerGroupName *string `min:"1" type:"string"`

	// The unique identifier for the instance where the game server is running.
	// This ID is available in the instance metadata. EC2 instance IDs use a 17-character
	// format, for example: i-1234567890abcdef0.
	InstanceId *string `min:"19" type:"string"`

	// Current status of the game server instance
	InstanceStatus *string `type:"string" enum:"GameServerInstanceStatus"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see DescribeGameServerGroup and with the EC2 launch template that was used when creating the game server group.

Retrieve game server instances for a game server group by calling DescribeGameServerInstances.

func (GameServerInstance) GoString added in v1.34.12 

func (s GameServerInstance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameServerInstance) SetGameServerGroupArn added in v1.34.12 

func (s *GameServerInstance) SetGameServerGroupArn(v string) *GameServerInstance

SetGameServerGroupArn sets the GameServerGroupArn field's value.

func (*GameServerInstance) SetGameServerGroupName added in v1.34.12 

func (s *GameServerInstance) SetGameServerGroupName(v string) *GameServerInstance

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*GameServerInstance) SetInstanceId added in v1.34.12 

func (s *GameServerInstance) SetInstanceId(v string) *GameServerInstance

SetInstanceId sets the InstanceId field's value.

func (*GameServerInstance) SetInstanceStatus added in v1.34.12 

func (s *GameServerInstance) SetInstanceStatus(v string) *GameServerInstance

SetInstanceStatus sets the InstanceStatus field's value.

func (GameServerInstance) String added in v1.34.12 

func (s GameServerInstance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GameSession 

type GameSession struct {

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

	// A unique identifier for a player. This ID is used to enforce a resource protection
	// policy (if one exists), that limits the number of game sessions a player
	// can create.
	CreatorId *string `min:"1" type:"string"`

	// Number of players currently in the game session.
	CurrentPlayerSessionCount *int64 `type:"integer"`

	// The DNS identifier assigned to the instance that is running the game session.
	// Values have the following format:
	//
	//    * TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
	//
	//    * Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com.
	//    (See Amazon EC2 Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses).)
	//
	// When connecting to a game session that is running on a TLS-enabled fleet,
	// you must use the DNS name, not the IP address.
	DnsName *string `type:"string"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// associated with the GameLift fleet that this game session is running on.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that the game session is running on.
	FleetId *string `type:"string"`

	// A set of key-value pairs that can store custom data in a game session. For
	// example: {"Key": "difficulty", "Value": "novice"}.
	GameProperties []*GameProperty `type:"list"`

	// A set of custom game session properties, formatted as a single string value.
	// This data is passed to a game server process with a request to start a new
	// game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
	GameSessionData *string `min:"1" type:"string"`

	// A unique identifier for the game session. A game session ARN has the following
	// format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string
	// or idempotency token>.
	GameSessionId *string `min:"1" type:"string"`

	// The IP address of the game session. To connect to a Amazon GameLift game
	// server, an app needs both the IP address and port number.
	//
	// IpAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GameSession's
	// String and GoString methods.
	IpAddress *string `min:"1" type:"string" sensitive:"true"`

	// The fleet location where the game session is running. This value might specify
	// the fleet's home Region or a remote location. Location is expressed as an
	// Amazon Web Services Region code such as us-west-2.
	Location *string `min:"1" type:"string"`

	// Information about the matchmaking process that resulted in the game session,
	// if matchmaking was used. Data is in JSON syntax, formatted as a string. Information
	// includes the matchmaker ID as well as player attributes and team assignments.
	// For more details on matchmaker data, see Match Data (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data).
	// Matchmaker data is updated whenever new players are added during a successful
	// backfill (see StartMatchBackfill (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchBackfill.html)).
	MatchmakerData *string `min:"1" type:"string"`

	// The maximum number of players that can be connected simultaneously to the
	// game session.
	MaximumPlayerSessionCount *int64 `type:"integer"`

	// A descriptive label that is 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"`

	// The port number for the game session. To connect to a Amazon GameLift game
	// server, an app needs both the IP address and port number.
	//
	// Port is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GameSession's
	// String and GoString methods.
	Port *int64 `min:"1" type:"integer" sensitive:"true"`

	// Current status of the game session. A game session must have an ACTIVE status
	// to have player sessions.
	Status *string `type:"string" enum:"GameSessionStatus"`

	// Provides additional information about game session status. INTERRUPTED indicates
	// that the game session was hosted on a spot instance that was reclaimed, causing
	// the active game session to be terminated.
	StatusReason *string `type:"string" enum:"GameSessionStatusReason"`

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

Properties describing a game session.

A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.

Amazon GameLift retains a game session resource for 30 days after the game session ends. You can reuse idempotency token values after this time. Game session logs are retained for 14 days.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

func (GameSession) GoString 

func (s GameSession) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetDnsName added in v1.23.14 

func (s *GameSession) SetDnsName(v string) *GameSession

SetDnsName sets the DnsName field's value.

func (*GameSession) SetFleetArn added in v1.26.6 

func (s *GameSession) SetFleetArn(v string) *GameSession

SetFleetArn sets the FleetArn 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) SetGameSessionData added in v1.10.27 

func (s *GameSession) SetGameSessionData(v string) *GameSession

SetGameSessionData sets the GameSessionData 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) SetLocation added in v1.37.32 

func (s *GameSession) SetLocation(v string) *GameSession

SetLocation sets the Location field's value.

func (*GameSession) SetMatchmakerData added in v1.12.73 

func (s *GameSession) SetMatchmakerData(v string) *GameSession

SetMatchmakerData sets the MatchmakerData 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) SetStatusReason added in v1.12.78 

func (s *GameSession) SetStatusReason(v string) *GameSession

SetStatusReason sets the StatusReason 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GameSessionConnectionInfo added in v1.10.27 

type GameSessionConnectionInfo struct {

	// The DNS identifier assigned to the instance that is running the game session.
	// Values have the following format:
	//
	//    * TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
	//
	//    * Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com.
	//    (See Amazon EC2 Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses).)
	//
	// When connecting to a game session that is running on a TLS-enabled fleet,
	// you must use the DNS name, not the IP address.
	DnsName *string `type:"string"`

	// A unique identifier for the game session. Use the game session ID.
	GameSessionArn *string `min:"1" type:"string"`

	// The IP address of the game session. To connect to a Amazon GameLift game
	// server, an app needs both the IP address and port number.
	//
	// IpAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GameSessionConnectionInfo's
	// String and GoString methods.
	IpAddress *string `min:"1" type:"string" sensitive:"true"`

	// A collection of player session IDs, one for each player ID that was included
	// in the original matchmaking request.
	MatchedPlayerSessions []*MatchedPlayerSession `type:"list"`

	// The port number for the game session. To connect to a Amazon GameLift game
	// server, an app needs both the IP address and port number.
	Port *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Connection information for a new game session that is created in response to a start matchmaking request. Once a match is made, the FlexMatch engine creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the matchmaking ticket.

func (GameSessionConnectionInfo) GoString added in v1.10.27 

func (s GameSessionConnectionInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameSessionConnectionInfo) SetDnsName added in v1.23.14 

func (s *GameSessionConnectionInfo) SetDnsName(v string) *GameSessionConnectionInfo

SetDnsName sets the DnsName field's value.

func (*GameSessionConnectionInfo) SetGameSessionArn added in v1.10.27 

func (s *GameSessionConnectionInfo) SetGameSessionArn(v string) *GameSessionConnectionInfo

SetGameSessionArn sets the GameSessionArn field's value.

func (*GameSessionConnectionInfo) SetIpAddress added in v1.10.27 

func (s *GameSessionConnectionInfo) SetIpAddress(v string) *GameSessionConnectionInfo

SetIpAddress sets the IpAddress field's value.

func (*GameSessionConnectionInfo) SetMatchedPlayerSessions added in v1.10.27 

func (s *GameSessionConnectionInfo) SetMatchedPlayerSessions(v []*MatchedPlayerSession) *GameSessionConnectionInfo

SetMatchedPlayerSessions sets the MatchedPlayerSessions field's value.

func (*GameSessionConnectionInfo) SetPort added in v1.10.27 

func (s *GameSessionConnectionInfo) SetPort(v int64) *GameSessionConnectionInfo

SetPort sets the Port field's value.

func (GameSessionConnectionInfo) String added in v1.10.27 

func (s GameSessionConnectionInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GameSessionDetail added in v1.1.10 

type GameSessionDetail struct {

	// Object that describes 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 plus the protection policy currently in force.

func (GameSessionDetail) GoString added in v1.1.10 

func (s GameSessionDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GameSessionFullException added in v1.28.0 

type GameSessionFullException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*GameSessionFullException) Code added in v1.28.0 

func (s *GameSessionFullException) Code() string

Code returns the exception type name.

func (*GameSessionFullException) Error added in v1.28.0 

func (s *GameSessionFullException) Error() string

func (GameSessionFullException) GoString added in v1.28.0 

func (s GameSessionFullException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameSessionFullException) Message added in v1.28.0 

func (s *GameSessionFullException) Message() string

Message returns the exception's message.

func (*GameSessionFullException) OrigErr added in v1.28.0 

func (s *GameSessionFullException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*GameSessionFullException) RequestID added in v1.28.0 

func (s *GameSessionFullException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*GameSessionFullException) StatusCode added in v1.28.0 

func (s *GameSessionFullException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (GameSessionFullException) String added in v1.28.0 

func (s GameSessionFullException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GameSessionPlacement added in v1.6.27 

type GameSessionPlacement struct {

	// The DNS identifier assigned to the instance that is running the game session.
	// Values have the following format:
	//
	//    * TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
	//
	//    * Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com.
	//    (See Amazon EC2 Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses).)
	//
	// When connecting to a game session that is running on a TLS-enabled fleet,
	// you must use the DNS name, not the IP address.
	DnsName *string `type:"string"`

	// Time stamp indicating when this request was completed, canceled, or timed
	// out.
	EndTime *time.Time `type:"timestamp"`

	// A set of key-value pairs that can store custom data in a game session. For
	// example: {"Key": "difficulty", "Value": "novice"}.
	GameProperties []*GameProperty `type:"list"`

	// Identifier for the game session created by this placement request. This identifier
	// is unique across all Regions. This value isn't final until placement status
	// is FULFILLED.
	GameSessionArn *string `min:"1" type:"string"`

	// A set of custom game session properties, formatted as a single string value.
	// This data is passed to a game server process in the GameSession object with
	// a request to start a new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
	GameSessionData *string `min:"1" type:"string"`

	// A unique identifier for the game session. This value isn't final until placement
	// status is FULFILLED.
	GameSessionId *string `min:"1" type:"string"`

	// A descriptive label that is associated with a game session. Session names
	// do not need to be unique.
	GameSessionName *string `min:"1" type:"string"`

	// A descriptive label that is associated with game session queue. Queue names
	// must be unique within each Region.
	GameSessionQueueName *string `min:"1" type:"string"`

	// Name of the Region where the game session created by this placement request
	// is running. This value isn't final until placement status is FULFILLED.
	GameSessionRegion *string `min:"1" type:"string"`

	// The IP address of the game session. To connect to a Amazon GameLift game
	// server, an app needs both the IP address and port number. This value isn't
	// final until placement status is FULFILLED.
	//
	// IpAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GameSessionPlacement's
	// String and GoString methods.
	IpAddress *string `min:"1" type:"string" sensitive:"true"`

	// Information on the matchmaking process for this game. Data is in JSON syntax,
	// formatted as a string. It identifies the matchmaking configuration used to
	// create the match, and contains data on all players assigned to the match,
	// including player attributes and team assignments. For more details on matchmaker
	// data, see Match Data (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data).
	MatchmakerData *string `min:"1" type:"string"`

	// The maximum number of players that can be connected simultaneously to the
	// game session.
	MaximumPlayerSessionCount *int64 `type:"integer"`

	// A collection of information on player sessions created in response to the
	// game session placement request. These player sessions are created only after
	// a new game session is successfully placed (placement status is FULFILLED).
	// This information includes the player ID, provided in the placement request,
	// and a corresponding player session ID.
	PlacedPlayerSessions []*PlacedPlayerSession `type:"list"`

	// A unique identifier for a game session placement.
	PlacementId *string `min:"1" type:"string"`

	// A set of values, expressed in milliseconds, that indicates the amount of
	// latency that a player experiences when connected to Amazon Web Services Regions.
	PlayerLatencies []*PlayerLatency `type:"list"`

	// The port number for the game session. To connect to a Amazon GameLift game
	// server, an app needs both the IP address and port number. This value isn't
	// final until placement status is FULFILLED.
	//
	// Port is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GameSessionPlacement's
	// String and GoString methods.
	Port *int64 `min:"1" type:"integer" sensitive:"true"`

	// Time stamp indicating when this request was placed in the queue. Format is
	// a number expressed in Unix time as milliseconds (for example "1469498468.057").
	StartTime *time.Time `type:"timestamp"`

	// Current status of the game session placement request.
	//
	//    * PENDING -- The placement request is in the queue waiting to be processed.
	//    Game session properties are not yet final.
	//
	//    * FULFILLED -- A new game session has been successfully placed. Game session
	//    properties are now final.
	//
	//    * CANCELLED -- The placement request was canceled.
	//
	//    * TIMED_OUT -- A new game session was not successfully created before
	//    the time limit expired. You can resubmit the placement request as needed.
	//
	//    * FAILED -- Amazon GameLift is not able to complete the process of placing
	//    the game session. Common reasons are the game session terminated before
	//    the placement process was completed, or an unexpected internal error.
	Status *string `type:"string" enum:"GameSessionPlacementState"`
	// contains filtered or unexported fields
}

Represents a potential game session placement, including the full details of the original placement request and the current status.

If the game session placement status is PENDING, the properties for game session ID/ARN, region, IP address/DNS, and port aren't final. A game session is not active and ready to accept players until placement status reaches FULFILLED. When the placement is in PENDING status, Amazon GameLift may attempt to place a game session multiple times before succeeding. With each attempt it creates a GameSession object and updates this placement object with the new game session properties..

func (GameSessionPlacement) GoString added in v1.6.27 

func (s GameSessionPlacement) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameSessionPlacement) SetDnsName added in v1.23.14 

func (s *GameSessionPlacement) SetDnsName(v string) *GameSessionPlacement

SetDnsName sets the DnsName field's value.

func (*GameSessionPlacement) SetEndTime added in v1.6.27 

func (s *GameSessionPlacement) SetEndTime(v time.Time) *GameSessionPlacement

SetEndTime sets the EndTime field's value.

func (*GameSessionPlacement) SetGameProperties added in v1.6.27 

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

SetGameProperties sets the GameProperties field's value.

func (*GameSessionPlacement) SetGameSessionArn added in v1.6.27 

func (s *GameSessionPlacement) SetGameSessionArn(v string) *GameSessionPlacement

SetGameSessionArn sets the GameSessionArn field's value.

func (*GameSessionPlacement) SetGameSessionData added in v1.10.27 

func (s *GameSessionPlacement) SetGameSessionData(v string) *GameSessionPlacement

SetGameSessionData sets the GameSessionData field's value.

func (*GameSessionPlacement) SetGameSessionId added in v1.8.12 

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

SetGameSessionId sets the GameSessionId field's value.

func (*GameSessionPlacement) SetGameSessionName added in v1.6.27 

func (s *GameSessionPlacement) SetGameSessionName(v string) *GameSessionPlacement

SetGameSessionName sets the GameSessionName field's value.

func (*GameSessionPlacement) SetGameSessionQueueName added in v1.6.27 

func (s *GameSessionPlacement) SetGameSessionQueueName(v string) *GameSessionPlacement

SetGameSessionQueueName sets the GameSessionQueueName field's value.

func (*GameSessionPlacement) SetGameSessionRegion added in v1.6.27 

func (s *GameSessionPlacement) SetGameSessionRegion(v string) *GameSessionPlacement

SetGameSessionRegion sets the GameSessionRegion field's value.

func (*GameSessionPlacement) SetIpAddress added in v1.8.12 

func (s *GameSessionPlacement) SetIpAddress(v string) *GameSessionPlacement

SetIpAddress sets the IpAddress field's value.

func (*GameSessionPlacement) SetMatchmakerData added in v1.12.73 

func (s *GameSessionPlacement) SetMatchmakerData(v string) *GameSessionPlacement

SetMatchmakerData sets the MatchmakerData field's value.

func (*GameSessionPlacement) SetMaximumPlayerSessionCount added in v1.6.27 

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

SetMaximumPlayerSessionCount sets the MaximumPlayerSessionCount field's value.

func (*GameSessionPlacement) SetPlacedPlayerSessions added in v1.8.12 

func (s *GameSessionPlacement) SetPlacedPlayerSessions(v []*PlacedPlayerSession) *GameSessionPlacement

SetPlacedPlayerSessions sets the PlacedPlayerSessions field's value.

func (*GameSessionPlacement) SetPlacementId added in v1.6.27 

func (s *GameSessionPlacement) SetPlacementId(v string) *GameSessionPlacement

SetPlacementId sets the PlacementId field's value.

func (*GameSessionPlacement) SetPlayerLatencies added in v1.6.27 

func (s *GameSessionPlacement) SetPlayerLatencies(v []*PlayerLatency) *GameSessionPlacement

SetPlayerLatencies sets the PlayerLatencies field's value.

func (*GameSessionPlacement) SetPort added in v1.8.12 

func (s *GameSessionPlacement) SetPort(v int64) *GameSessionPlacement

SetPort sets the Port field's value.

func (*GameSessionPlacement) SetStartTime added in v1.6.27 

func (s *GameSessionPlacement) SetStartTime(v time.Time) *GameSessionPlacement

SetStartTime sets the StartTime field's value.

func (*GameSessionPlacement) SetStatus added in v1.6.27 

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

SetStatus sets the Status field's value.

func (GameSessionPlacement) String added in v1.6.27 

func (s GameSessionPlacement) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GameSessionQueue added in v1.6.27 

type GameSessionQueue struct {

	// Information that is added to all events that are related to this game session
	// queue.
	CustomEventData *string `type:"string"`

	// A list of fleets and/or fleet aliases that can be used to fulfill game session
	// placement requests in the queue. Destinations are identified by either a
	// fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
	Destinations []*GameSessionQueueDestination `type:"list"`

	// A list of locations where a queue is allowed to place new game sessions.
	// Locations are specified in the form of Amazon Web Services Region codes,
	// such as us-west-2. If this parameter is not set, game sessions can be placed
	// in any queue location.
	FilterConfiguration *FilterConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift game session queue resource and uniquely
	// identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue
	// name>. In a Amazon GameLift game session queue ARN, the resource ID matches
	// the Name value.
	GameSessionQueueArn *string `min:"1" type:"string"`

	// A descriptive label that is associated with game session queue. Queue names
	// must be unique within each Region.
	Name *string `min:"1" type:"string"`

	// An SNS topic ARN that is set up to receive game session placement notifications.
	// See Setting up notifications for game session placement (https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html).
	NotificationTarget *string `type:"string"`

	// A set of policies that act as a sliding cap on player latency. FleetIQ works
	// to deliver low latency for most players in a game session. These policies
	// ensure that no individual player can be placed into a game with unreasonably
	// high latency. Use multiple policies to gradually relax latency requirements
	// a step at a time. Multiple policies are applied based on their maximum allowed
	// latency, starting with the lowest value.
	PlayerLatencyPolicies []*PlayerLatencyPolicy `type:"list"`

	// Custom settings to use when prioritizing destinations and locations for game
	// session placements. This configuration replaces the FleetIQ default prioritization
	// process. Priority types that are not explicitly named will be automatically
	// applied at the end of the prioritization process.
	PriorityConfiguration *PriorityConfiguration `type:"structure"`

	// The maximum time, in seconds, that a new game session placement request remains
	// in the queue. When a request exceeds this time, the game session placement
	// changes to a TIMED_OUT status. By default, this property is set to 600.
	TimeoutInSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Configuration for a game session placement mechanism that processes requests for new game sessions. A queue can be used on its own or as part of a matchmaking solution.

func (GameSessionQueue) GoString added in v1.6.27 

func (s GameSessionQueue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameSessionQueue) SetCustomEventData added in v1.38.3 

func (s *GameSessionQueue) SetCustomEventData(v string) *GameSessionQueue

SetCustomEventData sets the CustomEventData field's value.

func (*GameSessionQueue) SetDestinations added in v1.6.27 

func (s *GameSessionQueue) SetDestinations(v []*GameSessionQueueDestination) *GameSessionQueue

SetDestinations sets the Destinations field's value.

func (*GameSessionQueue) SetFilterConfiguration added in v1.37.32 

func (s *GameSessionQueue) SetFilterConfiguration(v *FilterConfiguration) *GameSessionQueue

SetFilterConfiguration sets the FilterConfiguration field's value.

func (*GameSessionQueue) SetGameSessionQueueArn added in v1.8.12 

func (s *GameSessionQueue) SetGameSessionQueueArn(v string) *GameSessionQueue

SetGameSessionQueueArn sets the GameSessionQueueArn field's value.

func (*GameSessionQueue) SetName added in v1.6.27 

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

SetName sets the Name field's value.

func (*GameSessionQueue) SetNotificationTarget added in v1.38.3 

func (s *GameSessionQueue) SetNotificationTarget(v string) *GameSessionQueue

SetNotificationTarget sets the NotificationTarget field's value.

func (*GameSessionQueue) SetPlayerLatencyPolicies added in v1.8.12 

func (s *GameSessionQueue) SetPlayerLatencyPolicies(v []*PlayerLatencyPolicy) *GameSessionQueue

SetPlayerLatencyPolicies sets the PlayerLatencyPolicies field's value.

func (*GameSessionQueue) SetPriorityConfiguration added in v1.37.32 

func (s *GameSessionQueue) SetPriorityConfiguration(v *PriorityConfiguration) *GameSessionQueue

SetPriorityConfiguration sets the PriorityConfiguration field's value.

func (*GameSessionQueue) SetTimeoutInSeconds added in v1.6.27 

func (s *GameSessionQueue) SetTimeoutInSeconds(v int64) *GameSessionQueue

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (GameSessionQueue) String added in v1.6.27 

func (s GameSessionQueue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GameSessionQueueDestination added in v1.6.27 

type GameSessionQueueDestination struct {

	// The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias.
	// ARNs, which include a fleet ID or alias ID and a Region name, provide a unique
	// identifier across all Regions.
	DestinationArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A fleet or alias designated in a game session queue. Queues fulfill requests for new game sessions by placing a new game session on any of the queue's destinations.

func (GameSessionQueueDestination) GoString added in v1.6.27 

func (s GameSessionQueueDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameSessionQueueDestination) SetDestinationArn added in v1.6.27 

func (s *GameSessionQueueDestination) SetDestinationArn(v string) *GameSessionQueueDestination

SetDestinationArn sets the DestinationArn field's value.

func (GameSessionQueueDestination) String added in v1.6.27 

func (s GameSessionQueueDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GameSessionQueueDestination) Validate added in v1.6.27 

func (s *GameSessionQueueDestination) Validate() error

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

type GetComputeAccessInput added in v1.44.151 

type GetComputeAccessInput struct {

	// A unique identifier for the compute resource that you want to connect to.
	// For an EC2 fleet compute, use the instance ID. For a container fleet, use
	// the compute name (for example, a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)
	// or the compute ARN.
	//
	// ComputeName is a required field
	ComputeName *string `type:"string" required:"true"`

	// A unique identifier for the fleet that holds the compute resource that you
	// want to connect to. You can use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetComputeAccessInput) GoString added in v1.44.151 

func (s GetComputeAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComputeAccessInput) SetComputeName added in v1.44.151 

func (s *GetComputeAccessInput) SetComputeName(v string) *GetComputeAccessInput

SetComputeName sets the ComputeName field's value.

func (*GetComputeAccessInput) SetFleetId added in v1.44.151 

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

SetFleetId sets the FleetId field's value.

func (GetComputeAccessInput) String added in v1.44.151 

func (s GetComputeAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComputeAccessInput) Validate added in v1.44.151 

func (s *GetComputeAccessInput) Validate() error

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

type GetComputeAccessOutput added in v1.44.151 

type GetComputeAccessOutput struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to an Amazon GameLift compute resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	ComputeArn *string `type:"string"`

	// The identifier of the compute resource to be accessed. This value might be
	// either a compute name or an instance ID.
	ComputeName *string `type:"string"`

	// A set of temporary Amazon Web Services credentials for use when connecting
	// to the compute resource with Amazon EC2 Systems Manager (SSM).
	//
	// Credentials is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetComputeAccessOutput's
	// String and GoString methods.
	Credentials *AwsCredentials `type:"structure" sensitive:"true"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// The ID of the fleet that holds the compute resource to be accessed.
	FleetId *string `type:"string"`

	// (For container fleets only) The instance ID where the compute resource is
	// running.
	Target *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetComputeAccessOutput) GoString added in v1.44.151 

func (s GetComputeAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComputeAccessOutput) SetComputeArn added in v1.44.151 

func (s *GetComputeAccessOutput) SetComputeArn(v string) *GetComputeAccessOutput

SetComputeArn sets the ComputeArn field's value.

func (*GetComputeAccessOutput) SetComputeName added in v1.44.151 

func (s *GetComputeAccessOutput) SetComputeName(v string) *GetComputeAccessOutput

SetComputeName sets the ComputeName field's value.

func (*GetComputeAccessOutput) SetCredentials added in v1.44.151 

func (s *GetComputeAccessOutput) SetCredentials(v *AwsCredentials) *GetComputeAccessOutput

SetCredentials sets the Credentials field's value.

func (*GetComputeAccessOutput) SetFleetArn added in v1.44.151 

func (s *GetComputeAccessOutput) SetFleetArn(v string) *GetComputeAccessOutput

SetFleetArn sets the FleetArn field's value.

func (*GetComputeAccessOutput) SetFleetId added in v1.44.151 

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

SetFleetId sets the FleetId field's value.

func (*GetComputeAccessOutput) SetTarget added in v1.51.28 

func (s *GetComputeAccessOutput) SetTarget(v string) *GetComputeAccessOutput

SetTarget sets the Target field's value.

func (GetComputeAccessOutput) String added in v1.44.151 

func (s GetComputeAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetComputeAuthTokenInput added in v1.44.151 

type GetComputeAuthTokenInput struct {

	// The name of the compute resource you are requesting the authentication token
	// for. For an Anywhere fleet compute, use the registered compute name. For
	// an EC2 fleet instance, use the instance ID. For a container fleet, use the
	// compute name (for example, a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)
	// or the compute ARN.
	//
	// ComputeName is a required field
	ComputeName *string `type:"string" required:"true"`

	// A unique identifier for the fleet that the compute is registered to.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetComputeAuthTokenInput) GoString added in v1.44.151 

func (s GetComputeAuthTokenInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComputeAuthTokenInput) SetComputeName added in v1.44.151 

func (s *GetComputeAuthTokenInput) SetComputeName(v string) *GetComputeAuthTokenInput

SetComputeName sets the ComputeName field's value.

func (*GetComputeAuthTokenInput) SetFleetId added in v1.44.151 

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

SetFleetId sets the FleetId field's value.

func (GetComputeAuthTokenInput) String added in v1.44.151 

func (s GetComputeAuthTokenInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComputeAuthTokenInput) Validate added in v1.44.151 

func (s *GetComputeAuthTokenInput) Validate() error

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

type GetComputeAuthTokenOutput added in v1.44.151 

type GetComputeAuthTokenOutput struct {

	// A valid temporary authentication token.
	AuthToken *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to an Amazon GameLift compute resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	ComputeArn *string `type:"string"`

	// The name of the compute resource that the authentication token is issued
	// to.
	ComputeName *string `type:"string"`

	// The amount of time until the authentication token is no longer valid.
	ExpirationTimestamp *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that the compute is registered to.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetComputeAuthTokenOutput) GoString added in v1.44.151 

func (s GetComputeAuthTokenOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComputeAuthTokenOutput) SetAuthToken added in v1.44.151 

func (s *GetComputeAuthTokenOutput) SetAuthToken(v string) *GetComputeAuthTokenOutput

SetAuthToken sets the AuthToken field's value.

func (*GetComputeAuthTokenOutput) SetComputeArn added in v1.44.151 

func (s *GetComputeAuthTokenOutput) SetComputeArn(v string) *GetComputeAuthTokenOutput

SetComputeArn sets the ComputeArn field's value.

func (*GetComputeAuthTokenOutput) SetComputeName added in v1.44.151 

func (s *GetComputeAuthTokenOutput) SetComputeName(v string) *GetComputeAuthTokenOutput

SetComputeName sets the ComputeName field's value.

func (*GetComputeAuthTokenOutput) SetExpirationTimestamp added in v1.44.151 

func (s *GetComputeAuthTokenOutput) SetExpirationTimestamp(v time.Time) *GetComputeAuthTokenOutput

SetExpirationTimestamp sets the ExpirationTimestamp field's value.

func (*GetComputeAuthTokenOutput) SetFleetArn added in v1.44.151 

func (s *GetComputeAuthTokenOutput) SetFleetArn(v string) *GetComputeAuthTokenOutput

SetFleetArn sets the FleetArn field's value.

func (*GetComputeAuthTokenOutput) SetFleetId added in v1.44.151 

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

SetFleetId sets the FleetId field's value.

func (GetComputeAuthTokenOutput) String added in v1.44.151 

func (s GetComputeAuthTokenOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetGameSessionLogUrlInput 

type GetGameSessionLogUrlInput struct {

	// A unique identifier for the game session to get logs for.
	//
	// GameSessionId is a required field
	GameSessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetGameSessionLogUrlInput) GoString 

func (s GetGameSessionLogUrlInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetGameSessionLogUrlInput) SetGameSessionId added in v1.5.0 

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

SetGameSessionId sets the GameSessionId field's value.

func (GetGameSessionLogUrlInput) String 

func (s GetGameSessionLogUrlInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. This
	// URL is valid for 15 minutes, after which S3 will reject any download request
	// using this URL. You can request a new URL any time within the 14-day period
	// that the logs are retained.
	PreSignedUrl *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetGameSessionLogUrlOutput) GoString 

func (s GetGameSessionLogUrlOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetGameSessionLogUrlOutput) SetPreSignedUrl added in v1.5.0 

func (s *GetGameSessionLogUrlOutput) SetPreSignedUrl(v string) *GetGameSessionLogUrlOutput

SetPreSignedUrl sets the PreSignedUrl field's value.

func (GetGameSessionLogUrlOutput) String 

func (s GetGameSessionLogUrlOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInstanceAccessInput added in v1.5.8 

type GetInstanceAccessInput struct {

	// A unique identifier for the fleet that contains the instance you want to
	// access. You can request access to instances in EC2 fleets with the following
	// statuses: ACTIVATING, ACTIVE, or ERROR. Use either a fleet ID or an ARN value.
	//
	// You can access fleets in ERROR status for a short period of time before Amazon
	// GameLift deletes them.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// A unique identifier for the instance you want to access. 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstanceAccessInput) SetFleetId added in v1.5.8 

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

SetFleetId sets the FleetId field's value.

func (*GetInstanceAccessInput) SetInstanceId added in v1.5.8 

func (s *GetInstanceAccessInput) SetInstanceId(v string) *GetInstanceAccessInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstanceAccessOutput) SetInstanceAccess added in v1.5.8 

func (s *GetInstanceAccessOutput) SetInstanceAccess(v *InstanceAccess) *GetInstanceAccessOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IdempotentParameterMismatchException added in v1.28.0 

type IdempotentParameterMismatchException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*IdempotentParameterMismatchException) Code added in v1.28.0 

func (s *IdempotentParameterMismatchException) Code() string

Code returns the exception type name.

func (*IdempotentParameterMismatchException) Error added in v1.28.0 

func (s *IdempotentParameterMismatchException) Error() string

func (IdempotentParameterMismatchException) GoString added in v1.28.0 

func (s IdempotentParameterMismatchException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdempotentParameterMismatchException) Message added in v1.28.0 

func (s *IdempotentParameterMismatchException) Message() string

Message returns the exception's message.

func (*IdempotentParameterMismatchException) OrigErr added in v1.28.0 

func (s *IdempotentParameterMismatchException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IdempotentParameterMismatchException) RequestID added in v1.28.0 

func (s *IdempotentParameterMismatchException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IdempotentParameterMismatchException) StatusCode added in v1.28.0 

func (s *IdempotentParameterMismatchException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IdempotentParameterMismatchException) String added in v1.28.0 

func (s IdempotentParameterMismatchException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Instance added in v1.4.17 

type Instance struct {

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

	// The DNS identifier assigned to the instance that is running the game session.
	// Values have the following format:
	//
	//    * TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
	//
	//    * Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com.
	//    (See Amazon Elastic Compute Cloud Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses).)
	//
	// When connecting to a game session that is running on a TLS-enabled fleet,
	// you must use the DNS name, not the IP address.
	DnsName *string `type:"string"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that the instance belongs to.
	FleetId *string `type:"string"`

	// A unique identifier for the instance.
	InstanceId *string `type:"string"`

	// IP address that is assigned to the instance.
	//
	// IpAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Instance's
	// String and GoString methods.
	IpAddress *string `min:"1" type:"string" sensitive:"true"`

	// The fleet location of the instance, expressed as an Amazon Web Services Region
	// code, such as us-west-2.
	Location *string `min:"1" type:"string"`

	// Operating system that is running on this EC2 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 run-time configuration.
	//
	//    * ACTIVE -- The instance has been successfully created and at least one
	//    server process has successfully launched and reported back to Amazon 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
}

Represents a virtual computing instance that runs game server processes and hosts game sessions. In Amazon GameLift, one or more instances make up a managed EC2 fleet.

func (Instance) GoString added in v1.4.17 

func (s Instance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetDnsName added in v1.23.14 

func (s *Instance) SetDnsName(v string) *Instance

SetDnsName sets the DnsName field's value.

func (*Instance) SetFleetArn added in v1.37.32 

func (s *Instance) SetFleetArn(v string) *Instance

SetFleetArn sets the FleetArn 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) SetLocation added in v1.37.32 

func (s *Instance) SetLocation(v string) *Instance

SetLocation sets the Location 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.17 

func (s Instance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceAccess added in v1.5.8 

type InstanceAccess struct {

	// Security credentials that are required to access the instance.
	//
	// Credentials is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InstanceAccess's
	// String and GoString methods.
	Credentials *InstanceCredentials `type:"structure" sensitive:"true"`

	// A unique identifier for the fleet containing the instance to be accessed.
	FleetId *string `type:"string"`

	// A unique identifier for the instance to be accessed.
	InstanceId *string `type:"string"`

	// IP address assigned to the instance.
	//
	// IpAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InstanceAccess's
	// String and GoString methods.
	IpAddress *string `min:"1" type:"string" sensitive:"true"`

	// Operating system that is running on the instance.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`
	// contains filtered or unexported fields
}

Information and credentials that you can use to remotely connect to an instance in an EC2 managed fleet. This data type is returned in response to a call to GetInstanceAccess.

func (InstanceAccess) GoString added in v1.5.8 

func (s InstanceAccess) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceCredentials added in v1.5.8 

type InstanceCredentials struct {

	// Secret string. For Windows instances, the secret is a password for use with
	// Windows Remote Desktop. For Linux instances, it's a private key for use with
	// SSH.
	Secret *string `min:"1" type:"string"`

	// A user name for logging in.
	UserName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A set of credentials that allow remote access to an instance in an EC2 managed fleet. These credentials are returned in response to a call to GetInstanceAccess, which requests access for instances that are running game servers with the Amazon GameLift server SDK version 4.x or earlier.

func (InstanceCredentials) GoString added in v1.5.8 

func (s InstanceCredentials) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceCredentials) SetSecret added in v1.5.8 

func (s *InstanceCredentials) SetSecret(v string) *InstanceCredentials

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceDefinition added in v1.30.3 

type InstanceDefinition struct {

	// An Amazon EC2 instance type designation.
	//
	// InstanceType is a required field
	InstanceType *string `type:"string" required:"true" enum:"GameServerGroupInstanceType"`

	// Instance weighting that indicates how much this instance type contributes
	// to the total capacity of a game server group. Instance weights are used by
	// Amazon GameLift FleetIQ to calculate the instance type's cost per unit hour
	// and better identify the most cost-effective options. For detailed information
	// on weighting instance capacity, see Instance Weighting (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html)
	// in the Amazon Elastic Compute Cloud Auto Scaling User Guide. Default value
	// is "1".
	WeightedCapacity *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift FleetIQ and game server groups.

An allowed instance type for a game server group. All game server groups must have at least two instance types defined for it. Amazon GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.

func (InstanceDefinition) GoString added in v1.30.3 

func (s InstanceDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceDefinition) SetInstanceType added in v1.30.3 

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

SetInstanceType sets the InstanceType field's value.

func (*InstanceDefinition) SetWeightedCapacity added in v1.30.3 

func (s *InstanceDefinition) SetWeightedCapacity(v string) *InstanceDefinition

SetWeightedCapacity sets the WeightedCapacity field's value.

func (InstanceDefinition) String added in v1.30.3 

func (s InstanceDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceDefinition) Validate added in v1.30.3 

func (s *InstanceDefinition) Validate() error

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

type InternalServiceException added in v1.28.0 

type InternalServiceException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InternalServiceException) Code added in v1.28.0 

func (s *InternalServiceException) Code() string

Code returns the exception type name.

func (*InternalServiceException) Error added in v1.28.0 

func (s *InternalServiceException) Error() string

func (InternalServiceException) GoString added in v1.28.0 

func (s InternalServiceException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServiceException) Message added in v1.28.0 

func (s *InternalServiceException) Message() string

Message returns the exception's message.

func (*InternalServiceException) OrigErr added in v1.28.0 

func (s *InternalServiceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceException) RequestID added in v1.28.0 

func (s *InternalServiceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceException) StatusCode added in v1.28.0 

func (s *InternalServiceException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServiceException) String added in v1.28.0 

func (s InternalServiceException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidFleetStatusException added in v1.28.0 

type InvalidFleetStatusException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*InvalidFleetStatusException) Code added in v1.28.0 

func (s *InvalidFleetStatusException) Code() string

Code returns the exception type name.

func (*InvalidFleetStatusException) Error added in v1.28.0 

func (s *InvalidFleetStatusException) Error() string

func (InvalidFleetStatusException) GoString added in v1.28.0 

func (s InvalidFleetStatusException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidFleetStatusException) Message added in v1.28.0 

func (s *InvalidFleetStatusException) Message() string

Message returns the exception's message.

func (*InvalidFleetStatusException) OrigErr added in v1.28.0 

func (s *InvalidFleetStatusException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidFleetStatusException) RequestID added in v1.28.0 

func (s *InvalidFleetStatusException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidFleetStatusException) StatusCode added in v1.28.0 

func (s *InvalidFleetStatusException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidFleetStatusException) String added in v1.28.0 

func (s InvalidFleetStatusException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidGameSessionStatusException added in v1.28.0 

type InvalidGameSessionStatusException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*InvalidGameSessionStatusException) Code added in v1.28.0 

func (s *InvalidGameSessionStatusException) Code() string

Code returns the exception type name.

func (*InvalidGameSessionStatusException) Error added in v1.28.0 

func (s *InvalidGameSessionStatusException) Error() string

func (InvalidGameSessionStatusException) GoString added in v1.28.0 

func (s InvalidGameSessionStatusException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidGameSessionStatusException) Message added in v1.28.0 

func (s *InvalidGameSessionStatusException) Message() string

Message returns the exception's message.

func (*InvalidGameSessionStatusException) OrigErr added in v1.28.0 

func (s *InvalidGameSessionStatusException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidGameSessionStatusException) RequestID added in v1.28.0 

func (s *InvalidGameSessionStatusException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidGameSessionStatusException) StatusCode added in v1.28.0 

func (s *InvalidGameSessionStatusException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidGameSessionStatusException) String added in v1.28.0 

func (s InvalidGameSessionStatusException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException added in v1.28.0 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidRequestException) Code added in v1.28.0 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0 

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message added in v1.28.0 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0 

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IpPermission 

type IpPermission struct {

	// A starting value for a range of allowed port numbers.
	//
	// For fleets using Linux builds, only ports 22 and 1026-60000 are valid.
	//
	// For fleets using Windows builds, only ports 1026-60000 are valid.
	//
	// FromPort is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by IpPermission's
	// String and GoString methods.
	//
	// FromPort is a required field
	FromPort *int64 `min:"1" type:"integer" required:"true" sensitive:"true"`

	// A range of allowed IP addresses. This value must be expressed in CIDR notation.
	// Example: "000.000.000.000/[subnet mask]" or optionally the shortened version
	// "0.0.0.0/[subnet mask]".
	//
	// IpRange is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by IpPermission's
	// String and GoString methods.
	//
	// IpRange is a required field
	IpRange *string `type:"string" required:"true" sensitive:"true"`

	// The network communication protocol used by the fleet.
	//
	// Protocol is a required field
	Protocol *string `type:"string" required:"true" enum:"IpProtocol"`

	// An ending value for a range of allowed port numbers. Port numbers are end-inclusive.
	// This value must be equal to or greater than FromPort.
	//
	// For fleets using Linux builds, only ports 22 and 1026-60000 are valid.
	//
	// For fleets using Windows builds, only ports 1026-60000 are valid.
	//
	// ToPort is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by IpPermission's
	// String and GoString methods.
	//
	// ToPort is a required field
	ToPort *int64 `min:"1" type:"integer" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

A range of IP addresses and port settings that allow inbound traffic to connect to processes on an instance in a fleet. Processes are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For container fleets, the port settings must use the same port numbers as the fleet's connection ports.

For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.

func (IpPermission) GoString 

func (s IpPermission) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 LaunchTemplateSpecification added in v1.30.3 

type LaunchTemplateSpecification struct {

	// A unique identifier for an existing Amazon EC2 launch template.
	LaunchTemplateId *string `min:"1" type:"string"`

	// A readable identifier for an existing Amazon EC2 launch template.
	LaunchTemplateName *string `min:"3" type:"string"`

	// The version of the Amazon EC2 launch template to use. If no version is specified,
	// the default version will be used. With Amazon EC2, you can specify a default
	// version for a launch template. If none is set, the default is the first version
	// created.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift FleetIQ and game server groups.

An Amazon Elastic Compute Cloud launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group.

func (LaunchTemplateSpecification) GoString added in v1.30.3 

func (s LaunchTemplateSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LaunchTemplateSpecification) SetLaunchTemplateId added in v1.30.3 

func (s *LaunchTemplateSpecification) SetLaunchTemplateId(v string) *LaunchTemplateSpecification

SetLaunchTemplateId sets the LaunchTemplateId field's value.

func (*LaunchTemplateSpecification) SetLaunchTemplateName added in v1.30.3 

func (s *LaunchTemplateSpecification) SetLaunchTemplateName(v string) *LaunchTemplateSpecification

SetLaunchTemplateName sets the LaunchTemplateName field's value.

func (*LaunchTemplateSpecification) SetVersion added in v1.30.3 

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

SetVersion sets the Version field's value.

func (LaunchTemplateSpecification) String added in v1.30.3 

func (s LaunchTemplateSpecification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LaunchTemplateSpecification) Validate added in v1.30.3 

func (s *LaunchTemplateSpecification) Validate() error

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

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAliasesInput 

type ListAliasesInput struct {

	// The 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"`

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

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

	// The routing type to filter results on. Use this parameter to retrieve only
	// aliases with a certain routing 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 (https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html)
	//    message embedded.
	RoutingStrategyType *string `type:"string" enum:"RoutingStrategyType"`
	// contains filtered or unexported fields
}

func (ListAliasesInput) GoString 

func (s ListAliasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A collection of alias resources that match the request parameters.
	Aliases []*Alias `type:"list"`

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

func (ListAliasesOutput) GoString 

func (s ListAliasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListBuildsInput 

type ListBuildsInput struct {

	// The 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"`

	// A token that indicates the start of the next sequential page of results.
	// Use the token that is returned with a previous call to this operation. To
	// start at the beginning of the result set, don't 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
}

func (ListBuildsInput) GoString 

func (s ListBuildsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A collection of build resources that match the request.
	Builds []*Build `type:"list"`

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

func (ListBuildsOutput) GoString 

func (s ListBuildsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListComputeInput added in v1.44.151 

type ListComputeInput struct {

	// A unique identifier for the fleet to retrieve compute resources for.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The 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"`

	// The name of a location to retrieve compute resources for. For an Amazon GameLift
	// Anywhere fleet, use a custom location. For a multi-location EC2 or container
	// fleet, provide a Amazon Web Services Region or Local Zone code (for example:
	// us-west-2 or us-west-2-lax-1).
	Location *string `min:"1" type:"string"`

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

func (ListComputeInput) GoString added in v1.44.151 

func (s ListComputeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComputeInput) SetFleetId added in v1.44.151 

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

SetFleetId sets the FleetId field's value.

func (*ListComputeInput) SetLimit added in v1.44.151 

func (s *ListComputeInput) SetLimit(v int64) *ListComputeInput

SetLimit sets the Limit field's value.

func (*ListComputeInput) SetLocation added in v1.44.151 

func (s *ListComputeInput) SetLocation(v string) *ListComputeInput

SetLocation sets the Location field's value.

func (*ListComputeInput) SetNextToken added in v1.44.151 

func (s *ListComputeInput) SetNextToken(v string) *ListComputeInput

SetNextToken sets the NextToken field's value.

func (ListComputeInput) String added in v1.44.151 

func (s ListComputeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComputeInput) Validate added in v1.44.151 

func (s *ListComputeInput) Validate() error

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

type ListComputeOutput added in v1.44.151 

type ListComputeOutput struct {

	// A list of compute resources in the specified fleet.
	ComputeList []*Compute `type:"list"`

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

func (ListComputeOutput) GoString added in v1.44.151 

func (s ListComputeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComputeOutput) SetComputeList added in v1.44.151 

func (s *ListComputeOutput) SetComputeList(v []*Compute) *ListComputeOutput

SetComputeList sets the ComputeList field's value.

func (*ListComputeOutput) SetNextToken added in v1.44.151 

func (s *ListComputeOutput) SetNextToken(v string) *ListComputeOutput

SetNextToken sets the NextToken field's value.

func (ListComputeOutput) String added in v1.44.151 

func (s ListComputeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListContainerGroupDefinitionsInput added in v1.51.28 

type ListContainerGroupDefinitionsInput struct {

	// The 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"`

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

	// The type of container group definitions to retrieve.
	//
	//    * DAEMON -- Daemon container groups run background processes and are deployed
	//    once per fleet instance.
	//
	//    * REPLICA -- Replica container groups run your game server application
	//    and supporting software. Replica groups might be deployed multiple times
	//    per fleet instance.
	SchedulingStrategy *string `type:"string" enum:"ContainerSchedulingStrategy"`
	// contains filtered or unexported fields
}

func (ListContainerGroupDefinitionsInput) GoString added in v1.51.28 

func (s ListContainerGroupDefinitionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContainerGroupDefinitionsInput) SetLimit added in v1.51.28 

func (s *ListContainerGroupDefinitionsInput) SetLimit(v int64) *ListContainerGroupDefinitionsInput

SetLimit sets the Limit field's value.

func (*ListContainerGroupDefinitionsInput) SetNextToken added in v1.51.28 

func (s *ListContainerGroupDefinitionsInput) SetNextToken(v string) *ListContainerGroupDefinitionsInput

SetNextToken sets the NextToken field's value.

func (*ListContainerGroupDefinitionsInput) SetSchedulingStrategy added in v1.51.28 

func (s *ListContainerGroupDefinitionsInput) SetSchedulingStrategy(v string) *ListContainerGroupDefinitionsInput

SetSchedulingStrategy sets the SchedulingStrategy field's value.

func (ListContainerGroupDefinitionsInput) String added in v1.51.28 

func (s ListContainerGroupDefinitionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContainerGroupDefinitionsInput) Validate added in v1.51.28 

func (s *ListContainerGroupDefinitionsInput) Validate() error

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

type ListContainerGroupDefinitionsOutput added in v1.51.28 

type ListContainerGroupDefinitionsOutput struct {

	// A result set of container group definitions that match the request.
	ContainerGroupDefinitions []*ContainerGroupDefinition `type:"list"`

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

func (ListContainerGroupDefinitionsOutput) GoString added in v1.51.28 

func (s ListContainerGroupDefinitionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContainerGroupDefinitionsOutput) SetContainerGroupDefinitions added in v1.51.28 

func (s *ListContainerGroupDefinitionsOutput) SetContainerGroupDefinitions(v []*ContainerGroupDefinition) *ListContainerGroupDefinitionsOutput

SetContainerGroupDefinitions sets the ContainerGroupDefinitions field's value.

func (*ListContainerGroupDefinitionsOutput) SetNextToken added in v1.51.28 

func (s *ListContainerGroupDefinitionsOutput) SetNextToken(v string) *ListContainerGroupDefinitionsOutput

SetNextToken sets the NextToken field's value.

func (ListContainerGroupDefinitionsOutput) String added in v1.51.28 

func (s ListContainerGroupDefinitionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFleetsInput 

type ListFleetsInput struct {

	// A unique identifier for the build to request fleets for. Use this parameter
	// to return only fleets using a specified build. Use either the build ID or
	// ARN value.
	BuildId *string `type:"string"`

	// The container group definition name to request fleets for. Use this parameter
	// to return only fleets that are deployed with the specified container group
	// definition.
	ContainerGroupDefinitionName *string `min:"1" type:"string"`

	// The 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"`

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

	// A unique identifier for the Realtime script to request fleets for. Use this
	// parameter to return only fleets using a specified script. Use either the
	// script ID or ARN value.
	ScriptId *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFleetsInput) GoString 

func (s ListFleetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFleetsInput) SetBuildId added in v1.5.0 

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

SetBuildId sets the BuildId field's value.

func (*ListFleetsInput) SetContainerGroupDefinitionName added in v1.51.28 

func (s *ListFleetsInput) SetContainerGroupDefinitionName(v string) *ListFleetsInput

SetContainerGroupDefinitionName sets the ContainerGroupDefinitionName 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) SetScriptId added in v1.19.18 

func (s *ListFleetsInput) SetScriptId(v string) *ListFleetsInput

SetScriptId sets the ScriptId field's value.

func (ListFleetsInput) String 

func (s ListFleetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A set of fleet IDs that match the list request.
	FleetIds []*string `min:"1" type:"list"`

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

func (ListFleetsOutput) GoString 

func (s ListFleetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListGameServerGroupsInput added in v1.30.3 

type ListGameServerGroupsInput struct {

	// The game server groups' limit.
	Limit *int64 `min:"1" type:"integer"`

	// Specify the pagination token from a previous request to retrieve the next
	// page of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGameServerGroupsInput) GoString added in v1.30.3 

func (s ListGameServerGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGameServerGroupsInput) SetLimit added in v1.30.3 

func (s *ListGameServerGroupsInput) SetLimit(v int64) *ListGameServerGroupsInput

SetLimit sets the Limit field's value.

func (*ListGameServerGroupsInput) SetNextToken added in v1.30.3 

func (s *ListGameServerGroupsInput) SetNextToken(v string) *ListGameServerGroupsInput

SetNextToken sets the NextToken field's value.

func (ListGameServerGroupsInput) String added in v1.30.3 

func (s ListGameServerGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGameServerGroupsInput) Validate added in v1.30.3 

func (s *ListGameServerGroupsInput) Validate() error

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

type ListGameServerGroupsOutput added in v1.30.3 

type ListGameServerGroupsOutput struct {

	// The game server groups' game server groups.
	GameServerGroups []*GameServerGroup `type:"list"`

	// Specify the pagination token from a previous request to retrieve the next
	// page of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGameServerGroupsOutput) GoString added in v1.30.3 

func (s ListGameServerGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGameServerGroupsOutput) SetGameServerGroups added in v1.30.3 

func (s *ListGameServerGroupsOutput) SetGameServerGroups(v []*GameServerGroup) *ListGameServerGroupsOutput

SetGameServerGroups sets the GameServerGroups field's value.

func (*ListGameServerGroupsOutput) SetNextToken added in v1.30.3 

func (s *ListGameServerGroupsOutput) SetNextToken(v string) *ListGameServerGroupsOutput

SetNextToken sets the NextToken field's value.

func (ListGameServerGroupsOutput) String added in v1.30.3 

func (s ListGameServerGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListGameServersInput added in v1.30.3 

type ListGameServersInput struct {

	// An identifier for the game server group to retrieve a list of game servers
	// from. Use either the name or ARN value.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// The 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"`

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

	// Indicates how to sort the returned data based on game server registration
	// timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING
	// to retrieve newest game servers first. If this parameter is left empty, game
	// servers are returned in no particular order.
	SortOrder *string `type:"string" enum:"SortOrder"`
	// contains filtered or unexported fields
}

func (ListGameServersInput) GoString added in v1.30.3 

func (s ListGameServersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGameServersInput) SetGameServerGroupName added in v1.30.3 

func (s *ListGameServersInput) SetGameServerGroupName(v string) *ListGameServersInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*ListGameServersInput) SetLimit added in v1.30.3 

func (s *ListGameServersInput) SetLimit(v int64) *ListGameServersInput

SetLimit sets the Limit field's value.

func (*ListGameServersInput) SetNextToken added in v1.30.3 

func (s *ListGameServersInput) SetNextToken(v string) *ListGameServersInput

SetNextToken sets the NextToken field's value.

func (*ListGameServersInput) SetSortOrder added in v1.30.3 

func (s *ListGameServersInput) SetSortOrder(v string) *ListGameServersInput

SetSortOrder sets the SortOrder field's value.

func (ListGameServersInput) String added in v1.30.3 

func (s ListGameServersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGameServersInput) Validate added in v1.30.3 

func (s *ListGameServersInput) Validate() error

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

type ListGameServersOutput added in v1.30.3 

type ListGameServersOutput struct {

	// A collection of game server objects that match the request.
	GameServers []*GameServer `type:"list"`

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

func (ListGameServersOutput) GoString added in v1.30.3 

func (s ListGameServersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGameServersOutput) SetGameServers added in v1.30.3 

func (s *ListGameServersOutput) SetGameServers(v []*GameServer) *ListGameServersOutput

SetGameServers sets the GameServers field's value.

func (*ListGameServersOutput) SetNextToken added in v1.30.3 

func (s *ListGameServersOutput) SetNextToken(v string) *ListGameServersOutput

SetNextToken sets the NextToken field's value.

func (ListGameServersOutput) String added in v1.30.3 

func (s ListGameServersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLocationsInput added in v1.44.151 

type ListLocationsInput struct {

	// Filters the list for AWS or CUSTOM locations.
	Filters []*string `min:"1" type:"list" enum:"LocationFilter"`

	// The 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"`

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

func (ListLocationsInput) GoString added in v1.44.151 

func (s ListLocationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLocationsInput) SetFilters added in v1.44.151 

func (s *ListLocationsInput) SetFilters(v []*string) *ListLocationsInput

SetFilters sets the Filters field's value.

func (*ListLocationsInput) SetLimit added in v1.44.151 

func (s *ListLocationsInput) SetLimit(v int64) *ListLocationsInput

SetLimit sets the Limit field's value.

func (*ListLocationsInput) SetNextToken added in v1.44.151 

func (s *ListLocationsInput) SetNextToken(v string) *ListLocationsInput

SetNextToken sets the NextToken field's value.

func (ListLocationsInput) String added in v1.44.151 

func (s ListLocationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLocationsInput) Validate added in v1.44.151 

func (s *ListLocationsInput) Validate() error

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

type ListLocationsOutput added in v1.44.151 

type ListLocationsOutput struct {

	// A collection of locations.
	Locations []*LocationModel `type:"list"`

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

func (ListLocationsOutput) GoString added in v1.44.151 

func (s ListLocationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLocationsOutput) SetLocations added in v1.44.151 

func (s *ListLocationsOutput) SetLocations(v []*LocationModel) *ListLocationsOutput

SetLocations sets the Locations field's value.

func (*ListLocationsOutput) SetNextToken added in v1.44.151 

func (s *ListLocationsOutput) SetNextToken(v string) *ListLocationsOutput

SetNextToken sets the NextToken field's value.

func (ListLocationsOutput) String added in v1.44.151 

func (s ListLocationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListScriptsInput added in v1.19.18 

type ListScriptsInput struct {

	// The 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"`

	// A token that indicates the start of the next sequential page of results.
	// Use the token that is returned with a previous call to this operation. To
	// start at the beginning of the result set, don't specify a value.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListScriptsInput) GoString added in v1.19.18 

func (s ListScriptsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScriptsInput) SetLimit added in v1.19.18 

func (s *ListScriptsInput) SetLimit(v int64) *ListScriptsInput

SetLimit sets the Limit field's value.

func (*ListScriptsInput) SetNextToken added in v1.19.18 

func (s *ListScriptsInput) SetNextToken(v string) *ListScriptsInput

SetNextToken sets the NextToken field's value.

func (ListScriptsInput) String added in v1.19.18 

func (s ListScriptsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScriptsInput) Validate added in v1.19.18 

func (s *ListScriptsInput) Validate() error

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

type ListScriptsOutput added in v1.19.18 

type ListScriptsOutput struct {

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

	// A set of properties describing the requested script.
	Scripts []*Script `type:"list"`
	// contains filtered or unexported fields
}

func (ListScriptsOutput) GoString added in v1.19.18 

func (s ListScriptsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScriptsOutput) SetNextToken added in v1.19.18 

func (s *ListScriptsOutput) SetNextToken(v string) *ListScriptsOutput

SetNextToken sets the NextToken field's value.

func (*ListScriptsOutput) SetScripts added in v1.19.18 

func (s *ListScriptsOutput) SetScripts(v []*Script) *ListScriptsOutput

SetScripts sets the Scripts field's value.

func (ListScriptsOutput) String added in v1.19.18 

func (s ListScriptsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.26.6 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that uniquely identifies the Amazon GameLift resource that you want to retrieve
	// tags for. Amazon GameLift includes resource ARNs in the data object for the
	// resource. You can retrieve the ARN by calling a List or Describe operation
	// for the resource type.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.26.6 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN added in v1.26.6 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.26.6 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.26.6 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.26.6 

type ListTagsForResourceOutput struct {

	// The collection of tags assigned to the resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.26.6 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.26.6 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.26.6 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LocationAttributes added in v1.37.32 

type LocationAttributes struct {

	// A fleet location and its current life-cycle state.
	LocationState *LocationState `type:"structure"`

	// A list of fleet actions that have been suspended in the fleet location.
	StoppedActions []*string `min:"1" type:"list" enum:"FleetAction"`

	// The status of fleet activity updates to the location. The status PENDING_UPDATE
	// indicates that StopFleetActions or StartFleetActions has been requested but
	// the update has not yet been completed for the location.
	UpdateStatus *string `type:"string" enum:"LocationUpdateStatus"`
	// contains filtered or unexported fields
}

Details about a location in a multi-location fleet.

func (LocationAttributes) GoString added in v1.37.32 

func (s LocationAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LocationAttributes) SetLocationState added in v1.37.32 

func (s *LocationAttributes) SetLocationState(v *LocationState) *LocationAttributes

SetLocationState sets the LocationState field's value.

func (*LocationAttributes) SetStoppedActions added in v1.37.32 

func (s *LocationAttributes) SetStoppedActions(v []*string) *LocationAttributes

SetStoppedActions sets the StoppedActions field's value.

func (*LocationAttributes) SetUpdateStatus added in v1.37.32 

func (s *LocationAttributes) SetUpdateStatus(v string) *LocationAttributes

SetUpdateStatus sets the UpdateStatus field's value.

func (LocationAttributes) String added in v1.37.32 

func (s LocationAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LocationConfiguration added in v1.37.32 

type LocationConfiguration struct {

	// An Amazon Web Services Region code, such as us-west-2.
	//
	// Location is a required field
	Location *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

A remote location where a multi-location fleet can deploy game servers for game hosting.

func (LocationConfiguration) GoString added in v1.37.32 

func (s LocationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LocationConfiguration) SetLocation added in v1.37.32 

func (s *LocationConfiguration) SetLocation(v string) *LocationConfiguration

SetLocation sets the Location field's value.

func (LocationConfiguration) String added in v1.37.32 

func (s LocationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LocationConfiguration) Validate added in v1.37.32 

func (s *LocationConfiguration) Validate() error

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

type LocationModel added in v1.44.151 

type LocationModel struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift location resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	LocationArn *string `min:"1" type:"string"`

	// The location's name.
	LocationName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Properties of a custom location for use in an Amazon GameLift Anywhere fleet. This data type is returned in response to a call to https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html).

func (LocationModel) GoString added in v1.44.151 

func (s LocationModel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LocationModel) SetLocationArn added in v1.44.151 

func (s *LocationModel) SetLocationArn(v string) *LocationModel

SetLocationArn sets the LocationArn field's value.

func (*LocationModel) SetLocationName added in v1.44.151 

func (s *LocationModel) SetLocationName(v string) *LocationModel

SetLocationName sets the LocationName field's value.

func (LocationModel) String added in v1.44.151 

func (s LocationModel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LocationState added in v1.37.32 

type LocationState struct {

	// The fleet location, expressed as an Amazon Web Services Region code such
	// as us-west-2.
	Location *string `min:"1" type:"string"`

	// The life-cycle status of a fleet location.
	Status *string `type:"string" enum:"FleetStatus"`
	// contains filtered or unexported fields
}

A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.

  • NEW -- A new fleet location has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet location, creating new instances with the game build or Realtime script and starting server processes.

  • ACTIVE -- Hosts can now accept game sessions.

  • ERROR -- An error occurred when downloading, validating, building, or activating the fleet location.

  • DELETING -- Hosts are responding to a delete fleet location request.

  • TERMINATED -- The fleet location no longer exists.

  • NOT_FOUND -- The fleet location was not found. This could be because the custom location was removed or not created.

func (LocationState) GoString added in v1.37.32 

func (s LocationState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LocationState) SetLocation added in v1.37.32 

func (s *LocationState) SetLocation(v string) *LocationState

SetLocation sets the Location field's value.

func (*LocationState) SetStatus added in v1.37.32 

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

SetStatus sets the Status field's value.

func (LocationState) String added in v1.37.32 

func (s LocationState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MatchedPlayerSession added in v1.10.27 

type MatchedPlayerSession struct {

	// A unique identifier for a player
	//
	// PlayerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by MatchedPlayerSession's
	// String and GoString methods.
	PlayerId *string `min:"1" type:"string" sensitive:"true"`

	// A unique identifier for a player session
	PlayerSessionId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a new player session that is created as a result of a successful FlexMatch match. A successful match automatically creates new player sessions for every player ID in the original matchmaking request.

When players connect to the match's game session, they must include both player ID and player session ID in order to claim their assigned player slot.

func (MatchedPlayerSession) GoString added in v1.10.27 

func (s MatchedPlayerSession) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MatchedPlayerSession) SetPlayerId added in v1.10.27 

func (s *MatchedPlayerSession) SetPlayerId(v string) *MatchedPlayerSession

SetPlayerId sets the PlayerId field's value.

func (*MatchedPlayerSession) SetPlayerSessionId added in v1.10.27 

func (s *MatchedPlayerSession) SetPlayerSessionId(v string) *MatchedPlayerSession

SetPlayerSessionId sets the PlayerSessionId field's value.

func (MatchedPlayerSession) String added in v1.10.27 

func (s MatchedPlayerSession) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MatchmakingConfiguration added in v1.10.27 

type MatchmakingConfiguration struct {

	// A flag that indicates whether a match that was created with this configuration
	// must be accepted by the matched players. To require acceptance, set to TRUE.
	// When this option is enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE
	// to indicate when a completed potential match is waiting for player acceptance.
	AcceptanceRequired *bool `type:"boolean"`

	// The length of time (in seconds) to wait for players to accept a proposed
	// match, if acceptance is required. If any player rejects the match or fails
	// to accept before the timeout, the ticket continues to look for an acceptable
	// match.
	AcceptanceTimeoutSeconds *int64 `min:"1" type:"integer"`

	// The number of player slots in a match to keep open for future players. For
	// example, if the configuration's rule set specifies a match for a single 10-person
	// team, and the additional player count is set to 2, 10 players will be selected
	// for the match and 2 more player slots will be open for future players. This
	// parameter is not used when FlexMatchMode is set to STANDALONE.
	AdditionalPlayerCount *int64 `type:"integer"`

	// The method used to backfill game sessions created with this matchmaking configuration.
	// MANUAL indicates that the game makes backfill requests or does not use the
	// match backfill feature. AUTOMATIC indicates that GameLift creates backfill
	// requests whenever a game session has one or more open slots. Learn more about
	// manual and automatic backfill in Backfill existing games with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html).
	// Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
	BackfillMode *string `type:"string" enum:"BackfillMode"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift matchmaking configuration resource
	// and uniquely identifies it. ARNs are unique across all Regions. Format is
	// arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking configuration
	// name>. In a Amazon GameLift configuration ARN, the resource ID matches the
	// Name value.
	ConfigurationArn *string `type:"string"`

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

	// Information to attach to all events related to the matchmaking configuration.
	CustomEventData *string `type:"string"`

	// A descriptive label that is associated with matchmaking configuration.
	Description *string `min:"1" type:"string"`

	// Indicates whether this matchmaking configuration is being used with Amazon
	// GameLift hosting or as a standalone matchmaking solution.
	//
	//    * STANDALONE - FlexMatch forms matches and returns match information,
	//    including players and team assignments, in a MatchmakingSucceeded (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded)
	//    event.
	//
	//    * WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift
	//    queue to start a game session for the match.
	FlexMatchMode *string `type:"string" enum:"FlexMatchMode"`

	// A set of key-value pairs that can store custom data in a game session. For
	// example: {"Key": "difficulty", "Value": "novice"}. This information is added
	// to the new GameSession object that is created for a successful match. This
	// parameter is not used when FlexMatchMode is set to STANDALONE.
	GameProperties []*GameProperty `type:"list"`

	// A set of custom game session properties, formatted as a single string value.
	// This data is passed to a game server process with a request to start a new
	// game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
	// This information is added to the new GameSession object that is created for
	// a successful match. This parameter is not used when FlexMatchMode is set
	// to STANDALONE.
	GameSessionData *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift game session queue resource and uniquely
	// identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue
	// name>. Queues can be located in any Region. Queues are used to start new
	// Amazon GameLift-hosted game sessions for matches that are created with this
	// matchmaking configuration. This property is not set when FlexMatchMode is
	// set to STANDALONE.
	GameSessionQueueArns []*string `type:"list"`

	// A unique identifier for the matchmaking configuration. This name is used
	// to identify the configuration associated with a matchmaking request or ticket.
	Name *string `type:"string"`

	// An SNS topic ARN that is set up to receive matchmaking notifications.
	NotificationTarget *string `type:"string"`

	// The maximum duration, in seconds, that a matchmaking ticket can remain in
	// process before timing out. Requests that fail due to timing out can be resubmitted
	// as needed.
	RequestTimeoutSeconds *int64 `min:"1" type:"integer"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// associated with the GameLift matchmaking rule set resource that this configuration
	// uses.
	RuleSetArn *string `type:"string"`

	// A unique identifier for the matchmaking rule set to use with this configuration.
	// A matchmaking configuration can only use rule sets that are defined in the
	// same Region.
	RuleSetName *string `type:"string"`
	// contains filtered or unexported fields
}

Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.

func (MatchmakingConfiguration) GoString added in v1.10.27 

func (s MatchmakingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MatchmakingConfiguration) SetAcceptanceRequired added in v1.10.27 

func (s *MatchmakingConfiguration) SetAcceptanceRequired(v bool) *MatchmakingConfiguration

SetAcceptanceRequired sets the AcceptanceRequired field's value.

func (*MatchmakingConfiguration) SetAcceptanceTimeoutSeconds added in v1.10.27 

func (s *MatchmakingConfiguration) SetAcceptanceTimeoutSeconds(v int64) *MatchmakingConfiguration

SetAcceptanceTimeoutSeconds sets the AcceptanceTimeoutSeconds field's value.

func (*MatchmakingConfiguration) SetAdditionalPlayerCount added in v1.10.27 

func (s *MatchmakingConfiguration) SetAdditionalPlayerCount(v int64) *MatchmakingConfiguration

SetAdditionalPlayerCount sets the AdditionalPlayerCount field's value.

func (*MatchmakingConfiguration) SetBackfillMode added in v1.20.17 

func (s *MatchmakingConfiguration) SetBackfillMode(v string) *MatchmakingConfiguration

SetBackfillMode sets the BackfillMode field's value.

func (*MatchmakingConfiguration) SetConfigurationArn added in v1.26.6 

func (s *MatchmakingConfiguration) SetConfigurationArn(v string) *MatchmakingConfiguration

SetConfigurationArn sets the ConfigurationArn field's value.

func (*MatchmakingConfiguration) SetCreationTime added in v1.10.27 

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

SetCreationTime sets the CreationTime field's value.

func (*MatchmakingConfiguration) SetCustomEventData added in v1.10.27 

func (s *MatchmakingConfiguration) SetCustomEventData(v string) *MatchmakingConfiguration

SetCustomEventData sets the CustomEventData field's value.

func (*MatchmakingConfiguration) SetDescription added in v1.10.27 

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

SetDescription sets the Description field's value.

func (*MatchmakingConfiguration) SetFlexMatchMode added in v1.35.35 

func (s *MatchmakingConfiguration) SetFlexMatchMode(v string) *MatchmakingConfiguration

SetFlexMatchMode sets the FlexMatchMode field's value.

func (*MatchmakingConfiguration) SetGameProperties added in v1.10.27 

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

SetGameProperties sets the GameProperties field's value.

func (*MatchmakingConfiguration) SetGameSessionData added in v1.10.27 

func (s *MatchmakingConfiguration) SetGameSessionData(v string) *MatchmakingConfiguration

SetGameSessionData sets the GameSessionData field's value.

func (*MatchmakingConfiguration) SetGameSessionQueueArns added in v1.10.27 

func (s *MatchmakingConfiguration) SetGameSessionQueueArns(v []*string) *MatchmakingConfiguration

SetGameSessionQueueArns sets the GameSessionQueueArns field's value.

func (*MatchmakingConfiguration) SetName added in v1.10.27 

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

SetName sets the Name field's value.

func (*MatchmakingConfiguration) SetNotificationTarget added in v1.10.27 

func (s *MatchmakingConfiguration) SetNotificationTarget(v string) *MatchmakingConfiguration

SetNotificationTarget sets the NotificationTarget field's value.

func (*MatchmakingConfiguration) SetRequestTimeoutSeconds added in v1.10.27 

func (s *MatchmakingConfiguration) SetRequestTimeoutSeconds(v int64) *MatchmakingConfiguration

SetRequestTimeoutSeconds sets the RequestTimeoutSeconds field's value.

func (*MatchmakingConfiguration) SetRuleSetArn added in v1.26.6 

func (s *MatchmakingConfiguration) SetRuleSetArn(v string) *MatchmakingConfiguration

SetRuleSetArn sets the RuleSetArn field's value.

func (*MatchmakingConfiguration) SetRuleSetName added in v1.10.27 

func (s *MatchmakingConfiguration) SetRuleSetName(v string) *MatchmakingConfiguration

SetRuleSetName sets the RuleSetName field's value.

func (MatchmakingConfiguration) String added in v1.10.27 

func (s MatchmakingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MatchmakingRuleSet added in v1.10.27 

type MatchmakingRuleSet struct {

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

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely
	// identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset
	// name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName
	// value.
	RuleSetArn *string `type:"string"`

	// A collection of matchmaking rules, formatted as a JSON string. Comments are
	// not allowed in JSON, but most elements support a description field.
	//
	// RuleSetBody is a required field
	RuleSetBody *string `min:"1" type:"string" required:"true"`

	// A unique identifier for the matchmaking rule set
	RuleSetName *string `type:"string"`
	// contains filtered or unexported fields
}

Set of rule statements, used with FlexMatch, that determine how to build your player matches. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches.

A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch rule set (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html).

  • Teams -- Required. A rule set must define one or multiple teams for the match and set minimum and maximum team sizes. For example, a rule set might describe a 4x4 match that requires all eight slots to be filled.

  • Player attributes -- Optional. These attributes specify a set of player characteristics to evaluate when looking for a match. Matchmaking requests that use a rule set with player attributes must provide the corresponding attribute values. For example, an attribute might specify a player's skill or level.

  • Rules -- Optional. Rules define how to evaluate potential players for a match based on player attributes. A rule might specify minimum requirements for individual players, teams, or entire matches. For example, a rule might require each player to meet a certain skill level, each team to have at least one player in a certain role, or the match to have a minimum average skill level. or may describe an entire group--such as all teams must be evenly matched or have at least one player in a certain role.

  • Expansions -- Optional. Expansions allow you to relax the rules after a period of time when no acceptable matches are found. This feature lets you balance getting players into games in a reasonable amount of time instead of making them wait indefinitely for the best possible match. For example, you might use an expansion to increase the maximum skill variance between players after 30 seconds.

func (MatchmakingRuleSet) GoString added in v1.10.27 

func (s MatchmakingRuleSet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MatchmakingRuleSet) SetCreationTime added in v1.10.27 

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

SetCreationTime sets the CreationTime field's value.

func (*MatchmakingRuleSet) SetRuleSetArn added in v1.26.6 

func (s *MatchmakingRuleSet) SetRuleSetArn(v string) *MatchmakingRuleSet

SetRuleSetArn sets the RuleSetArn field's value.

func (*MatchmakingRuleSet) SetRuleSetBody added in v1.10.27 

func (s *MatchmakingRuleSet) SetRuleSetBody(v string) *MatchmakingRuleSet

SetRuleSetBody sets the RuleSetBody field's value.

func (*MatchmakingRuleSet) SetRuleSetName added in v1.10.27 

func (s *MatchmakingRuleSet) SetRuleSetName(v string) *MatchmakingRuleSet

SetRuleSetName sets the RuleSetName field's value.

func (MatchmakingRuleSet) String added in v1.10.27 

func (s MatchmakingRuleSet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MatchmakingTicket added in v1.10.27 

type MatchmakingTicket struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// associated with the GameLift matchmaking configuration resource that is used
	// with this ticket.
	ConfigurationArn *string `type:"string"`

	// Name of the matchmaking configuration that is used with this ticket. Matchmaking
	// configurations determine how players are grouped into a match and how a new
	// game session is created for the match.
	ConfigurationName *string `type:"string"`

	// Time stamp indicating when the matchmaking request stopped being processed
	// due to successful completion, timeout, or cancellation. Format is a number
	// expressed in Unix time as milliseconds (for example "1469498468.057").
	EndTime *time.Time `type:"timestamp"`

	// Average amount of time (in seconds) that players are currently waiting for
	// a match. If there is not enough recent data, this property may be empty.
	EstimatedWaitTime *int64 `type:"integer"`

	// Connection information for a new game session. Once a match is made, the
	// FlexMatch engine creates a new game session for it. This information is added
	// to the matchmaking ticket, which you can be retrieve by calling DescribeMatchmaking
	// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeMatchmaking.html) .
	GameSessionConnectionInfo *GameSessionConnectionInfo `type:"structure"`

	// A set of Player objects, each representing a player to find matches for.
	// Players are identified by a unique player ID and may include latency data
	// for use during matchmaking. If the ticket is in status COMPLETED, the Player
	// objects include the team the players were assigned to in the resulting match.
	Players []*Player `type:"list"`

	// Time stamp indicating when this matchmaking request was received. Format
	// is a number expressed in Unix time as milliseconds (for example "1469498468.057").
	StartTime *time.Time `type:"timestamp"`

	// Current status of the matchmaking request.
	//
	//    * QUEUED -- The matchmaking request has been received and is currently
	//    waiting to be processed.
	//
	//    * SEARCHING -- The matchmaking request is currently being processed.
	//
	//    * REQUIRES_ACCEPTANCE -- A match has been proposed and the players must
	//    accept the match. This status is used only with requests that use a matchmaking
	//    configuration with a player acceptance requirement.
	//
	//    * PLACING -- The FlexMatch engine has matched players and is in the process
	//    of placing a new game session for the match.
	//
	//    * COMPLETED -- Players have been matched and a game session is ready to
	//    host the players. A ticket in this state contains the necessary connection
	//    information for players.
	//
	//    * FAILED -- The matchmaking request was not completed.
	//
	//    * CANCELLED -- The matchmaking request was canceled. This may be the result
	//    of a StopMatchmaking operation or a proposed match that one or more players
	//    failed to accept.
	//
	//    * TIMED_OUT -- The matchmaking request was not successful within the duration
	//    specified in the matchmaking configuration.
	//
	// Matchmaking requests that fail to successfully complete (statuses FAILED,
	// CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket
	// IDs.
	Status *string `type:"string" enum:"MatchmakingConfigurationStatus"`

	// Additional information about the current status.
	StatusMessage *string `type:"string"`

	// Code to explain the current status. For example, a status reason may indicate
	// when a ticket has returned to SEARCHING status after a proposed match fails
	// to receive player acceptances.
	StatusReason *string `type:"string"`

	// A unique identifier for a matchmaking ticket.
	TicketId *string `type:"string"`
	// contains filtered or unexported fields
}

Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request.

func (MatchmakingTicket) GoString added in v1.10.27 

func (s MatchmakingTicket) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MatchmakingTicket) SetConfigurationArn added in v1.26.6 

func (s *MatchmakingTicket) SetConfigurationArn(v string) *MatchmakingTicket

SetConfigurationArn sets the ConfigurationArn field's value.

func (*MatchmakingTicket) SetConfigurationName added in v1.10.27 

func (s *MatchmakingTicket) SetConfigurationName(v string) *MatchmakingTicket

SetConfigurationName sets the ConfigurationName field's value.

func (*MatchmakingTicket) SetEndTime added in v1.10.37 

func (s *MatchmakingTicket) SetEndTime(v time.Time) *MatchmakingTicket

SetEndTime sets the EndTime field's value.

func (*MatchmakingTicket) SetEstimatedWaitTime added in v1.10.37 

func (s *MatchmakingTicket) SetEstimatedWaitTime(v int64) *MatchmakingTicket

SetEstimatedWaitTime sets the EstimatedWaitTime field's value.

func (*MatchmakingTicket) SetGameSessionConnectionInfo added in v1.10.27 

func (s *MatchmakingTicket) SetGameSessionConnectionInfo(v *GameSessionConnectionInfo) *MatchmakingTicket

SetGameSessionConnectionInfo sets the GameSessionConnectionInfo field's value.

func (*MatchmakingTicket) SetPlayers added in v1.10.27 

func (s *MatchmakingTicket) SetPlayers(v []*Player) *MatchmakingTicket

SetPlayers sets the Players field's value.

func (*MatchmakingTicket) SetStartTime added in v1.10.27 

func (s *MatchmakingTicket) SetStartTime(v time.Time) *MatchmakingTicket

SetStartTime sets the StartTime field's value.

func (*MatchmakingTicket) SetStatus added in v1.10.27 

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

SetStatus sets the Status field's value.

func (*MatchmakingTicket) SetStatusMessage added in v1.10.27 

func (s *MatchmakingTicket) SetStatusMessage(v string) *MatchmakingTicket

SetStatusMessage sets the StatusMessage field's value.

func (*MatchmakingTicket) SetStatusReason added in v1.10.27 

func (s *MatchmakingTicket) SetStatusReason(v string) *MatchmakingTicket

SetStatusReason sets the StatusReason field's value.

func (*MatchmakingTicket) SetTicketId added in v1.10.27 

func (s *MatchmakingTicket) SetTicketId(v string) *MatchmakingTicket

SetTicketId sets the TicketId field's value.

func (MatchmakingTicket) String added in v1.10.27 

func (s MatchmakingTicket) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotFoundException added in v1.28.0 

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

THe requested resources was not found. The resource was either not created yet or deleted.

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotReadyException added in v1.51.28 

type NotReadyException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter (http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/).

func (*NotReadyException) Code added in v1.51.28 

func (s *NotReadyException) Code() string

Code returns the exception type name.

func (*NotReadyException) Error added in v1.51.28 

func (s *NotReadyException) Error() string

func (NotReadyException) GoString added in v1.51.28 

func (s NotReadyException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotReadyException) Message added in v1.51.28 

func (s *NotReadyException) Message() string

Message returns the exception's message.

func (*NotReadyException) OrigErr added in v1.51.28 

func (s *NotReadyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotReadyException) RequestID added in v1.51.28 

func (s *NotReadyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotReadyException) StatusCode added in v1.51.28 

func (s *NotReadyException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotReadyException) String added in v1.51.28 

func (s NotReadyException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OutOfCapacityException added in v1.30.3 

type OutOfCapacityException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The specified game server group has no available game servers to fulfill a ClaimGameServer request. Clients can retry such requests immediately or after a waiting period.

func (*OutOfCapacityException) Code added in v1.30.3 

func (s *OutOfCapacityException) Code() string

Code returns the exception type name.

func (*OutOfCapacityException) Error added in v1.30.3 

func (s *OutOfCapacityException) Error() string

func (OutOfCapacityException) GoString added in v1.30.3 

func (s OutOfCapacityException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutOfCapacityException) Message added in v1.30.3 

func (s *OutOfCapacityException) Message() string

Message returns the exception's message.

func (*OutOfCapacityException) OrigErr added in v1.30.3 

func (s *OutOfCapacityException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OutOfCapacityException) RequestID added in v1.30.3 

func (s *OutOfCapacityException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OutOfCapacityException) StatusCode added in v1.30.3 

func (s *OutOfCapacityException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OutOfCapacityException) String added in v1.30.3 

func (s OutOfCapacityException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PlacedPlayerSession added in v1.8.12 

type PlacedPlayerSession struct {

	// A unique identifier for a player that is associated with this player session.
	//
	// PlayerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PlacedPlayerSession's
	// String and GoString methods.
	PlayerId *string `min:"1" type:"string" sensitive:"true"`

	// A unique identifier for a player session.
	PlayerSessionId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a player session. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribePlayerSessions.html) with the player session ID.

func (PlacedPlayerSession) GoString added in v1.8.12 

func (s PlacedPlayerSession) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlacedPlayerSession) SetPlayerId added in v1.8.12 

func (s *PlacedPlayerSession) SetPlayerId(v string) *PlacedPlayerSession

SetPlayerId sets the PlayerId field's value.

func (*PlacedPlayerSession) SetPlayerSessionId added in v1.8.12 

func (s *PlacedPlayerSession) SetPlayerSessionId(v string) *PlacedPlayerSession

SetPlayerSessionId sets the PlayerSessionId field's value.

func (PlacedPlayerSession) String added in v1.8.12 

func (s PlacedPlayerSession) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Player added in v1.10.27 

type Player struct {

	// A set of values, expressed in milliseconds, that indicates the amount of
	// latency that a player experiences when connected to @aws; Regions. If this
	// property is present, FlexMatch considers placing the match only in Regions
	// for which latency is reported.
	//
	// If a matchmaker has a rule that evaluates player latency, players must report
	// latency in order to be matched. If no latency is reported in this scenario,
	// FlexMatch assumes that no Regions are available to the player and the ticket
	// is not matchable.
	LatencyInMs map[string]*int64 `type:"map"`

	// A collection of key:value pairs containing player information for use in
	// matchmaking. Player attribute keys must match the playerAttributes used in
	// a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"},
	// "gameMode": {"S": "deathmatch"}}.
	//
	// You can provide up to 10 PlayerAttributes.
	PlayerAttributes map[string]*AttributeValue `type:"map"`

	// A unique identifier for a player
	//
	// PlayerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Player's
	// String and GoString methods.
	PlayerId *string `min:"1" type:"string" sensitive:"true"`

	// Name of the team that the player is assigned to in a match. Team names are
	// defined in a matchmaking rule set.
	Team *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.

func (Player) GoString added in v1.10.27 

func (s Player) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Player) SetLatencyInMs added in v1.10.27 

func (s *Player) SetLatencyInMs(v map[string]*int64) *Player

SetLatencyInMs sets the LatencyInMs field's value.

func (*Player) SetPlayerAttributes added in v1.10.27 

func (s *Player) SetPlayerAttributes(v map[string]*AttributeValue) *Player

SetPlayerAttributes sets the PlayerAttributes field's value.

func (*Player) SetPlayerId added in v1.10.27 

func (s *Player) SetPlayerId(v string) *Player

SetPlayerId sets the PlayerId field's value.

func (*Player) SetTeam added in v1.10.27 

func (s *Player) SetTeam(v string) *Player

SetTeam sets the Team field's value.

func (Player) String added in v1.10.27 

func (s Player) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Player) Validate added in v1.10.27 

func (s *Player) Validate() error

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

type PlayerLatency added in v1.6.27 

type PlayerLatency struct {

	// Amount of time that represents the time lag experienced by the player when
	// connected to the specified Region.
	LatencyInMilliseconds *float64 `type:"float"`

	// A unique identifier for a player associated with the latency data.
	//
	// PlayerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PlayerLatency's
	// String and GoString methods.
	PlayerId *string `min:"1" type:"string" sensitive:"true"`

	// Name of the Region that is associated with the latency value.
	RegionIdentifier *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Regional latency information for a player, used when requesting a new game session. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified Region. The relative difference between a player's latency values for multiple Regions are used to determine which fleets are best suited to place a new game session for the player.

func (PlayerLatency) GoString added in v1.6.27 

func (s PlayerLatency) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlayerLatency) SetLatencyInMilliseconds added in v1.6.27 

func (s *PlayerLatency) SetLatencyInMilliseconds(v float64) *PlayerLatency

SetLatencyInMilliseconds sets the LatencyInMilliseconds field's value.

func (*PlayerLatency) SetPlayerId added in v1.6.27 

func (s *PlayerLatency) SetPlayerId(v string) *PlayerLatency

SetPlayerId sets the PlayerId field's value.

func (*PlayerLatency) SetRegionIdentifier added in v1.6.27 

func (s *PlayerLatency) SetRegionIdentifier(v string) *PlayerLatency

SetRegionIdentifier sets the RegionIdentifier field's value.

func (PlayerLatency) String added in v1.6.27 

func (s PlayerLatency) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlayerLatency) Validate added in v1.6.27 

func (s *PlayerLatency) Validate() error

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

type PlayerLatencyPolicy added in v1.8.12 

type PlayerLatencyPolicy struct {

	// The maximum latency value that is allowed for any player, in milliseconds.
	// All policies must have a value set for this property.
	MaximumIndividualPlayerLatencyMilliseconds *int64 `type:"integer"`

	// The length of time, in seconds, that the policy is enforced while placing
	// a new game session. A null value for this property means that the policy
	// is enforced until the queue times out.
	PolicyDurationSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Sets a latency cap for individual players when placing a game session. With a latency policy in force, a game session cannot be placed in a fleet location where a player reports latency higher than the cap. Latency policies are used only with placement request that provide player latency information. Player latency policies can be stacked to gradually relax latency requirements over time.

func (PlayerLatencyPolicy) GoString added in v1.8.12 

func (s PlayerLatencyPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlayerLatencyPolicy) SetMaximumIndividualPlayerLatencyMilliseconds added in v1.8.12 

func (s *PlayerLatencyPolicy) SetMaximumIndividualPlayerLatencyMilliseconds(v int64) *PlayerLatencyPolicy

SetMaximumIndividualPlayerLatencyMilliseconds sets the MaximumIndividualPlayerLatencyMilliseconds field's value.

func (*PlayerLatencyPolicy) SetPolicyDurationSeconds added in v1.8.12 

func (s *PlayerLatencyPolicy) SetPolicyDurationSeconds(v int64) *PlayerLatencyPolicy

SetPolicyDurationSeconds sets the PolicyDurationSeconds field's value.

func (PlayerLatencyPolicy) String added in v1.8.12 

func (s PlayerLatencyPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PlayerSession 

type PlayerSession struct {

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

	// The DNS identifier assigned to the instance that is running the game session.
	// Values have the following format:
	//
	//    * TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
	//
	//    * Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com.
	//    (See Amazon EC2 Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses).)
	//
	// When connecting to a game session that is running on a TLS-enabled fleet,
	// you must use the DNS name, not the IP address.
	DnsName *string `type:"string"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// associated with the GameLift fleet that the player's game session is running
	// on.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that the player's game session is running
	// on.
	FleetId *string `type:"string"`

	// A unique identifier for the game session that the player session is connected
	// to.
	GameSessionId *string `min:"1" type:"string"`

	// The IP address of the game session. To connect to a Amazon GameLift game
	// server, an app needs both the IP address and port number.
	//
	// IpAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PlayerSession's
	// String and GoString methods.
	IpAddress *string `min:"1" type:"string" sensitive:"true"`

	// Developer-defined information related to a player. Amazon GameLift does not
	// use this data, so it can be formatted as needed for use in the game.
	PlayerData *string `min:"1" type:"string"`

	// A unique identifier for a player that is associated with this player session.
	//
	// PlayerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PlayerSession's
	// String and GoString methods.
	PlayerId *string `min:"1" type:"string" sensitive:"true"`

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

	// Port number for the game session. To connect to a Amazon GameLift server
	// process, an app needs both the IP address and port number.
	//
	// Port is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PlayerSession's
	// String and GoString methods.
	Port *int64 `min:"1" type:"integer" sensitive:"true"`

	// 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 timeout limit (60 seconds).
	Status *string `type:"string" enum:"PlayerSessionStatus"`

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

Represents a player session. Player sessions are created either for a specific game session, or as part of a game session placement or matchmaking request. A player session can represents a reserved player slot in a game session (when status is RESERVED) or actual player activity in a game session (when status is ACTIVE). A player session object, including player data, is automatically passed to a game session when the player connects to the game session and is validated. After the game session ends, player sessions information is retained for 30 days and then removed.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

func (PlayerSession) GoString 

func (s PlayerSession) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetDnsName added in v1.23.14 

func (s *PlayerSession) SetDnsName(v string) *PlayerSession

SetDnsName sets the DnsName field's value.

func (*PlayerSession) SetFleetArn added in v1.26.6 

func (s *PlayerSession) SetFleetArn(v string) *PlayerSession

SetFleetArn sets the FleetArn 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) SetPlayerData added in v1.6.27 

func (s *PlayerSession) SetPlayerData(v string) *PlayerSession

SetPlayerData sets the PlayerData 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PriorityConfiguration added in v1.37.32 

type PriorityConfiguration struct {

	// The prioritization order to use for fleet locations, when the PriorityOrder
	// property includes LOCATION. Locations are identified by Amazon Web Services
	// Region codes such as us-west-2. Each location can only be listed once.
	LocationOrder []*string `min:"1" type:"list"`

	// The recommended sequence to use when prioritizing where to place new game
	// sessions. Each type can only be listed once.
	//
	//    * LATENCY -- FleetIQ prioritizes locations where the average player latency
	//    (provided in each game session request) is lowest.
	//
	//    * COST -- FleetIQ prioritizes destinations with the lowest current hosting
	//    costs. Cost is evaluated based on the location, instance type, and fleet
	//    type (Spot or On-Demand) for each destination in the queue.
	//
	//    * DESTINATION -- FleetIQ prioritizes based on the order that destinations
	//    are listed in the queue configuration.
	//
	//    * LOCATION -- FleetIQ prioritizes based on the provided order of locations,
	//    as defined in LocationOrder.
	PriorityOrder []*string `min:"1" type:"list" enum:"PriorityType"`
	// contains filtered or unexported fields
}

Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers. When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:

  • If player latency data is included in a game session request, destinations and locations are prioritized first based on lowest average latency (1), then on lowest hosting cost (2), then on destination list order (3), and finally on location (alphabetical) (4). This approach ensures that the queue's top priority is to place game sessions where average player latency is lowest, and--if latency is the same--where the hosting cost is less, etc.

  • If player latency data is not included, destinations and locations are prioritized first on destination list order (1), and then on location (alphabetical) (2). This approach ensures that the queue's top priority is to place game sessions on the first destination fleet listed. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically).

Changing the priority order will affect how game sessions are placed.

func (PriorityConfiguration) GoString added in v1.37.32 

func (s PriorityConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PriorityConfiguration) SetLocationOrder added in v1.37.32 

func (s *PriorityConfiguration) SetLocationOrder(v []*string) *PriorityConfiguration

SetLocationOrder sets the LocationOrder field's value.

func (*PriorityConfiguration) SetPriorityOrder added in v1.37.32 

func (s *PriorityConfiguration) SetPriorityOrder(v []*string) *PriorityConfiguration

SetPriorityOrder sets the PriorityOrder field's value.

func (PriorityConfiguration) String added in v1.37.32 

func (s PriorityConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PriorityConfiguration) Validate added in v1.37.32 

func (s *PriorityConfiguration) Validate() error

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

type PutScalingPolicyInput added in v1.1.10 

type PutScalingPolicyInput struct {

	// Comparison operator to use when measuring the 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"`

	// A unique identifier for the fleet to apply this policy to. You can use either
	// the fleet ID or ARN value. The fleet cannot be in any of the following statuses:
	// ERROR or DELETING.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Name of the Amazon GameLift-defined metric that is used to trigger a scaling
	// adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon
	// GameLift with Amazon CloudWatch (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html).
	//
	//    * ActivatingGameSessions -- Game sessions in the process of being created.
	//
	//    * ActiveGameSessions -- Game sessions that are currently running.
	//
	//    * ActiveInstances -- Fleet instances that are currently running at least
	//    one game session.
	//
	//    * AvailableGameSessions -- Additional game sessions that fleet could host
	//    simultaneously, given current capacity.
	//
	//    * AvailablePlayerSessions -- Empty player slots in currently active game
	//    sessions. This includes game sessions that are not currently accepting
	//    players. Reserved player slots are not included.
	//
	//    * CurrentPlayerSessions -- Player slots in active game sessions that are
	//    being used by a player or are reserved for a player.
	//
	//    * IdleInstances -- Active instances that are currently hosting zero game
	//    sessions.
	//
	//    * PercentAvailableGameSessions -- Unused percentage of the total number
	//    of game sessions that a fleet could host simultaneously, given current
	//    capacity. Use this metric for a target-based scaling policy.
	//
	//    * PercentIdleInstances -- Percentage of the total number of active instances
	//    that are hosting zero game sessions.
	//
	//    * QueueDepth -- Pending game session placement requests, in any queue,
	//    where the current fleet is the top-priority destination.
	//
	//    * WaitTime -- Current wait time for pending game session placement requests,
	//    in any queue, where the current fleet is the top-priority destination.
	//
	// MetricName is a required field
	MetricName *string `type:"string" required:"true" enum:"MetricName"`

	// A descriptive label that is associated with a fleet's 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"`

	// The type of scaling policy to create. For a target-based policy, set the
	// parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration.
	// For a rule-based policy set the following parameters: MetricName, ComparisonOperator,
	// Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
	PolicyType *string `type:"string" enum:"PolicyType"`

	// Amount of adjustment to make, based on the scaling adjustment type.
	ScalingAdjustment *int64 `type:"integer"`

	// The type of adjustment to make to a fleet's instance count:
	//
	//    * 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 *string `type:"string" enum:"ScalingAdjustmentType"`

	// An object that contains settings for a target-based scaling policy.
	TargetConfiguration *TargetConfiguration `type:"structure"`

	// Metric value used to trigger a scaling event.
	Threshold *float64 `type:"double"`
	// contains filtered or unexported fields
}

func (PutScalingPolicyInput) GoString added in v1.1.10 

func (s PutScalingPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

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 

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

SetName sets the Name field's value.

func (*PutScalingPolicyInput) SetPolicyType added in v1.13.46 

func (s *PutScalingPolicyInput) SetPolicyType(v string) *PutScalingPolicyInput

SetPolicyType sets the PolicyType 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) SetTargetConfiguration added in v1.13.46 

func (s *PutScalingPolicyInput) SetTargetConfiguration(v *TargetConfiguration) *PutScalingPolicyInput

SetTargetConfiguration sets the TargetConfiguration field's value.

func (*PutScalingPolicyInput) SetThreshold added in v1.5.0 

func (s *PutScalingPolicyInput) SetThreshold(v float64) *PutScalingPolicyInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A descriptive label that is associated with a fleet's scaling policy. Policy
	// names do not need to be unique.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutScalingPolicyOutput) GoString added in v1.1.10 

func (s PutScalingPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutScalingPolicyOutput) SetName added in v1.5.0 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterComputeInput added in v1.44.151 

type RegisterComputeInput struct {

	// The path to a TLS certificate on your compute resource. Amazon GameLift doesn't
	// validate the path and certificate.
	CertificatePath *string `min:"1" type:"string"`

	// A descriptive label for the compute resource.
	//
	// ComputeName is a required field
	ComputeName *string `min:"1" type:"string" required:"true"`

	// The DNS name of the compute resource. Amazon GameLift requires either a DNS
	// name or IP address.
	DnsName *string `min:"1" type:"string"`

	// A unique identifier for the fleet to register the compute to. You can use
	// either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The IP address of the compute resource. Amazon GameLift requires either a
	// DNS name or IP address.
	//
	// IpAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RegisterComputeInput's
	// String and GoString methods.
	IpAddress *string `min:"1" type:"string" sensitive:"true"`

	// The name of a custom location to associate with the compute resource being
	// registered.
	Location *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RegisterComputeInput) GoString added in v1.44.151 

func (s RegisterComputeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterComputeInput) SetCertificatePath added in v1.44.151 

func (s *RegisterComputeInput) SetCertificatePath(v string) *RegisterComputeInput

SetCertificatePath sets the CertificatePath field's value.

func (*RegisterComputeInput) SetComputeName added in v1.44.151 

func (s *RegisterComputeInput) SetComputeName(v string) *RegisterComputeInput

SetComputeName sets the ComputeName field's value.

func (*RegisterComputeInput) SetDnsName added in v1.44.151 

func (s *RegisterComputeInput) SetDnsName(v string) *RegisterComputeInput

SetDnsName sets the DnsName field's value.

func (*RegisterComputeInput) SetFleetId added in v1.44.151 

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

SetFleetId sets the FleetId field's value.

func (*RegisterComputeInput) SetIpAddress added in v1.44.151 

func (s *RegisterComputeInput) SetIpAddress(v string) *RegisterComputeInput

SetIpAddress sets the IpAddress field's value.

func (*RegisterComputeInput) SetLocation added in v1.44.151 

func (s *RegisterComputeInput) SetLocation(v string) *RegisterComputeInput

SetLocation sets the Location field's value.

func (RegisterComputeInput) String added in v1.44.151 

func (s RegisterComputeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterComputeInput) Validate added in v1.44.151 

func (s *RegisterComputeInput) Validate() error

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

type RegisterComputeOutput added in v1.44.151 

type RegisterComputeOutput struct {

	// The details of the compute resource you registered.
	Compute *Compute `type:"structure"`
	// contains filtered or unexported fields
}

func (RegisterComputeOutput) GoString added in v1.44.151 

func (s RegisterComputeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterComputeOutput) SetCompute added in v1.44.151 

func (s *RegisterComputeOutput) SetCompute(v *Compute) *RegisterComputeOutput

SetCompute sets the Compute field's value.

func (RegisterComputeOutput) String added in v1.44.151 

func (s RegisterComputeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterGameServerInput added in v1.30.3 

type RegisterGameServerInput struct {

	// Information that is needed to make inbound client connections to the game
	// server. This might include the IP address and port, DNS name, and other information.
	ConnectionInfo *string `min:"1" type:"string"`

	// A set of custom game server properties, formatted as a single string value.
	// This data is passed to a game client or service when it requests information
	// on game servers.
	GameServerData *string `min:"1" type:"string"`

	// A unique identifier for the game server group where the game server is running.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// A custom string that uniquely identifies the game server to register. Game
	// server IDs are developer-defined and must be unique across all game server
	// groups in your Amazon Web Services account.
	//
	// GameServerId is a required field
	GameServerId *string `min:"3" type:"string" required:"true"`

	// The unique identifier for the instance where the game server is running.
	// This ID is available in the instance metadata. EC2 instance IDs use a 17-character
	// format, for example: i-1234567890abcdef0.
	//
	// InstanceId is a required field
	InstanceId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterGameServerInput) GoString added in v1.30.3 

func (s RegisterGameServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterGameServerInput) SetConnectionInfo added in v1.30.3 

func (s *RegisterGameServerInput) SetConnectionInfo(v string) *RegisterGameServerInput

SetConnectionInfo sets the ConnectionInfo field's value.

func (*RegisterGameServerInput) SetGameServerData added in v1.30.3 

func (s *RegisterGameServerInput) SetGameServerData(v string) *RegisterGameServerInput

SetGameServerData sets the GameServerData field's value.

func (*RegisterGameServerInput) SetGameServerGroupName added in v1.30.3 

func (s *RegisterGameServerInput) SetGameServerGroupName(v string) *RegisterGameServerInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*RegisterGameServerInput) SetGameServerId added in v1.30.3 

func (s *RegisterGameServerInput) SetGameServerId(v string) *RegisterGameServerInput

SetGameServerId sets the GameServerId field's value.

func (*RegisterGameServerInput) SetInstanceId added in v1.30.3 

func (s *RegisterGameServerInput) SetInstanceId(v string) *RegisterGameServerInput

SetInstanceId sets the InstanceId field's value.

func (RegisterGameServerInput) String added in v1.30.3 

func (s RegisterGameServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterGameServerInput) Validate added in v1.30.3 

func (s *RegisterGameServerInput) Validate() error

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

type RegisterGameServerOutput added in v1.30.3 

type RegisterGameServerOutput struct {

	// Object that describes the newly registered game server.
	GameServer *GameServer `type:"structure"`
	// contains filtered or unexported fields
}

func (RegisterGameServerOutput) GoString added in v1.30.3 

func (s RegisterGameServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterGameServerOutput) SetGameServer added in v1.30.3 

func (s *RegisterGameServerOutput) SetGameServer(v *GameServer) *RegisterGameServerOutput

SetGameServer sets the GameServer field's value.

func (RegisterGameServerOutput) String added in v1.30.3 

func (s RegisterGameServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReplicaContainerGroupCounts added in v1.51.28 

type ReplicaContainerGroupCounts struct {

	// The number of container groups that have active game sessions.
	ACTIVE *int64 `type:"integer"`

	// The number of container groups that have no active game sessions.
	IDLE *int64 `type:"integer"`

	// The number of container groups that are starting up but have not yet registered.
	PENDING *int64 `type:"integer"`

	// The number of container groups that are in the process of shutting down.
	TERMINATING *int64 `type:"integer"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

The number and status of replica container groups that are deployed across a fleet with compute type CONTAINER. This information, combined with the number of server processes being hosted per container group (see RuntimeConfiguration), tells you how many game sessions the fleet is currently capable of hosting concurrently.

Returned by: DescribeFleetCapacity, DescribeFleetLocationCapacity

func (ReplicaContainerGroupCounts) GoString added in v1.51.28 

func (s ReplicaContainerGroupCounts) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplicaContainerGroupCounts) SetACTIVE added in v1.51.28 

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

SetACTIVE sets the ACTIVE field's value.

func (*ReplicaContainerGroupCounts) SetIDLE added in v1.51.28 

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

SetIDLE sets the IDLE field's value.

func (*ReplicaContainerGroupCounts) SetPENDING added in v1.51.28 

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

SetPENDING sets the PENDING field's value.

func (*ReplicaContainerGroupCounts) SetTERMINATING added in v1.51.28 

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

SetTERMINATING sets the TERMINATING field's value.

func (ReplicaContainerGroupCounts) String added in v1.51.28 

func (s ReplicaContainerGroupCounts) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RequestUploadCredentialsInput 

type RequestUploadCredentialsInput struct {

	// A unique identifier for the build to get credentials for. You can use either
	// the build ID or ARN value.
	//
	// BuildId is a required field
	BuildId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RequestUploadCredentialsInput) GoString 

func (s RequestUploadCredentialsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RequestUploadCredentialsInput) SetBuildId added in v1.5.0 

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

SetBuildId sets the BuildId field's value.

func (RequestUploadCredentialsInput) String 

func (s RequestUploadCredentialsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Amazon Web Services 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RequestUploadCredentialsOutput's
	// String and GoString methods.
	UploadCredentials *AwsCredentials `type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

func (RequestUploadCredentialsOutput) GoString 

func (s RequestUploadCredentialsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RequestUploadCredentialsOutput) SetStorageLocation added in v1.5.0 

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

SetStorageLocation sets the StorageLocation field's value.

func (*RequestUploadCredentialsOutput) SetUploadCredentials added in v1.5.0 

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

SetUploadCredentials sets the UploadCredentials field's value.

func (RequestUploadCredentialsOutput) String 

func (s RequestUploadCredentialsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResolveAliasInput 

type ResolveAliasInput struct {

	// The unique identifier of the alias that you want to retrieve a fleet ID for.
	// You can use either the alias ID or ARN value.
	//
	// AliasId is a required field
	AliasId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ResolveAliasInput) GoString 

func (s ResolveAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// associated with the GameLift fleet resource that this alias points to.
	FleetArn *string `type:"string"`

	// The fleet identifier that the alias is pointing to.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

func (ResolveAliasOutput) GoString 

func (s ResolveAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResolveAliasOutput) SetFleetArn added in v1.26.6 

func (s *ResolveAliasOutput) SetFleetArn(v string) *ResolveAliasOutput

SetFleetArn sets the FleetArn field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceCreationLimitPolicy added in v1.4.17 

type ResourceCreationLimitPolicy struct {

	// A policy that puts limits on the number of game sessions that a player can
	// create within a specified span of time. With this policy, you can control
	// players' ability to consume available resources.
	//
	// The policy is evaluated when a player tries to create a new game session.
	// On receiving a CreateGameSession request, Amazon GameLift checks that the
	// player (identified by CreatorId) has created fewer than game session limit
	// in the specified time period.
	NewGameSessionsPerCreator *int64 `type:"integer"`

	// The time span used in evaluating the resource creation limit policy.
	PolicyPeriodInMinutes *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.

The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

func (ResourceCreationLimitPolicy) GoString added in v1.4.17 

func (s ResourceCreationLimitPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ResourceCreationLimitPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResumeGameServerGroupInput added in v1.30.3 

type ResumeGameServerGroupInput struct {

	// A unique identifier for the game server group. Use either the name or ARN
	// value.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// The activity to resume for this game server group.
	//
	// ResumeActions is a required field
	ResumeActions []*string `min:"1" type:"list" required:"true" enum:"GameServerGroupAction"`
	// contains filtered or unexported fields
}

func (ResumeGameServerGroupInput) GoString added in v1.30.3 

func (s ResumeGameServerGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResumeGameServerGroupInput) SetGameServerGroupName added in v1.30.3 

func (s *ResumeGameServerGroupInput) SetGameServerGroupName(v string) *ResumeGameServerGroupInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*ResumeGameServerGroupInput) SetResumeActions added in v1.30.3 

func (s *ResumeGameServerGroupInput) SetResumeActions(v []*string) *ResumeGameServerGroupInput

SetResumeActions sets the ResumeActions field's value.

func (ResumeGameServerGroupInput) String added in v1.30.3 

func (s ResumeGameServerGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResumeGameServerGroupInput) Validate added in v1.30.3 

func (s *ResumeGameServerGroupInput) Validate() error

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

type ResumeGameServerGroupOutput added in v1.30.3 

type ResumeGameServerGroupOutput struct {

	// An object that describes the game server group resource, with the SuspendedActions
	// property updated to reflect the resumed activity.
	GameServerGroup *GameServerGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (ResumeGameServerGroupOutput) GoString added in v1.30.3 

func (s ResumeGameServerGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResumeGameServerGroupOutput) SetGameServerGroup added in v1.30.3 

func (s *ResumeGameServerGroupOutput) SetGameServerGroup(v *GameServerGroup) *ResumeGameServerGroupOutput

SetGameServerGroup sets the GameServerGroup field's value.

func (ResumeGameServerGroupOutput) String added in v1.30.3 

func (s ResumeGameServerGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RoutingStrategy 

type RoutingStrategy struct {

	// A unique identifier for the fleet that the alias points to. This value is
	// the fleet ID, not the fleet ARN.
	FleetId *string `type:"string"`

	// The message text to be used with a terminal routing strategy.
	Message *string `type:"string"`

	// The type of routing strategy for the alias.
	//
	// 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 message embedded.
	Type *string `type:"string" enum:"RoutingStrategyType"`
	// contains filtered or unexported fields
}

The routing configuration for a fleet alias.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

func (RoutingStrategy) GoString 

func (s RoutingStrategy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuntimeConfiguration added in v1.2.1 

type RuntimeConfiguration struct {

	// The maximum amount of time (in seconds) allowed to launch a new game session
	// and have it report ready to host players. During this time, the game session
	// is in status ACTIVATING. If the game session does not become active before
	// the timeout, it is ended and the game session status is changed to TERMINATED.
	GameSessionActivationTimeoutSeconds *int64 `min:"1" type:"integer"`

	// The number of game sessions in status ACTIVATING to allow on an instance
	// or container. This setting limits the instance resources that can be used
	// for new game activations at any one time.
	MaxConcurrentGameSessionActivations *int64 `min:"1" type:"integer"`

	// A collection of server process configurations that identify what server processes
	// to run on fleet computes.
	ServerProcesses []*ServerProcess `min:"1" type:"list"`
	// contains filtered or unexported fields
}

This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

A set of instructions that define the set of server processes to run on computes in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. Amazon GameLift launches the processes, manages their life cycle, and replaces them as needed. Computes check regularly for an updated runtime configuration.

On a container fleet, the Amazon GameLift Agent uses the runtime configuration to manage the lifecycle of server processes in a replica container group.

An Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes defined in a runtime configuration, add the values of the ConcurrentExecutions parameter for each server process. Learn more about Running Multiple Processes on a Fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html).

func (RuntimeConfiguration) GoString added in v1.2.1 

func (s RuntimeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuntimeConfiguration) SetGameSessionActivationTimeoutSeconds added in v1.8.24 

func (s *RuntimeConfiguration) SetGameSessionActivationTimeoutSeconds(v int64) *RuntimeConfiguration

SetGameSessionActivationTimeoutSeconds sets the GameSessionActivationTimeoutSeconds field's value.

func (*RuntimeConfiguration) SetMaxConcurrentGameSessionActivations added in v1.8.24 

func (s *RuntimeConfiguration) SetMaxConcurrentGameSessionActivations(v int64) *RuntimeConfiguration

SetMaxConcurrentGameSessionActivations sets the MaxConcurrentGameSessionActivations field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// An Amazon S3 bucket identifier. Thename of the S3 bucket.
	//
	// Amazon GameLift doesn't support uploading from Amazon S3 buckets with names
	// that contain a dot (.).
	Bucket *string `min:"1" type:"string"`

	// The name of the zip file that contains the build files or script files.
	Key *string `min:"1" type:"string"`

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

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// for an IAM role that allows Amazon GameLift to access the S3 bucket.
	RoleArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The location in Amazon S3 where build or script files are stored for access by Amazon GameLift.

func (S3Location) GoString 

func (s S3Location) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetObjectVersion added in v1.19.18 

func (s *S3Location) SetObjectVersion(v string) *S3Location

SetObjectVersion sets the ObjectVersion 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that is associated with this scaling policy.
	FleetId *string `type:"string"`

	// The fleet location.
	Location *string `min:"1" type:"string"`

	// Name of the Amazon GameLift-defined metric that is used to trigger a scaling
	// adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon
	// GameLift with Amazon CloudWatch (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html).
	//
	//    * ActivatingGameSessions -- Game sessions in the process of being created.
	//
	//    * ActiveGameSessions -- Game sessions that are currently running.
	//
	//    * ActiveInstances -- Fleet instances that are currently running at least
	//    one game session.
	//
	//    * AvailableGameSessions -- Additional game sessions that fleet could host
	//    simultaneously, given current capacity.
	//
	//    * AvailablePlayerSessions -- Empty player slots in currently active game
	//    sessions. This includes game sessions that are not currently accepting
	//    players. Reserved player slots are not included.
	//
	//    * CurrentPlayerSessions -- Player slots in active game sessions that are
	//    being used by a player or are reserved for a player.
	//
	//    * IdleInstances -- Active instances that are currently hosting zero game
	//    sessions.
	//
	//    * PercentAvailableGameSessions -- Unused percentage of the total number
	//    of game sessions that a fleet could host simultaneously, given current
	//    capacity. Use this metric for a target-based scaling policy.
	//
	//    * PercentIdleInstances -- Percentage of the total number of active instances
	//    that are hosting zero game sessions.
	//
	//    * QueueDepth -- Pending game session placement requests, in any queue,
	//    where the current fleet is the top-priority destination.
	//
	//    * WaitTime -- Current wait time for pending game session placement requests,
	//    in any queue, where the current fleet is the top-priority destination.
	MetricName *string `type:"string" enum:"MetricName"`

	// A descriptive label that is associated with a fleet's scaling policy. Policy
	// names do not need to be unique.
	Name *string `min:"1" type:"string"`

	// The type of scaling policy to create. For a target-based policy, set the
	// parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration.
	// For a rule-based policy set the following parameters: MetricName, ComparisonOperator,
	// Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
	PolicyType *string `type:"string" enum:"PolicyType"`

	// Amount of adjustment to make, based on the scaling adjustment type.
	ScalingAdjustment *int64 `type:"integer"`

	// The type of adjustment to make to a fleet's instance count.
	//
	//    * 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 can be in force
	// only when in an ACTIVE status. Scaling policies can be suspended for individual
	// fleets. If the policy is suspended for a fleet, the policy status does not
	// change.
	//
	//    * ACTIVE -- The scaling policy can be used for auto-scaling a fleet.
	//
	//    * 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"`

	// An object that contains settings for a target-based scaling policy.
	TargetConfiguration *TargetConfiguration `type:"structure"`

	// Metric value used to trigger a scaling event.
	Threshold *float64 `type:"double"`

	// The current status of the fleet's scaling policies in a requested fleet location.
	// The status PENDING_UPDATE indicates that an update was requested for the
	// fleet but has not yet been completed for the location.
	UpdateStatus *string `type:"string" enum:"LocationUpdateStatus"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetFleetArn added in v1.37.32 

func (s *ScalingPolicy) SetFleetArn(v string) *ScalingPolicy

SetFleetArn sets the FleetArn 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) SetLocation added in v1.37.32 

func (s *ScalingPolicy) SetLocation(v string) *ScalingPolicy

SetLocation sets the Location 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) SetPolicyType added in v1.13.46 

func (s *ScalingPolicy) SetPolicyType(v string) *ScalingPolicy

SetPolicyType sets the PolicyType 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) SetTargetConfiguration added in v1.13.46 

func (s *ScalingPolicy) SetTargetConfiguration(v *TargetConfiguration) *ScalingPolicy

SetTargetConfiguration sets the TargetConfiguration 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) SetUpdateStatus added in v1.37.32 

func (s *ScalingPolicy) SetUpdateStatus(v string) *ScalingPolicy

SetUpdateStatus sets the UpdateStatus field's value.

func (ScalingPolicy) String added in v1.1.10 

func (s ScalingPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Script added in v1.19.18 

type Script struct {

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

	// A descriptive label that is associated with a script. Script names don't
	// need to be unique.
	Name *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift script resource and uniquely identifies
	// it. ARNs are unique across all Regions. In a GameLift script ARN, the resource
	// ID matches the ScriptId value.
	ScriptArn *string `type:"string"`

	// A unique identifier for the Realtime script
	ScriptId *string `type:"string"`

	// The file size of the uploaded Realtime script, expressed in bytes. When files
	// are uploaded from an S3 location, this value remains at "0".
	SizeOnDisk *int64 `min:"1" type:"long"`

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

	// Version information associated with a build or script. Version strings don't
	// need to be unique.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Properties describing a Realtime script.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

func (Script) GoString added in v1.19.18 

func (s Script) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Script) SetCreationTime added in v1.19.18 

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

SetCreationTime sets the CreationTime field's value.

func (*Script) SetName added in v1.19.18 

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

SetName sets the Name field's value.

func (*Script) SetScriptArn added in v1.26.6 

func (s *Script) SetScriptArn(v string) *Script

SetScriptArn sets the ScriptArn field's value.

func (*Script) SetScriptId added in v1.19.18 

func (s *Script) SetScriptId(v string) *Script

SetScriptId sets the ScriptId field's value.

func (*Script) SetSizeOnDisk added in v1.19.18 

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

SetSizeOnDisk sets the SizeOnDisk field's value.

func (*Script) SetStorageLocation added in v1.19.18 

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

SetStorageLocation sets the StorageLocation field's value.

func (*Script) SetVersion added in v1.19.18 

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

SetVersion sets the Version field's value.

func (Script) String added in v1.19.18 

func (s Script) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchGameSessionsInput added in v1.3.1 

type SearchGameSessionsInput struct {

	// A unique identifier for the alias associated with the fleet to search for
	// active game sessions. You can use either the alias ID or ARN value. 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, gameSessionProperties, maximumSessions, creationTimeMillis,
	//    playerSessionCount, hasAvailablePlayerSessions.
	//
	//    * Comparator -- Valid comparators are: =, <>, <, >, <=, >=.
	//
	//    * Value -- Value to be searched for. Values may be numbers, boolean values
	//    (true/false) or strings depending on the operand. String values are case
	//    sensitive and must be 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"`

	// A unique identifier for the fleet to search for active game sessions. You
	// can use either the fleet ID or ARN value. Each request must reference either
	// a fleet ID or alias ID, but not both.
	FleetId *string `type:"string"`

	// The 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"`

	// A fleet location to search for game sessions. You can specify a fleet's home
	// Region or a remote location. Use the Amazon Web Services Region code format,
	// such as us-west-2.
	Location *string `min:"1" type:"string"`

	// A token that indicates the start of the next sequential page of results.
	// Use the token that is returned with a previous call to this operation. To
	// start at the beginning of the result set, do not specify a value.
	NextToken *string `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, gameSessionProperties, maximumSessions, creationTimeMillis,
	//    playerSessionCount, 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
}

func (SearchGameSessionsInput) GoString added in v1.3.1 

func (s SearchGameSessionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchGameSessionsInput) SetAliasId added in v1.5.0 

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

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 

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

SetFleetId sets the FleetId field's value.

func (*SearchGameSessionsInput) SetLimit added in v1.5.0 

func (s *SearchGameSessionsInput) SetLimit(v int64) *SearchGameSessionsInput

SetLimit sets the Limit field's value.

func (*SearchGameSessionsInput) SetLocation added in v1.37.32 

func (s *SearchGameSessionsInput) SetLocation(v string) *SearchGameSessionsInput

SetLocation sets the Location field's value.

func (*SearchGameSessionsInput) SetNextToken added in v1.5.0 

func (s *SearchGameSessionsInput) SetNextToken(v string) *SearchGameSessionsInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A collection of objects containing game session properties for each session
	// that matches the request.
	GameSessions []*GameSession `type:"list"`

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

func (SearchGameSessionsOutput) GoString added in v1.3.1 

func (s SearchGameSessionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchGameSessionsOutput) SetGameSessions added in v1.5.0 

func (s *SearchGameSessionsOutput) SetGameSessions(v []*GameSession) *SearchGameSessionsOutput

SetGameSessions sets the GameSessions field's value.

func (*SearchGameSessionsOutput) SetNextToken added in v1.5.0 

func (s *SearchGameSessionsOutput) SetNextToken(v string) *SearchGameSessionsOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServerProcess added in v1.2.1 

type ServerProcess struct {

	// The number of server processes using this configuration that run concurrently
	// on each instance or container..
	//
	// ConcurrentExecutions is a required field
	ConcurrentExecutions *int64 `min:"1" type:"integer" required:"true"`

	// The location of a game build executable or Realtime script. Game builds and
	// Realtime scripts are installed on instances at the root:
	//
	//    * Windows (custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"
	//
	//    * Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"
	//
	// Amazon GameLift doesn't support the use of setup scripts that launch the
	// game executable. For custom game builds, this parameter must indicate the
	// executable that calls the server SDK operations initSDK() and ProcessReady().
	//
	// LaunchPath is a required field
	LaunchPath *string `min:"1" type:"string" required:"true"`

	// An optional list of parameters to pass to the server executable or Realtime
	// script on launch.
	Parameters *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A set of instructions for launching server processes on fleet computes. Server processes run either an executable in a custom game build or a Realtime Servers script. Server process configurations are part of a fleet's runtime configuration.

func (ServerProcess) GoString added in v1.2.1 

func (s ServerProcess) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 StartFleetActionsInput added in v1.13.46 

type StartFleetActionsInput struct {

	// List of actions to restart on the fleet.
	//
	// Actions is a required field
	Actions []*string `min:"1" type:"list" required:"true" enum:"FleetAction"`

	// A unique identifier for the fleet to restart actions on. You can use either
	// the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The fleet location to restart fleet actions for. Specify a location in the
	// form of an Amazon Web Services Region code, such as us-west-2.
	Location *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartFleetActionsInput) GoString added in v1.13.46 

func (s StartFleetActionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFleetActionsInput) SetActions added in v1.13.46 

func (s *StartFleetActionsInput) SetActions(v []*string) *StartFleetActionsInput

SetActions sets the Actions field's value.

func (*StartFleetActionsInput) SetFleetId added in v1.13.46 

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

SetFleetId sets the FleetId field's value.

func (*StartFleetActionsInput) SetLocation added in v1.37.32 

func (s *StartFleetActionsInput) SetLocation(v string) *StartFleetActionsInput

SetLocation sets the Location field's value.

func (StartFleetActionsInput) String added in v1.13.46 

func (s StartFleetActionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFleetActionsInput) Validate added in v1.13.46 

func (s *StartFleetActionsInput) Validate() error

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

type StartFleetActionsOutput added in v1.13.46 

type StartFleetActionsOutput struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet to restart actions on.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartFleetActionsOutput) GoString added in v1.13.46 

func (s StartFleetActionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFleetActionsOutput) SetFleetArn added in v1.37.32 

func (s *StartFleetActionsOutput) SetFleetArn(v string) *StartFleetActionsOutput

SetFleetArn sets the FleetArn field's value.

func (*StartFleetActionsOutput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (StartFleetActionsOutput) String added in v1.13.46 

func (s StartFleetActionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartGameSessionPlacementInput added in v1.6.27 

type StartGameSessionPlacementInput struct {

	// Set of information on each player to create a player session for.
	DesiredPlayerSessions []*DesiredPlayerSession `type:"list"`

	// A set of key-value pairs that can store custom data in a game session. For
	// example: {"Key": "difficulty", "Value": "novice"}.
	GameProperties []*GameProperty `type:"list"`

	// A set of custom game session properties, formatted as a single string value.
	// This data is passed to a game server process in the GameSession object with
	// a request to start a new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
	GameSessionData *string `min:"1" type:"string"`

	// A descriptive label that is associated with a game session. Session names
	// do not need to be unique.
	GameSessionName *string `min:"1" type:"string"`

	// Name of the queue to use to place the new game session. You can use either
	// the queue name or ARN value.
	//
	// GameSessionQueueName is a required field
	GameSessionQueueName *string `min:"1" type:"string" required:"true"`

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

	// A unique identifier to assign to the new game session placement. This value
	// is developer-defined. The value must be unique across all Regions and cannot
	// be reused.
	//
	// PlacementId is a required field
	PlacementId *string `min:"1" type:"string" required:"true"`

	// A set of values, expressed in milliseconds, that indicates the amount of
	// latency that a player experiences when connected to Amazon Web Services Regions.
	// This information is used to try to place the new game session where it can
	// offer the best possible gameplay experience for the players.
	PlayerLatencies []*PlayerLatency `type:"list"`
	// contains filtered or unexported fields
}

func (StartGameSessionPlacementInput) GoString added in v1.6.27 

func (s StartGameSessionPlacementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartGameSessionPlacementInput) SetDesiredPlayerSessions added in v1.6.27 

func (s *StartGameSessionPlacementInput) SetDesiredPlayerSessions(v []*DesiredPlayerSession) *StartGameSessionPlacementInput

SetDesiredPlayerSessions sets the DesiredPlayerSessions field's value.

func (*StartGameSessionPlacementInput) SetGameProperties added in v1.6.27 

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

SetGameProperties sets the GameProperties field's value.

func (*StartGameSessionPlacementInput) SetGameSessionData added in v1.10.27 

func (s *StartGameSessionPlacementInput) SetGameSessionData(v string) *StartGameSessionPlacementInput

SetGameSessionData sets the GameSessionData field's value.

func (*StartGameSessionPlacementInput) SetGameSessionName added in v1.6.27 

func (s *StartGameSessionPlacementInput) SetGameSessionName(v string) *StartGameSessionPlacementInput

SetGameSessionName sets the GameSessionName field's value.

func (*StartGameSessionPlacementInput) SetGameSessionQueueName added in v1.6.27 

func (s *StartGameSessionPlacementInput) SetGameSessionQueueName(v string) *StartGameSessionPlacementInput

SetGameSessionQueueName sets the GameSessionQueueName field's value.

func (*StartGameSessionPlacementInput) SetMaximumPlayerSessionCount added in v1.6.27 

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

SetMaximumPlayerSessionCount sets the MaximumPlayerSessionCount field's value.

func (*StartGameSessionPlacementInput) SetPlacementId added in v1.6.27 

func (s *StartGameSessionPlacementInput) SetPlacementId(v string) *StartGameSessionPlacementInput

SetPlacementId sets the PlacementId field's value.

func (*StartGameSessionPlacementInput) SetPlayerLatencies added in v1.6.27 

func (s *StartGameSessionPlacementInput) SetPlayerLatencies(v []*PlayerLatency) *StartGameSessionPlacementInput

SetPlayerLatencies sets the PlayerLatencies field's value.

func (StartGameSessionPlacementInput) String added in v1.6.27 

func (s StartGameSessionPlacementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartGameSessionPlacementInput) Validate added in v1.6.27 

func (s *StartGameSessionPlacementInput) Validate() error

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

type StartGameSessionPlacementOutput added in v1.6.27 

type StartGameSessionPlacementOutput struct {

	// Object that describes the newly created game session placement. This object
	// includes all the information provided in the request, as well as start/end
	// time stamps and placement status.
	GameSessionPlacement *GameSessionPlacement `type:"structure"`
	// contains filtered or unexported fields
}

func (StartGameSessionPlacementOutput) GoString added in v1.6.27 

func (s StartGameSessionPlacementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartGameSessionPlacementOutput) SetGameSessionPlacement added in v1.6.27 

func (s *StartGameSessionPlacementOutput) SetGameSessionPlacement(v *GameSessionPlacement) *StartGameSessionPlacementOutput

SetGameSessionPlacement sets the GameSessionPlacement field's value.

func (StartGameSessionPlacementOutput) String added in v1.6.27 

func (s StartGameSessionPlacementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartMatchBackfillInput added in v1.12.73 

type StartMatchBackfillInput struct {

	// Name of the matchmaker to use for this request. You can use either the configuration
	// name or ARN value. The ARN of the matchmaker that was used with the original
	// game session is listed in the GameSession object, MatchmakerData property.
	//
	// ConfigurationName is a required field
	ConfigurationName *string `min:"1" type:"string" required:"true"`

	// A unique identifier for the game session. Use the game session ID. When using
	// FlexMatch as a standalone matchmaking solution, this parameter is not needed.
	GameSessionArn *string `min:"1" type:"string"`

	// Match information on all players that are currently assigned to the game
	// session. This information is used by the matchmaker to find new players and
	// add them to the existing game.
	//
	// You can include up to 199 Players in a StartMatchBackfill request.
	//
	//    * PlayerID, PlayerAttributes, Team -- This information is maintained in
	//    the GameSession object, MatchmakerData property, for all players who are
	//    currently assigned to the game session. The matchmaker data is in JSON
	//    syntax, formatted as a string. For more details, see Match Data (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data).
	//    The backfill request must specify the team membership for every player.
	//    Do not specify team if you are not using backfill.
	//
	//    * LatencyInMs -- If the matchmaker uses player latency, include a latency
	//    value, in milliseconds, for the Region that the game session is currently
	//    in. Do not include latency values for any other Region.
	//
	// Players is a required field
	Players []*Player `type:"list" required:"true"`

	// A unique identifier for a matchmaking ticket. If no ticket ID is specified
	// here, Amazon GameLift will generate one in the form of a UUID. Use this identifier
	// to track the match backfill ticket status and retrieve match results.
	TicketId *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartMatchBackfillInput) GoString added in v1.12.73 

func (s StartMatchBackfillInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMatchBackfillInput) SetConfigurationName added in v1.12.73 

func (s *StartMatchBackfillInput) SetConfigurationName(v string) *StartMatchBackfillInput

SetConfigurationName sets the ConfigurationName field's value.

func (*StartMatchBackfillInput) SetGameSessionArn added in v1.12.73 

func (s *StartMatchBackfillInput) SetGameSessionArn(v string) *StartMatchBackfillInput

SetGameSessionArn sets the GameSessionArn field's value.

func (*StartMatchBackfillInput) SetPlayers added in v1.12.73 

func (s *StartMatchBackfillInput) SetPlayers(v []*Player) *StartMatchBackfillInput

SetPlayers sets the Players field's value.

func (*StartMatchBackfillInput) SetTicketId added in v1.12.73 

func (s *StartMatchBackfillInput) SetTicketId(v string) *StartMatchBackfillInput

SetTicketId sets the TicketId field's value.

func (StartMatchBackfillInput) String added in v1.12.73 

func (s StartMatchBackfillInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMatchBackfillInput) Validate added in v1.12.73 

func (s *StartMatchBackfillInput) Validate() error

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

type StartMatchBackfillOutput added in v1.12.73 

type StartMatchBackfillOutput struct {

	// Ticket representing the backfill matchmaking request. This object includes
	// the information in the request, ticket status, and match results as generated
	// during the matchmaking process.
	MatchmakingTicket *MatchmakingTicket `type:"structure"`
	// contains filtered or unexported fields
}

func (StartMatchBackfillOutput) GoString added in v1.12.73 

func (s StartMatchBackfillOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMatchBackfillOutput) SetMatchmakingTicket added in v1.12.73 

func (s *StartMatchBackfillOutput) SetMatchmakingTicket(v *MatchmakingTicket) *StartMatchBackfillOutput

SetMatchmakingTicket sets the MatchmakingTicket field's value.

func (StartMatchBackfillOutput) String added in v1.12.73 

func (s StartMatchBackfillOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartMatchmakingInput added in v1.10.27 

type StartMatchmakingInput struct {

	// Name of the matchmaking configuration to use for this request. Matchmaking
	// configurations must exist in the same Region as this request. You can use
	// either the configuration name or ARN value.
	//
	// ConfigurationName is a required field
	ConfigurationName *string `min:"1" type:"string" required:"true"`

	// Information on each player to be matched. This information must include a
	// player ID, and may contain player attributes and latency data to be used
	// in the matchmaking process. After a successful match, Player objects contain
	// the name of the team the player is assigned to.
	//
	// You can include up to 10 Players in a StartMatchmaking request.
	//
	// Players is a required field
	Players []*Player `type:"list" required:"true"`

	// A unique identifier for a matchmaking ticket. If no ticket ID is specified
	// here, Amazon GameLift will generate one in the form of a UUID. Use this identifier
	// to track the matchmaking ticket status and retrieve match results.
	TicketId *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartMatchmakingInput) GoString added in v1.10.27 

func (s StartMatchmakingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMatchmakingInput) SetConfigurationName added in v1.10.27 

func (s *StartMatchmakingInput) SetConfigurationName(v string) *StartMatchmakingInput

SetConfigurationName sets the ConfigurationName field's value.

func (*StartMatchmakingInput) SetPlayers added in v1.10.27 

func (s *StartMatchmakingInput) SetPlayers(v []*Player) *StartMatchmakingInput

SetPlayers sets the Players field's value.

func (*StartMatchmakingInput) SetTicketId added in v1.10.27 

func (s *StartMatchmakingInput) SetTicketId(v string) *StartMatchmakingInput

SetTicketId sets the TicketId field's value.

func (StartMatchmakingInput) String added in v1.10.27 

func (s StartMatchmakingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMatchmakingInput) Validate added in v1.10.27 

func (s *StartMatchmakingInput) Validate() error

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

type StartMatchmakingOutput added in v1.10.27 

type StartMatchmakingOutput struct {

	// Ticket representing the matchmaking request. This object include the information
	// included in the request, ticket status, and match results as generated during
	// the matchmaking process.
	MatchmakingTicket *MatchmakingTicket `type:"structure"`
	// contains filtered or unexported fields
}

func (StartMatchmakingOutput) GoString added in v1.10.27 

func (s StartMatchmakingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMatchmakingOutput) SetMatchmakingTicket added in v1.10.27 

func (s *StartMatchmakingOutput) SetMatchmakingTicket(v *MatchmakingTicket) *StartMatchmakingOutput

SetMatchmakingTicket sets the MatchmakingTicket field's value.

func (StartMatchmakingOutput) String added in v1.10.27 

func (s StartMatchmakingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopFleetActionsInput added in v1.13.46 

type StopFleetActionsInput struct {

	// List of actions to suspend on the fleet.
	//
	// Actions is a required field
	Actions []*string `min:"1" type:"list" required:"true" enum:"FleetAction"`

	// A unique identifier for the fleet to stop actions on. You can use either
	// the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The fleet location to stop fleet actions for. Specify a location in the form
	// of an Amazon Web Services Region code, such as us-west-2.
	Location *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopFleetActionsInput) GoString added in v1.13.46 

func (s StopFleetActionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopFleetActionsInput) SetActions added in v1.13.46 

func (s *StopFleetActionsInput) SetActions(v []*string) *StopFleetActionsInput

SetActions sets the Actions field's value.

func (*StopFleetActionsInput) SetFleetId added in v1.13.46 

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

SetFleetId sets the FleetId field's value.

func (*StopFleetActionsInput) SetLocation added in v1.37.32 

func (s *StopFleetActionsInput) SetLocation(v string) *StopFleetActionsInput

SetLocation sets the Location field's value.

func (StopFleetActionsInput) String added in v1.13.46 

func (s StopFleetActionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopFleetActionsInput) Validate added in v1.13.46 

func (s *StopFleetActionsInput) Validate() error

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

type StopFleetActionsOutput added in v1.13.46 

type StopFleetActionsOutput struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet to stop actions on.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

func (StopFleetActionsOutput) GoString added in v1.13.46 

func (s StopFleetActionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopFleetActionsOutput) SetFleetArn added in v1.37.32 

func (s *StopFleetActionsOutput) SetFleetArn(v string) *StopFleetActionsOutput

SetFleetArn sets the FleetArn field's value.

func (*StopFleetActionsOutput) SetFleetId added in v1.37.32 

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

SetFleetId sets the FleetId field's value.

func (StopFleetActionsOutput) String added in v1.13.46 

func (s StopFleetActionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopGameSessionPlacementInput added in v1.6.27 

type StopGameSessionPlacementInput struct {

	// A unique identifier for a game session placement to stop.
	//
	// PlacementId is a required field
	PlacementId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopGameSessionPlacementInput) GoString added in v1.6.27 

func (s StopGameSessionPlacementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopGameSessionPlacementInput) SetPlacementId added in v1.6.27 

func (s *StopGameSessionPlacementInput) SetPlacementId(v string) *StopGameSessionPlacementInput

SetPlacementId sets the PlacementId field's value.

func (StopGameSessionPlacementInput) String added in v1.6.27 

func (s StopGameSessionPlacementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopGameSessionPlacementInput) Validate added in v1.6.27 

func (s *StopGameSessionPlacementInput) Validate() error

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

type StopGameSessionPlacementOutput added in v1.6.27 

type StopGameSessionPlacementOutput struct {

	// Object that describes the canceled game session placement, with CANCELLED
	// status and an end time stamp.
	GameSessionPlacement *GameSessionPlacement `type:"structure"`
	// contains filtered or unexported fields
}

func (StopGameSessionPlacementOutput) GoString added in v1.6.27 

func (s StopGameSessionPlacementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopGameSessionPlacementOutput) SetGameSessionPlacement added in v1.6.27 

func (s *StopGameSessionPlacementOutput) SetGameSessionPlacement(v *GameSessionPlacement) *StopGameSessionPlacementOutput

SetGameSessionPlacement sets the GameSessionPlacement field's value.

func (StopGameSessionPlacementOutput) String added in v1.6.27 

func (s StopGameSessionPlacementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopMatchmakingInput added in v1.10.27 

type StopMatchmakingInput struct {

	// A unique identifier for a matchmaking ticket.
	//
	// TicketId is a required field
	TicketId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopMatchmakingInput) GoString added in v1.10.27 

func (s StopMatchmakingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopMatchmakingInput) SetTicketId added in v1.10.27 

func (s *StopMatchmakingInput) SetTicketId(v string) *StopMatchmakingInput

SetTicketId sets the TicketId field's value.

func (StopMatchmakingInput) String added in v1.10.27 

func (s StopMatchmakingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopMatchmakingInput) Validate added in v1.10.27 

func (s *StopMatchmakingInput) Validate() error

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

type StopMatchmakingOutput added in v1.10.27 

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

func (StopMatchmakingOutput) GoString added in v1.10.27 

func (s StopMatchmakingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopMatchmakingOutput) String added in v1.10.27 

func (s StopMatchmakingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SuspendGameServerGroupInput added in v1.30.3 

type SuspendGameServerGroupInput struct {

	// A unique identifier for the game server group. Use either the name or ARN
	// value.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// The activity to suspend for this game server group.
	//
	// SuspendActions is a required field
	SuspendActions []*string `min:"1" type:"list" required:"true" enum:"GameServerGroupAction"`
	// contains filtered or unexported fields
}

func (SuspendGameServerGroupInput) GoString added in v1.30.3 

func (s SuspendGameServerGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuspendGameServerGroupInput) SetGameServerGroupName added in v1.30.3 

func (s *SuspendGameServerGroupInput) SetGameServerGroupName(v string) *SuspendGameServerGroupInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*SuspendGameServerGroupInput) SetSuspendActions added in v1.30.3 

func (s *SuspendGameServerGroupInput) SetSuspendActions(v []*string) *SuspendGameServerGroupInput

SetSuspendActions sets the SuspendActions field's value.

func (SuspendGameServerGroupInput) String added in v1.30.3 

func (s SuspendGameServerGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuspendGameServerGroupInput) Validate added in v1.30.3 

func (s *SuspendGameServerGroupInput) Validate() error

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

type SuspendGameServerGroupOutput added in v1.30.3 

type SuspendGameServerGroupOutput struct {

	// An object that describes the game server group resource, with the SuspendedActions
	// property updated to reflect the suspended activity.
	GameServerGroup *GameServerGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (SuspendGameServerGroupOutput) GoString added in v1.30.3 

func (s SuspendGameServerGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuspendGameServerGroupOutput) SetGameServerGroup added in v1.30.3 

func (s *SuspendGameServerGroupOutput) SetGameServerGroup(v *GameServerGroup) *SuspendGameServerGroupOutput

SetGameServerGroup sets the GameServerGroup field's value.

func (SuspendGameServerGroupOutput) String added in v1.30.3 

func (s SuspendGameServerGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v1.26.6 

type Tag struct {

	// The key for a developer-defined key value pair for tagging an Amazon Web
	// Services resource.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value for a developer-defined key value pair for tagging an Amazon Web
	// Services resource.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A label that you can assign to a Amazon GameLift resource.

Learn more

Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference 

Amazon Web Services Tagging Strategies (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/)

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

func (Tag) GoString added in v1.26.6 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.26.6 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.26.6 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.26.6 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.26.6 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.26.6 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that uniquely identifies the Amazon GameLift resource that you want to assign
	// tags to. Amazon GameLift includes resource ARNs in the data object for the
	// resource. You can retrieve the ARN by calling a List or Describe operation
	// for the resource type.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A list of one or more tags to assign to the specified Amazon GameLift resource.
	// Tags are developer-defined and structured as key-value pairs. The maximum
	// tag limit may be lower than stated. See Tagging Amazon Web Services Resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for tagging
	// limits.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.26.6 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN added in v1.26.6 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.26.6 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.26.6 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.26.6 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.26.6 

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

func (TagResourceOutput) GoString added in v1.26.6 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.26.6 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaggingFailedException added in v1.28.0 

type TaggingFailedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

func (*TaggingFailedException) Code added in v1.28.0 

func (s *TaggingFailedException) Code() string

Code returns the exception type name.

func (*TaggingFailedException) Error added in v1.28.0 

func (s *TaggingFailedException) Error() string

func (TaggingFailedException) GoString added in v1.28.0 

func (s TaggingFailedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaggingFailedException) Message added in v1.28.0 

func (s *TaggingFailedException) Message() string

Message returns the exception's message.

func (*TaggingFailedException) OrigErr added in v1.28.0 

func (s *TaggingFailedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TaggingFailedException) RequestID added in v1.28.0 

func (s *TaggingFailedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TaggingFailedException) StatusCode added in v1.28.0 

func (s *TaggingFailedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TaggingFailedException) String added in v1.28.0 

func (s TaggingFailedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TargetConfiguration added in v1.13.46 

type TargetConfiguration struct {

	// Desired value to use with a target-based scaling policy. The value must be
	// relevant for whatever metric the scaling policy is using. For example, in
	// a policy using the metric PercentAvailableGameSessions, the target value
	// should be the preferred size of the fleet's buffer (the percent of capacity
	// that should be idle and ready for new game sessions).
	//
	// TargetValue is a required field
	TargetValue *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

func (TargetConfiguration) GoString added in v1.13.46 

func (s TargetConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetConfiguration) SetTargetValue added in v1.13.46 

func (s *TargetConfiguration) SetTargetValue(v float64) *TargetConfiguration

SetTargetValue sets the TargetValue field's value.

func (TargetConfiguration) String added in v1.13.46 

func (s TargetConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetConfiguration) Validate added in v1.13.46 

func (s *TargetConfiguration) Validate() error

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

type TargetTrackingConfiguration added in v1.30.3 

type TargetTrackingConfiguration struct {

	// Desired value to use with a game server group target-based scaling policy.
	//
	// TargetValue is a required field
	TargetValue *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Settings for a target-based scaling policy as part of a GameServerGroupAutoScalingPolicy (https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerGroupAutoScalingPolicy.html) . These settings are used to create a target-based policy that tracks the Amazon GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

func (TargetTrackingConfiguration) GoString added in v1.30.3 

func (s TargetTrackingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingConfiguration) SetTargetValue added in v1.30.3 

func (s *TargetTrackingConfiguration) SetTargetValue(v float64) *TargetTrackingConfiguration

SetTargetValue sets the TargetValue field's value.

func (TargetTrackingConfiguration) String added in v1.30.3 

func (s TargetTrackingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingConfiguration) Validate added in v1.30.3 

func (s *TargetTrackingConfiguration) Validate() error

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

type TerminalRoutingStrategyException added in v1.28.0 

type TerminalRoutingStrategyException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*TerminalRoutingStrategyException) Code added in v1.28.0 

func (s *TerminalRoutingStrategyException) Code() string

Code returns the exception type name.

func (*TerminalRoutingStrategyException) Error added in v1.28.0 

func (s *TerminalRoutingStrategyException) Error() string

func (TerminalRoutingStrategyException) GoString added in v1.28.0 

func (s TerminalRoutingStrategyException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminalRoutingStrategyException) Message added in v1.28.0 

func (s *TerminalRoutingStrategyException) Message() string

Message returns the exception's message.

func (*TerminalRoutingStrategyException) OrigErr added in v1.28.0 

func (s *TerminalRoutingStrategyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TerminalRoutingStrategyException) RequestID added in v1.28.0 

func (s *TerminalRoutingStrategyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TerminalRoutingStrategyException) StatusCode added in v1.28.0 

func (s *TerminalRoutingStrategyException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TerminalRoutingStrategyException) String added in v1.28.0 

func (s TerminalRoutingStrategyException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnauthorizedException added in v1.28.0 

type UnauthorizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*UnauthorizedException) Code added in v1.28.0 

func (s *UnauthorizedException) Code() string

Code returns the exception type name.

func (*UnauthorizedException) Error added in v1.28.0 

func (s *UnauthorizedException) Error() string

func (UnauthorizedException) GoString added in v1.28.0 

func (s UnauthorizedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthorizedException) Message added in v1.28.0 

func (s *UnauthorizedException) Message() string

Message returns the exception's message.

func (*UnauthorizedException) OrigErr added in v1.28.0 

func (s *UnauthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedException) RequestID added in v1.28.0 

func (s *UnauthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedException) StatusCode added in v1.28.0 

func (s *UnauthorizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedException) String added in v1.28.0 

func (s UnauthorizedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnsupportedRegionException added in v1.28.0 

type UnsupportedRegionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The requested operation is not supported in the Region specified.

func (*UnsupportedRegionException) Code added in v1.28.0 

func (s *UnsupportedRegionException) Code() string

Code returns the exception type name.

func (*UnsupportedRegionException) Error added in v1.28.0 

func (s *UnsupportedRegionException) Error() string

func (UnsupportedRegionException) GoString added in v1.28.0 

func (s UnsupportedRegionException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnsupportedRegionException) Message added in v1.28.0 

func (s *UnsupportedRegionException) Message() string

Message returns the exception's message.

func (*UnsupportedRegionException) OrigErr added in v1.28.0 

func (s *UnsupportedRegionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedRegionException) RequestID added in v1.28.0 

func (s *UnsupportedRegionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedRegionException) StatusCode added in v1.28.0 

func (s *UnsupportedRegionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedRegionException) String added in v1.28.0 

func (s UnsupportedRegionException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.26.6 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that uniquely identifies the Amazon GameLift resource that you want to remove
	// tags from. Amazon GameLift includes resource ARNs in the data object for
	// the resource. You can retrieve the ARN by calling a List or Describe operation
	// for the resource type.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A list of one or more tag keys to remove from the specified Amazon GameLift
	// resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.26.6 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN added in v1.26.6 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.26.6 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.26.6 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.26.6 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.26.6 

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

func (UntagResourceOutput) GoString added in v1.26.6 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.26.6 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAliasInput 

type UpdateAliasInput struct {

	// A unique identifier for the alias that you want to update. You can use either
	// the alias ID or ARN value.
	//
	// AliasId is a required field
	AliasId *string `type:"string" required:"true"`

	// A human-readable description of the alias.
	Description *string `min:"1" type:"string"`

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

	// The routing configuration, including routing type and fleet target, for the
	// alias.
	RoutingStrategy *RoutingStrategy `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateAliasInput) GoString 

func (s UpdateAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The updated alias resource.
	Alias *Alias `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateAliasOutput) GoString 

func (s UpdateAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateBuildInput 

type UpdateBuildInput struct {

	// A unique identifier for the build to update. You can use either the build
	// ID or ARN value.
	//
	// BuildId is a required field
	BuildId *string `type:"string" required:"true"`

	// A descriptive label associated with a build. Build names don't need to be
	// unique.
	Name *string `min:"1" type:"string"`

	// Version information associated with a build or script. Version strings don't
	// need to be unique.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateBuildInput) GoString 

func (s UpdateBuildInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The updated build resource.
	Build *Build `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateBuildOutput) GoString 

func (s UpdateBuildOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFleetAttributesInput 

type UpdateFleetAttributesInput struct {

	// Amazon GameLift Anywhere configuration options.
	AnywhereConfiguration *AnywhereConfiguration `type:"structure"`

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

	// A unique identifier for the fleet to update attribute metadata for. You can
	// use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The name of a metric group to add this fleet to. Use a metric group in Amazon
	// CloudWatch to aggregate the metrics from multiple fleets. Provide an existing
	// metric group name, or create a new metric group by providing a new name.
	// A fleet can only be in one metric group at a time.
	MetricGroups []*string `type:"list"`

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

	// The game session protection policy to apply to all new game sessions created
	// in this fleet. Game sessions that already exist are not affected. You can
	// set protection for individual game sessions using UpdateGameSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) .
	//
	//    * 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 settings that limit the number of game sessions an individual player
	// can create over a span of time.
	ResourceCreationLimitPolicy *ResourceCreationLimitPolicy `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateFleetAttributesInput) GoString 

func (s UpdateFleetAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFleetAttributesInput) SetAnywhereConfiguration added in v1.44.151 

func (s *UpdateFleetAttributesInput) SetAnywhereConfiguration(v *AnywhereConfiguration) *UpdateFleetAttributesInput

SetAnywhereConfiguration sets the AnywhereConfiguration field's value.

func (*UpdateFleetAttributesInput) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*UpdateFleetAttributesInput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (*UpdateFleetAttributesInput) SetMetricGroups added in v1.8.24 

func (s *UpdateFleetAttributesInput) SetMetricGroups(v []*string) *UpdateFleetAttributesInput

SetMetricGroups sets the MetricGroups field's value.

func (*UpdateFleetAttributesInput) SetName added in v1.5.0 

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

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 

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

SetResourceCreationLimitPolicy sets the ResourceCreationLimitPolicy field's value.

func (UpdateFleetAttributesInput) String 

func (s UpdateFleetAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that was updated.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFleetAttributesOutput) GoString 

func (s UpdateFleetAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFleetAttributesOutput) SetFleetArn added in v1.44.151 

func (s *UpdateFleetAttributesOutput) SetFleetArn(v string) *UpdateFleetAttributesOutput

SetFleetArn sets the FleetArn field's value.

func (*UpdateFleetAttributesOutput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (UpdateFleetAttributesOutput) String 

func (s UpdateFleetAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFleetCapacityInput 

type UpdateFleetCapacityInput struct {

	// The number of Amazon EC2 instances you want to maintain in the specified
	// fleet location. This value must fall between the minimum and maximum size
	// limits. Changes in desired instance value can take up to 1 minute to be reflected
	// when viewing the fleet's capacity settings.
	DesiredInstances *int64 `type:"integer"`

	// A unique identifier for the fleet to update capacity settings for. You can
	// use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// The name of a remote location to update fleet capacity settings for, in the
	// form of an Amazon Web Services Region code such as us-west-2.
	Location *string `min:"1" type:"string"`

	// The maximum number of instances that are allowed in the specified fleet location.
	// If this parameter is not set, the default is 1.
	MaxSize *int64 `type:"integer"`

	// The minimum number of instances that are allowed in the specified fleet location.
	// If this parameter is not set, the default is 0.
	MinSize *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (UpdateFleetCapacityInput) GoString 

func (s UpdateFleetCapacityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

SetFleetId sets the FleetId field's value.

func (*UpdateFleetCapacityInput) SetLocation added in v1.37.32 

func (s *UpdateFleetCapacityInput) SetLocation(v string) *UpdateFleetCapacityInput

SetLocation sets the Location field's value.

func (*UpdateFleetCapacityInput) SetMaxSize added in v1.5.0 

func (s *UpdateFleetCapacityInput) SetMaxSize(v int64) *UpdateFleetCapacityInput

SetMaxSize sets the MaxSize field's value.

func (*UpdateFleetCapacityInput) SetMinSize added in v1.5.0 

func (s *UpdateFleetCapacityInput) SetMinSize(v int64) *UpdateFleetCapacityInput

SetMinSize sets the MinSize field's value.

func (UpdateFleetCapacityInput) String 

func (s UpdateFleetCapacityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that was updated.
	FleetId *string `type:"string"`

	// The remote location being updated, expressed as an Amazon Web Services Region
	// code, such as us-west-2.
	Location *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFleetCapacityOutput) GoString 

func (s UpdateFleetCapacityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFleetCapacityOutput) SetFleetArn added in v1.37.32 

func (s *UpdateFleetCapacityOutput) SetFleetArn(v string) *UpdateFleetCapacityOutput

SetFleetArn sets the FleetArn field's value.

func (*UpdateFleetCapacityOutput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (*UpdateFleetCapacityOutput) SetLocation added in v1.37.32 

func (s *UpdateFleetCapacityOutput) SetLocation(v string) *UpdateFleetCapacityOutput

SetLocation sets the Location field's value.

func (UpdateFleetCapacityOutput) String 

func (s UpdateFleetCapacityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFleetPortSettingsInput 

type UpdateFleetPortSettingsInput struct {

	// A unique identifier for the fleet to update port settings for. You can use
	// either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// A collection of port settings to be added to the fleet resource.
	InboundPermissionAuthorizations []*IpPermission `type:"list"`

	// A collection of port settings to be removed from the fleet resource.
	InboundPermissionRevocations []*IpPermission `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateFleetPortSettingsInput) GoString 

func (s UpdateFleetPortSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFleetPortSettingsInput) SetFleetId added in v1.5.0 

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

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 

func (s UpdateFleetPortSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift fleet resource and uniquely identifies
	// it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet that was updated.
	FleetId *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFleetPortSettingsOutput) GoString 

func (s UpdateFleetPortSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFleetPortSettingsOutput) SetFleetArn added in v1.44.151 

func (s *UpdateFleetPortSettingsOutput) SetFleetArn(v string) *UpdateFleetPortSettingsOutput

SetFleetArn sets the FleetArn field's value.

func (*UpdateFleetPortSettingsOutput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (UpdateFleetPortSettingsOutput) String 

func (s UpdateFleetPortSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGameServerGroupInput added in v1.30.3 

type UpdateGameServerGroupInput struct {

	// Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances
	// and On-Demand Instances in the game server group. Method options include
	// the following:
	//
	//    * SPOT_ONLY - Only Spot Instances are used in the game server group. If
	//    Spot Instances are unavailable or not viable for game hosting, the game
	//    server group provides no hosting capacity until Spot Instances can again
	//    be used. Until then, no new instances are started, and the existing nonviable
	//    Spot Instances are terminated (after current gameplay ends) and are not
	//    replaced.
	//
	//    * SPOT_PREFERRED - (default value) Spot Instances are used whenever available
	//    in the game server group. If Spot Instances are unavailable, the game
	//    server group continues to provide hosting capacity by falling back to
	//    On-Demand Instances. Existing nonviable Spot Instances are terminated
	//    (after current gameplay ends) and are replaced with new On-Demand Instances.
	//
	//    * ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server
	//    group. No Spot Instances are used, even when available, while this balancing
	//    strategy is in force.
	BalancingStrategy *string `type:"string" enum:"BalancingStrategy"`

	// A unique identifier for the game server group. Use either the name or ARN
	// value.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// A flag that indicates whether instances in the game server group are protected
	// from early termination. Unprotected instances that have active game servers
	// running might be terminated during a scale-down event, causing players to
	// be dropped from the game. Protected instances cannot be terminated while
	// there are active game servers running except in the event of a forced game
	// server group deletion (see ). An exception to this is with Spot Instances,
	// which can be terminated by Amazon Web Services regardless of protection status.
	// This property is set to NO_PROTECTION by default.
	GameServerProtectionPolicy *string `type:"string" enum:"GameServerProtectionPolicy"`

	// An updated list of Amazon EC2 instance types to use in the Auto Scaling group.
	// The instance definitions must specify at least two different instance types
	// that are supported by Amazon GameLift FleetIQ. This updated list replaces
	// the entire current list of instance definitions for the game server group.
	// For more information on instance types, see EC2 Instance Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)
	// in the Amazon EC2 User Guide. You can optionally specify capacity weighting
	// for each instance type. If no weight value is specified for an instance type,
	// it is set to the default value "1". For more information about capacity weighting,
	// see Instance Weighting for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	InstanceDefinitions []*InstanceDefinition `min:"2" type:"list"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto
	// Scaling groups.
	RoleArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateGameServerGroupInput) GoString added in v1.30.3 

func (s UpdateGameServerGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameServerGroupInput) SetBalancingStrategy added in v1.30.3 

func (s *UpdateGameServerGroupInput) SetBalancingStrategy(v string) *UpdateGameServerGroupInput

SetBalancingStrategy sets the BalancingStrategy field's value.

func (*UpdateGameServerGroupInput) SetGameServerGroupName added in v1.30.3 

func (s *UpdateGameServerGroupInput) SetGameServerGroupName(v string) *UpdateGameServerGroupInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*UpdateGameServerGroupInput) SetGameServerProtectionPolicy added in v1.30.3 

func (s *UpdateGameServerGroupInput) SetGameServerProtectionPolicy(v string) *UpdateGameServerGroupInput

SetGameServerProtectionPolicy sets the GameServerProtectionPolicy field's value.

func (*UpdateGameServerGroupInput) SetInstanceDefinitions added in v1.30.3 

func (s *UpdateGameServerGroupInput) SetInstanceDefinitions(v []*InstanceDefinition) *UpdateGameServerGroupInput

SetInstanceDefinitions sets the InstanceDefinitions field's value.

func (*UpdateGameServerGroupInput) SetRoleArn added in v1.30.3 

func (s *UpdateGameServerGroupInput) SetRoleArn(v string) *UpdateGameServerGroupInput

SetRoleArn sets the RoleArn field's value.

func (UpdateGameServerGroupInput) String added in v1.30.3 

func (s UpdateGameServerGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameServerGroupInput) Validate added in v1.30.3 

func (s *UpdateGameServerGroupInput) Validate() error

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

type UpdateGameServerGroupOutput added in v1.30.3 

type UpdateGameServerGroupOutput struct {

	// An object that describes the game server group resource with updated properties.
	GameServerGroup *GameServerGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateGameServerGroupOutput) GoString added in v1.30.3 

func (s UpdateGameServerGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameServerGroupOutput) SetGameServerGroup added in v1.30.3 

func (s *UpdateGameServerGroupOutput) SetGameServerGroup(v *GameServerGroup) *UpdateGameServerGroupOutput

SetGameServerGroup sets the GameServerGroup field's value.

func (UpdateGameServerGroupOutput) String added in v1.30.3 

func (s UpdateGameServerGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGameServerInput added in v1.30.3 

type UpdateGameServerInput struct {

	// A set of custom game server properties, formatted as a single string value.
	// This data is passed to a game client or service when it requests information
	// on game servers.
	GameServerData *string `min:"1" type:"string"`

	// A unique identifier for the game server group where the game server is running.
	//
	// GameServerGroupName is a required field
	GameServerGroupName *string `min:"1" type:"string" required:"true"`

	// A custom string that uniquely identifies the game server to update.
	//
	// GameServerId is a required field
	GameServerId *string `min:"3" type:"string" required:"true"`

	// Indicates health status of the game server. A request that includes this
	// parameter updates the game server's LastHealthCheckTime timestamp.
	HealthCheck *string `type:"string" enum:"GameServerHealthCheck"`

	// Indicates if the game server is available or is currently hosting gameplay.
	// You can update a game server status from AVAILABLE to UTILIZED, but you can't
	// change a the status from UTILIZED to AVAILABLE.
	UtilizationStatus *string `type:"string" enum:"GameServerUtilizationStatus"`
	// contains filtered or unexported fields
}

func (UpdateGameServerInput) GoString added in v1.30.3 

func (s UpdateGameServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameServerInput) SetGameServerData added in v1.30.3 

func (s *UpdateGameServerInput) SetGameServerData(v string) *UpdateGameServerInput

SetGameServerData sets the GameServerData field's value.

func (*UpdateGameServerInput) SetGameServerGroupName added in v1.30.3 

func (s *UpdateGameServerInput) SetGameServerGroupName(v string) *UpdateGameServerInput

SetGameServerGroupName sets the GameServerGroupName field's value.

func (*UpdateGameServerInput) SetGameServerId added in v1.30.3 

func (s *UpdateGameServerInput) SetGameServerId(v string) *UpdateGameServerInput

SetGameServerId sets the GameServerId field's value.

func (*UpdateGameServerInput) SetHealthCheck added in v1.30.3 

func (s *UpdateGameServerInput) SetHealthCheck(v string) *UpdateGameServerInput

SetHealthCheck sets the HealthCheck field's value.

func (*UpdateGameServerInput) SetUtilizationStatus added in v1.30.3 

func (s *UpdateGameServerInput) SetUtilizationStatus(v string) *UpdateGameServerInput

SetUtilizationStatus sets the UtilizationStatus field's value.

func (UpdateGameServerInput) String added in v1.30.3 

func (s UpdateGameServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameServerInput) Validate added in v1.30.3 

func (s *UpdateGameServerInput) Validate() error

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

type UpdateGameServerOutput added in v1.30.3 

type UpdateGameServerOutput struct {

	// Object that describes the newly updated game server.
	GameServer *GameServer `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateGameServerOutput) GoString added in v1.30.3 

func (s UpdateGameServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameServerOutput) SetGameServer added in v1.30.3 

func (s *UpdateGameServerOutput) SetGameServer(v *GameServer) *UpdateGameServerOutput

SetGameServer sets the GameServer field's value.

func (UpdateGameServerOutput) String added in v1.30.3 

func (s UpdateGameServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGameSessionInput 

type UpdateGameSessionInput struct {

	// A set of key-value pairs that can store custom data in a game session. For
	// example: {"Key": "difficulty", "Value": "novice"}. You can use this parameter
	// to modify game properties in an active game session. This action adds new
	// properties and modifies existing properties. There is no way to delete properties.
	// For an example, see Update the value of a game property (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-update).
	GameProperties []*GameProperty `type:"list"`

	// A unique identifier for the game session to update.
	//
	// GameSessionId is a required field
	GameSessionId *string `min:"1" type:"string" required:"true"`

	// The maximum number of players that can be connected simultaneously to the
	// game session.
	MaximumPlayerSessionCount *int64 `type:"integer"`

	// A descriptive label that is associated with a game session. Session names
	// do not need to be unique.
	Name *string `min:"1" type:"string"`

	// A policy that determines whether the game session is accepting 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
}

func (UpdateGameSessionInput) GoString 

func (s UpdateGameSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameSessionInput) SetGameProperties added in v1.49.3 

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

SetGameProperties sets the GameProperties field's value.

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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The updated game session properties.
	GameSession *GameSession `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateGameSessionOutput) GoString 

func (s UpdateGameSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameSessionOutput) SetGameSession added in v1.5.0 

func (s *UpdateGameSessionOutput) SetGameSession(v *GameSession) *UpdateGameSessionOutput

SetGameSession sets the GameSession field's value.

func (UpdateGameSessionOutput) String 

func (s UpdateGameSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGameSessionQueueInput added in v1.6.27 

type UpdateGameSessionQueueInput struct {

	// Information to be added to all events that are related to this game session
	// queue.
	CustomEventData *string `type:"string"`

	// A list of fleets and/or fleet aliases that can be used to fulfill game session
	// placement requests in the queue. Destinations are identified by either a
	// fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
	// When updating this list, provide a complete list of destinations.
	Destinations []*GameSessionQueueDestination `type:"list"`

	// A list of locations where a queue is allowed to place new game sessions.
	// Locations are specified in the form of Amazon Web Services Region codes,
	// such as us-west-2. If this parameter is not set, game sessions can be placed
	// in any queue location. To remove an existing filter configuration, pass in
	// an empty set.
	FilterConfiguration *FilterConfiguration `type:"structure"`

	// A descriptive label that is associated with game session queue. Queue names
	// must be unique within each Region. You can use either the queue ID or ARN
	// value.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// An SNS topic ARN that is set up to receive game session placement notifications.
	// See Setting up notifications for game session placement (https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html).
	NotificationTarget *string `type:"string"`

	// A set of policies that act as a sliding cap on player latency. FleetIQ works
	// to deliver low latency for most players in a game session. These policies
	// ensure that no individual player can be placed into a game with unreasonably
	// high latency. Use multiple policies to gradually relax latency requirements
	// a step at a time. Multiple policies are applied based on their maximum allowed
	// latency, starting with the lowest value. When updating policies, provide
	// a complete collection of policies.
	PlayerLatencyPolicies []*PlayerLatencyPolicy `type:"list"`

	// Custom settings to use when prioritizing destinations and locations for game
	// session placements. This configuration replaces the FleetIQ default prioritization
	// process. Priority types that are not explicitly named will be automatically
	// applied at the end of the prioritization process. To remove an existing priority
	// configuration, pass in an empty set.
	PriorityConfiguration *PriorityConfiguration `type:"structure"`

	// The maximum time, in seconds, that a new game session placement request remains
	// in the queue. When a request exceeds this time, the game session placement
	// changes to a TIMED_OUT status. By default, this property is set to 600.
	TimeoutInSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (UpdateGameSessionQueueInput) GoString added in v1.6.27 

func (s UpdateGameSessionQueueInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameSessionQueueInput) SetCustomEventData added in v1.38.3 

func (s *UpdateGameSessionQueueInput) SetCustomEventData(v string) *UpdateGameSessionQueueInput

SetCustomEventData sets the CustomEventData field's value.

func (*UpdateGameSessionQueueInput) SetDestinations added in v1.6.27 

func (s *UpdateGameSessionQueueInput) SetDestinations(v []*GameSessionQueueDestination) *UpdateGameSessionQueueInput

SetDestinations sets the Destinations field's value.

func (*UpdateGameSessionQueueInput) SetFilterConfiguration added in v1.37.32 

func (s *UpdateGameSessionQueueInput) SetFilterConfiguration(v *FilterConfiguration) *UpdateGameSessionQueueInput

SetFilterConfiguration sets the FilterConfiguration field's value.

func (*UpdateGameSessionQueueInput) SetName added in v1.6.27 

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

SetName sets the Name field's value.

func (*UpdateGameSessionQueueInput) SetNotificationTarget added in v1.38.3 

func (s *UpdateGameSessionQueueInput) SetNotificationTarget(v string) *UpdateGameSessionQueueInput

SetNotificationTarget sets the NotificationTarget field's value.

func (*UpdateGameSessionQueueInput) SetPlayerLatencyPolicies added in v1.8.12 

func (s *UpdateGameSessionQueueInput) SetPlayerLatencyPolicies(v []*PlayerLatencyPolicy) *UpdateGameSessionQueueInput

SetPlayerLatencyPolicies sets the PlayerLatencyPolicies field's value.

func (*UpdateGameSessionQueueInput) SetPriorityConfiguration added in v1.37.32 

func (s *UpdateGameSessionQueueInput) SetPriorityConfiguration(v *PriorityConfiguration) *UpdateGameSessionQueueInput

SetPriorityConfiguration sets the PriorityConfiguration field's value.

func (*UpdateGameSessionQueueInput) SetTimeoutInSeconds added in v1.6.27 

func (s *UpdateGameSessionQueueInput) SetTimeoutInSeconds(v int64) *UpdateGameSessionQueueInput

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (UpdateGameSessionQueueInput) String added in v1.6.27 

func (s UpdateGameSessionQueueInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameSessionQueueInput) Validate added in v1.6.27 

func (s *UpdateGameSessionQueueInput) Validate() error

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

type UpdateGameSessionQueueOutput added in v1.6.27 

type UpdateGameSessionQueueOutput struct {

	// An object that describes the newly updated game session queue.
	GameSessionQueue *GameSessionQueue `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateGameSessionQueueOutput) GoString added in v1.6.27 

func (s UpdateGameSessionQueueOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGameSessionQueueOutput) SetGameSessionQueue added in v1.6.27 

func (s *UpdateGameSessionQueueOutput) SetGameSessionQueue(v *GameSessionQueue) *UpdateGameSessionQueueOutput

SetGameSessionQueue sets the GameSessionQueue field's value.

func (UpdateGameSessionQueueOutput) String added in v1.6.27 

func (s UpdateGameSessionQueueOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateMatchmakingConfigurationInput added in v1.10.27 

type UpdateMatchmakingConfigurationInput struct {

	// A flag that indicates whether a match that was created with this configuration
	// must be accepted by the matched players. To require acceptance, set to TRUE.
	// With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE
	// to indicate when a completed potential match is waiting for player acceptance.
	AcceptanceRequired *bool `type:"boolean"`

	// The length of time (in seconds) to wait for players to accept a proposed
	// match, if acceptance is required.
	AcceptanceTimeoutSeconds *int64 `min:"1" type:"integer"`

	// The number of player slots in a match to keep open for future players. For
	// example, if the configuration's rule set specifies a match for a single 10-person
	// team, and the additional player count is set to 2, 10 players will be selected
	// for the match and 2 more player slots will be open for future players. This
	// parameter is not used if FlexMatchMode is set to STANDALONE.
	AdditionalPlayerCount *int64 `type:"integer"`

	// The method that is used to backfill game sessions created with this matchmaking
	// configuration. Specify MANUAL when your game manages backfill requests manually
	// or does not use the match backfill feature. Specify AUTOMATIC to have GameLift
	// create a match backfill request whenever a game session has one or more open
	// slots. Learn more about manual and automatic backfill in Backfill Existing
	// Games with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html).
	// Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
	BackfillMode *string `type:"string" enum:"BackfillMode"`

	// Information to add to all events related to the matchmaking configuration.
	CustomEventData *string `type:"string"`

	// A description for the matchmaking configuration.
	Description *string `min:"1" type:"string"`

	// Indicates whether this matchmaking configuration is being used with Amazon
	// GameLift hosting or as a standalone matchmaking solution.
	//
	//    * STANDALONE - FlexMatch forms matches and returns match information,
	//    including players and team assignments, in a MatchmakingSucceeded (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded)
	//    event.
	//
	//    * WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift
	//    queue to start a game session for the match.
	FlexMatchMode *string `type:"string" enum:"FlexMatchMode"`

	// A set of key-value pairs that can store custom data in a game session. For
	// example: {"Key": "difficulty", "Value": "novice"}. This information is added
	// to the new GameSession object that is created for a successful match. This
	// parameter is not used if FlexMatchMode is set to STANDALONE.
	GameProperties []*GameProperty `type:"list"`

	// A set of custom game session properties, formatted as a single string value.
	// This data is passed to a game server process with a request to start a new
	// game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
	// This information is added to the game session that is created for a successful
	// match. This parameter is not used if FlexMatchMode is set to STANDALONE.
	GameSessionData *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// that is assigned to a Amazon GameLift game session queue resource and uniquely
	// identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue
	// name>. Queues can be located in any Region. Queues are used to start new
	// Amazon GameLift-hosted game sessions for matches that are created with this
	// matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not
	// set this parameter.
	GameSessionQueueArns []*string `type:"list"`

	// A unique identifier for the matchmaking configuration to update. You can
	// use either the configuration name or ARN value.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// An SNS topic ARN that is set up to receive matchmaking notifications. See
	// Setting up notifications for matchmaking (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html)
	// for more information.
	NotificationTarget *string `type:"string"`

	// The maximum duration, in seconds, that a matchmaking ticket can remain in
	// process before timing out. Requests that fail due to timing out can be resubmitted
	// as needed.
	RequestTimeoutSeconds *int64 `min:"1" type:"integer"`

	// A unique identifier for the matchmaking rule set to use with this configuration.
	// You can use either the rule set name or ARN value. A matchmaking configuration
	// can only use rule sets that are defined in the same Region.
	RuleSetName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateMatchmakingConfigurationInput) GoString added in v1.10.27 

func (s UpdateMatchmakingConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMatchmakingConfigurationInput) SetAcceptanceRequired added in v1.10.27 

func (s *UpdateMatchmakingConfigurationInput) SetAcceptanceRequired(v bool) *UpdateMatchmakingConfigurationInput

SetAcceptanceRequired sets the AcceptanceRequired field's value.

func (*UpdateMatchmakingConfigurationInput) SetAcceptanceTimeoutSeconds added in v1.10.27 

func (s *UpdateMatchmakingConfigurationInput) SetAcceptanceTimeoutSeconds(v int64) *UpdateMatchmakingConfigurationInput

SetAcceptanceTimeoutSeconds sets the AcceptanceTimeoutSeconds field's value.

func (*UpdateMatchmakingConfigurationInput) SetAdditionalPlayerCount added in v1.10.27 

func (s *UpdateMatchmakingConfigurationInput) SetAdditionalPlayerCount(v int64) *UpdateMatchmakingConfigurationInput

SetAdditionalPlayerCount sets the AdditionalPlayerCount field's value.

func (*UpdateMatchmakingConfigurationInput) SetBackfillMode added in v1.20.17 

func (s *UpdateMatchmakingConfigurationInput) SetBackfillMode(v string) *UpdateMatchmakingConfigurationInput

SetBackfillMode sets the BackfillMode field's value.

func (*UpdateMatchmakingConfigurationInput) SetCustomEventData added in v1.10.27 

func (s *UpdateMatchmakingConfigurationInput) SetCustomEventData(v string) *UpdateMatchmakingConfigurationInput

SetCustomEventData sets the CustomEventData field's value.

func (*UpdateMatchmakingConfigurationInput) SetDescription added in v1.10.27 

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

SetDescription sets the Description field's value.

func (*UpdateMatchmakingConfigurationInput) SetFlexMatchMode added in v1.35.35 

func (s *UpdateMatchmakingConfigurationInput) SetFlexMatchMode(v string) *UpdateMatchmakingConfigurationInput

SetFlexMatchMode sets the FlexMatchMode field's value.

func (*UpdateMatchmakingConfigurationInput) SetGameProperties added in v1.10.27 

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

SetGameProperties sets the GameProperties field's value.

func (*UpdateMatchmakingConfigurationInput) SetGameSessionData added in v1.10.27 

func (s *UpdateMatchmakingConfigurationInput) SetGameSessionData(v string) *UpdateMatchmakingConfigurationInput

SetGameSessionData sets the GameSessionData field's value.

func (*UpdateMatchmakingConfigurationInput) SetGameSessionQueueArns added in v1.10.27 

func (s *UpdateMatchmakingConfigurationInput) SetGameSessionQueueArns(v []*string) *UpdateMatchmakingConfigurationInput

SetGameSessionQueueArns sets the GameSessionQueueArns field's value.

func (*UpdateMatchmakingConfigurationInput) SetName added in v1.10.27 

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

SetName sets the Name field's value.

func (*UpdateMatchmakingConfigurationInput) SetNotificationTarget added in v1.10.27 

func (s *UpdateMatchmakingConfigurationInput) SetNotificationTarget(v string) *UpdateMatchmakingConfigurationInput

SetNotificationTarget sets the NotificationTarget field's value.

func (*UpdateMatchmakingConfigurationInput) SetRequestTimeoutSeconds added in v1.10.27 

func (s *UpdateMatchmakingConfigurationInput) SetRequestTimeoutSeconds(v int64) *UpdateMatchmakingConfigurationInput

SetRequestTimeoutSeconds sets the RequestTimeoutSeconds field's value.

func (*UpdateMatchmakingConfigurationInput) SetRuleSetName added in v1.10.27 

func (s *UpdateMatchmakingConfigurationInput) SetRuleSetName(v string) *UpdateMatchmakingConfigurationInput

SetRuleSetName sets the RuleSetName field's value.

func (UpdateMatchmakingConfigurationInput) String added in v1.10.27 

func (s UpdateMatchmakingConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMatchmakingConfigurationInput) Validate added in v1.10.27 

func (s *UpdateMatchmakingConfigurationInput) Validate() error

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

type UpdateMatchmakingConfigurationOutput added in v1.10.27 

type UpdateMatchmakingConfigurationOutput struct {

	// The updated matchmaking configuration.
	Configuration *MatchmakingConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateMatchmakingConfigurationOutput) GoString added in v1.10.27 

func (s UpdateMatchmakingConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMatchmakingConfigurationOutput) SetConfiguration added in v1.10.27 

func (s *UpdateMatchmakingConfigurationOutput) SetConfiguration(v *MatchmakingConfiguration) *UpdateMatchmakingConfigurationOutput

SetConfiguration sets the Configuration field's value.

func (UpdateMatchmakingConfigurationOutput) String added in v1.10.27 

func (s UpdateMatchmakingConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRuntimeConfigurationInput added in v1.2.1 

type UpdateRuntimeConfigurationInput struct {

	// A unique identifier for the fleet to update runtime configuration for. You
	// can use either the fleet ID or ARN value.
	//
	// FleetId is a required field
	FleetId *string `type:"string" required:"true"`

	// Instructions for launching server processes on fleet computes. Server processes
	// run either a custom game build executable or a Realtime Servers script. The
	// runtime configuration lists the types of server processes to run, how to
	// launch them, and the number of processes to run concurrently.
	//
	// RuntimeConfiguration is a required field
	RuntimeConfiguration *RuntimeConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRuntimeConfigurationInput) GoString added in v1.2.1 

func (s UpdateRuntimeConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRuntimeConfigurationInput) SetFleetId added in v1.5.0 

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

SetFleetId sets the FleetId field's value.

func (*UpdateRuntimeConfigurationInput) SetRuntimeConfiguration added in v1.5.0 

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

SetRuntimeConfiguration sets the RuntimeConfiguration field's value.

func (UpdateRuntimeConfigurationInput) String added in v1.2.1 

func (s UpdateRuntimeConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 use by computes in the fleet. If the
	// update is successful, all property changes are shown.
	RuntimeConfiguration *RuntimeConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateRuntimeConfigurationOutput) GoString added in v1.2.1 

func (s UpdateRuntimeConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRuntimeConfigurationOutput) SetRuntimeConfiguration added in v1.5.0 

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

SetRuntimeConfiguration sets the RuntimeConfiguration field's value.

func (UpdateRuntimeConfigurationOutput) String added in v1.2.1 

func (s UpdateRuntimeConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateScriptInput added in v1.19.18 

type UpdateScriptInput struct {

	// A descriptive label that is associated with a script. Script names don't
	// need to be unique.
	Name *string `min:"1" type:"string"`

	// A unique identifier for the Realtime script to update. You can use either
	// the script ID or ARN value.
	//
	// ScriptId is a required field
	ScriptId *string `type:"string" required:"true"`

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

	// Version information associated with a build or script. Version strings don't
	// need to be unique.
	Version *string `min:"1" type:"string"`

	// A data object containing your Realtime scripts and dependencies as a zip
	// file. The zip file can have one or multiple files. Maximum size of a zip
	// file is 5 MB.
	//
	// When using the Amazon Web Services CLI tool to create a script, this parameter
	// is set to the zip file name. It must be prepended with the string "fileb://"
	// to indicate that the file data is a binary object. For example: --zip-file
	// fileb://myRealtimeScript.zip.
	// ZipFile is automatically base64 encoded/decoded by the SDK.
	ZipFile []byte `type:"blob"`
	// contains filtered or unexported fields
}

func (UpdateScriptInput) GoString added in v1.19.18 

func (s UpdateScriptInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateScriptInput) SetName added in v1.19.18 

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

SetName sets the Name field's value.

func (*UpdateScriptInput) SetScriptId added in v1.19.18 

func (s *UpdateScriptInput) SetScriptId(v string) *UpdateScriptInput

SetScriptId sets the ScriptId field's value.

func (*UpdateScriptInput) SetStorageLocation added in v1.19.18 

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

SetStorageLocation sets the StorageLocation field's value.

func (*UpdateScriptInput) SetVersion added in v1.19.18 

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

SetVersion sets the Version field's value.

func (*UpdateScriptInput) SetZipFile added in v1.19.18 

func (s *UpdateScriptInput) SetZipFile(v []byte) *UpdateScriptInput

SetZipFile sets the ZipFile field's value.

func (UpdateScriptInput) String added in v1.19.18 

func (s UpdateScriptInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateScriptInput) Validate added in v1.19.18 

func (s *UpdateScriptInput) Validate() error

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

type UpdateScriptOutput added in v1.19.18 

type UpdateScriptOutput struct {

	// The newly created script record with a unique script ID. The new script's
	// storage location reflects an Amazon S3 location: (1) If the script was uploaded
	// from an S3 bucket under your account, the storage location reflects the information
	// that was provided in the CreateScript request; (2) If the script file was
	// uploaded from a local zip file, the storage location reflects an S3 location
	// controls by the Amazon GameLift service.
	Script *Script `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateScriptOutput) GoString added in v1.19.18 

func (s UpdateScriptOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateScriptOutput) SetScript added in v1.19.18 

func (s *UpdateScriptOutput) SetScript(v *Script) *UpdateScriptOutput

SetScript sets the Script field's value.

func (UpdateScriptOutput) String added in v1.19.18 

func (s UpdateScriptOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidateMatchmakingRuleSetInput added in v1.10.27 

type ValidateMatchmakingRuleSetInput struct {

	// A collection of matchmaking rules to validate, formatted as a JSON string.
	//
	// RuleSetBody is a required field
	RuleSetBody *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ValidateMatchmakingRuleSetInput) GoString added in v1.10.27 

func (s ValidateMatchmakingRuleSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidateMatchmakingRuleSetInput) SetRuleSetBody added in v1.10.27 

func (s *ValidateMatchmakingRuleSetInput) SetRuleSetBody(v string) *ValidateMatchmakingRuleSetInput

SetRuleSetBody sets the RuleSetBody field's value.

func (ValidateMatchmakingRuleSetInput) String added in v1.10.27 

func (s ValidateMatchmakingRuleSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidateMatchmakingRuleSetInput) Validate added in v1.10.27 

func (s *ValidateMatchmakingRuleSetInput) Validate() error

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

type ValidateMatchmakingRuleSetOutput added in v1.10.27 

type ValidateMatchmakingRuleSetOutput struct {

	// A response indicating whether the rule set is valid.
	Valid *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (ValidateMatchmakingRuleSetOutput) GoString added in v1.10.27 

func (s ValidateMatchmakingRuleSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidateMatchmakingRuleSetOutput) SetValid added in v1.10.27 

func (s *ValidateMatchmakingRuleSetOutput) SetValid(v bool) *ValidateMatchmakingRuleSetOutput

SetValid sets the Valid field's value.

func (ValidateMatchmakingRuleSetOutput) String added in v1.10.27 

func (s ValidateMatchmakingRuleSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcPeeringAuthorization added in v1.10.37 

type VpcPeeringAuthorization struct {

	// Time stamp indicating when this authorization was issued. Format is a number
	// expressed in Unix time as milliseconds (for example "1469498468.057").
	CreationTime *time.Time `type:"timestamp"`

	// Time stamp indicating when this authorization expires (24 hours after issuance).
	// Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
	ExpirationTime *time.Time `type:"timestamp"`

	// A unique identifier for the Amazon Web Services account that you use to manage
	// your Amazon GameLift fleet. You can find your Account ID in the Amazon Web
	// Services Management Console under account settings.
	GameLiftAwsAccountId *string `min:"1" type:"string"`

	// The authorization's peer VPC Amazon Web Services account ID.
	PeerVpcAwsAccountId *string `min:"1" type:"string"`

	// A unique identifier for a VPC with resources to be accessed by your Amazon
	// GameLift fleet. The VPC must be in the same Region as your fleet. To look
	// up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/)
	// in the Amazon Web Services Management Console. Learn more about VPC peering
	// in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html).
	PeerVpcId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents an authorization for a VPC peering connection between the VPC for an Amazon GameLift fleet and another VPC on an account you have access to. This authorization must exist and be valid for the peering connection to be established. Authorizations are valid for 24 hours after they are issued.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

func (VpcPeeringAuthorization) GoString added in v1.10.37 

func (s VpcPeeringAuthorization) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcPeeringAuthorization) SetCreationTime added in v1.10.37 

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

SetCreationTime sets the CreationTime field's value.

func (*VpcPeeringAuthorization) SetExpirationTime added in v1.10.37 

func (s *VpcPeeringAuthorization) SetExpirationTime(v time.Time) *VpcPeeringAuthorization

SetExpirationTime sets the ExpirationTime field's value.

func (*VpcPeeringAuthorization) SetGameLiftAwsAccountId added in v1.10.37 

func (s *VpcPeeringAuthorization) SetGameLiftAwsAccountId(v string) *VpcPeeringAuthorization

SetGameLiftAwsAccountId sets the GameLiftAwsAccountId field's value.

func (*VpcPeeringAuthorization) SetPeerVpcAwsAccountId added in v1.10.37 

func (s *VpcPeeringAuthorization) SetPeerVpcAwsAccountId(v string) *VpcPeeringAuthorization

SetPeerVpcAwsAccountId sets the PeerVpcAwsAccountId field's value.

func (*VpcPeeringAuthorization) SetPeerVpcId added in v1.10.37 

func (s *VpcPeeringAuthorization) SetPeerVpcId(v string) *VpcPeeringAuthorization

SetPeerVpcId sets the PeerVpcId field's value.

func (VpcPeeringAuthorization) String added in v1.10.37 

func (s VpcPeeringAuthorization) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcPeeringConnection added in v1.10.37 

type VpcPeeringConnection struct {

	// The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html))
	// associated with the GameLift fleet resource for this connection.
	FleetArn *string `type:"string"`

	// A unique identifier for the fleet. This ID determines the ID of the Amazon
	// GameLift VPC for your fleet.
	FleetId *string `type:"string"`

	// A unique identifier for the VPC that contains the Amazon GameLift fleet for
	// this connection. This VPC is managed by Amazon GameLift and does not appear
	// in your Amazon Web Services account.
	GameLiftVpcId *string `min:"1" type:"string"`

	// CIDR block of IPv4 addresses assigned to the VPC peering connection for the
	// GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with
	// it; these blocks cannot overlap or the peering connection cannot be created.
	IpV4CidrBlock *string `min:"1" type:"string"`

	// A unique identifier for a VPC with resources to be accessed by your Amazon
	// GameLift fleet. The VPC must be in the same Region as your fleet. To look
	// up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/)
	// in the Amazon Web Services Management Console. Learn more about VPC peering
	// in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html).
	PeerVpcId *string `min:"1" type:"string"`

	// The status information about the connection. Status indicates if a connection
	// is pending, successful, or failed.
	Status *VpcPeeringConnectionStatus `type:"structure"`

	// A unique identifier that is automatically assigned to the connection record.
	// This ID is referenced in VPC peering connection events, and is used when
	// deleting a connection.
	VpcPeeringConnectionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a peering connection between a VPC on one of your Amazon Web Services accounts and the VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a pending connection that has not yet been established.

All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

func (VpcPeeringConnection) GoString added in v1.10.37 

func (s VpcPeeringConnection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcPeeringConnection) SetFleetArn added in v1.26.6 

func (s *VpcPeeringConnection) SetFleetArn(v string) *VpcPeeringConnection

SetFleetArn sets the FleetArn field's value.

func (*VpcPeeringConnection) SetFleetId added in v1.10.37 

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

SetFleetId sets the FleetId field's value.

func (*VpcPeeringConnection) SetGameLiftVpcId added in v1.10.37 

func (s *VpcPeeringConnection) SetGameLiftVpcId(v string) *VpcPeeringConnection

SetGameLiftVpcId sets the GameLiftVpcId field's value.

func (*VpcPeeringConnection) SetIpV4CidrBlock added in v1.10.37 

func (s *VpcPeeringConnection) SetIpV4CidrBlock(v string) *VpcPeeringConnection

SetIpV4CidrBlock sets the IpV4CidrBlock field's value.

func (*VpcPeeringConnection) SetPeerVpcId added in v1.10.37 

func (s *VpcPeeringConnection) SetPeerVpcId(v string) *VpcPeeringConnection

SetPeerVpcId sets the PeerVpcId field's value.

func (*VpcPeeringConnection) SetStatus added in v1.10.37 

func (s *VpcPeeringConnection) SetStatus(v *VpcPeeringConnectionStatus) *VpcPeeringConnection

SetStatus sets the Status field's value.

func (*VpcPeeringConnection) SetVpcPeeringConnectionId added in v1.10.37 

func (s *VpcPeeringConnection) SetVpcPeeringConnectionId(v string) *VpcPeeringConnection

SetVpcPeeringConnectionId sets the VpcPeeringConnectionId field's value.

func (VpcPeeringConnection) String added in v1.10.37 

func (s VpcPeeringConnection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcPeeringConnectionStatus added in v1.10.37 

type VpcPeeringConnectionStatus struct {

	// Code indicating the status of a VPC peering connection.
	Code *string `min:"1" type:"string"`

	// Additional messaging associated with the connection status.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents status information for a VPC peering connection. Status codes and messages are provided from EC2 (see VpcPeeringConnectionStateReason (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_VpcPeeringConnectionStateReason.html)). Connection status information is also communicated as a fleet event.

func (VpcPeeringConnectionStatus) GoString added in v1.10.37 

func (s VpcPeeringConnectionStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcPeeringConnectionStatus) SetCode added in v1.10.37 

func (s *VpcPeeringConnectionStatus) SetCode(v string) *VpcPeeringConnectionStatus

SetCode sets the Code field's value.

func (*VpcPeeringConnectionStatus) SetMessage added in v1.10.37 

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

SetMessage sets the Message field's value.

func (VpcPeeringConnectionStatus) String added in v1.10.37 

func (s VpcPeeringConnectionStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.