gameliftstreams

package module
v1.8.1 Latest Latest
Warning

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

Go to latest
Published: Oct 30, 2025 License: Apache-2.0 Imports: 47 Imported by: 2

Documentation

Overview

Package gameliftstreams provides the API client, operations, and parameter types for Amazon GameLift Streams.

Amazon GameLift Streams

Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand.

This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (CLI), or by making direct REST calls through HTTPS.

See the Amazon GameLift Streams Developer Guide for more information on how Amazon GameLift Streams works and how to work with it.

Index

Constants

View Source
const ServiceAPIVersion = "2018-05-10"
View Source
const ServiceID = "GameLiftStreams"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

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

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

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AddStreamGroupLocationsInput

type AddStreamGroupLocationsInput struct {

	//  A stream group to add the specified locations to.
	//
	// This value is an [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource.
	// Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	//  A set of one or more locations and the streaming capacity for each location.
	//
	// This member is required.
	LocationConfigurations []types.LocationConfiguration
	// contains filtered or unexported fields
}

type AddStreamGroupLocationsOutput

type AddStreamGroupLocationsOutput struct {

	// This value is an [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource.
	// Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	// This value is set of locations, including their name, current status, and
	// capacities.
	//
	// A location can be in one of the following states:
	//
	//   - ACTIVATING : Amazon GameLift Streams is preparing the location. You cannot
	//   stream from, scale the capacity of, or remove this location yet.
	//
	//   - ACTIVE : The location is provisioned with initial capacity. You can now
	//   stream from, scale the capacity of, or remove this location.
	//
	//   - ERROR : Amazon GameLift Streams failed to set up this location. The
	//   StatusReason field describes the error. You can remove this location and try
	//   to add it again.
	//
	//   - REMOVING : Amazon GameLift Streams is working to remove this location. This
	//   will release all provisioned capacity for this location in this stream group.
	//
	// This member is required.
	Locations []types.LocationState

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

type ApplicationDeletedWaiter

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

ApplicationDeletedWaiter defines the waiters for ApplicationDeleted

func NewApplicationDeletedWaiter

func NewApplicationDeletedWaiter(client GetApplicationAPIClient, optFns ...func(*ApplicationDeletedWaiterOptions)) *ApplicationDeletedWaiter

NewApplicationDeletedWaiter constructs a ApplicationDeletedWaiter.

func (*ApplicationDeletedWaiter) Wait

Wait calls the waiter function for ApplicationDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ApplicationDeletedWaiter) WaitForOutput

WaitForOutput calls the waiter function for ApplicationDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ApplicationDeletedWaiterOptions

type ApplicationDeletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ApplicationDeletedWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ApplicationDeletedWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetApplicationInput, *GetApplicationOutput, error) (bool, error)
}

ApplicationDeletedWaiterOptions are waiter options for ApplicationDeletedWaiter

type ApplicationReadyWaiter

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

ApplicationReadyWaiter defines the waiters for ApplicationReady

func NewApplicationReadyWaiter

func NewApplicationReadyWaiter(client GetApplicationAPIClient, optFns ...func(*ApplicationReadyWaiterOptions)) *ApplicationReadyWaiter

NewApplicationReadyWaiter constructs a ApplicationReadyWaiter.

func (*ApplicationReadyWaiter) Wait

func (w *ApplicationReadyWaiter) Wait(ctx context.Context, params *GetApplicationInput, maxWaitDur time.Duration, optFns ...func(*ApplicationReadyWaiterOptions)) error

Wait calls the waiter function for ApplicationReady waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ApplicationReadyWaiter) WaitForOutput

func (w *ApplicationReadyWaiter) WaitForOutput(ctx context.Context, params *GetApplicationInput, maxWaitDur time.Duration, optFns ...func(*ApplicationReadyWaiterOptions)) (*GetApplicationOutput, error)

WaitForOutput calls the waiter function for ApplicationReady waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ApplicationReadyWaiterOptions

type ApplicationReadyWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ApplicationReadyWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ApplicationReadyWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetApplicationInput, *GetApplicationOutput, error) (bool, error)
}

ApplicationReadyWaiterOptions are waiter options for ApplicationReadyWaiter

type AssociateApplicationsInput

type AssociateApplicationsInput struct {

	// A set of applications to associate with the stream group.
	//
	// This value is a set of either [Amazon Resource Names (ARN)] or IDs that uniquely identify application
	// resources. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 . Example
	// ID: a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Names (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	ApplicationIdentifiers []string

	// A stream group to associate to the applications.
	//
	// This value is an [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource.
	// Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type AssociateApplicationsOutput

type AssociateApplicationsOutput struct {

	// A set of applications that are associated to the stream group.
	//
	// This value is a set of [Amazon Resource Names (ARNs)] that uniquely identify application resources. Example
	// ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	ApplicationArns []string

	// A stream group that is associated to the applications.
	//
	// This value is an [Amazon Resource Name (ARN)] that uniquely identifies the stream group resource. Example
	// ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	Arn *string

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

type AuthResolverParameters

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client

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

Client provides the API client to make operations call for Amazon GameLift Streams.

func New

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

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

func NewFromConfig

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

NewFromConfig returns a new client from the provided config.

func (*Client) AddStreamGroupLocations

func (c *Client) AddStreamGroupLocations(ctx context.Context, params *AddStreamGroupLocationsInput, optFns ...func(*Options)) (*AddStreamGroupLocationsOutput, error)
Add locations that can host stream sessions. To add a location, the stream

group must be in ACTIVE status. You configure locations and their corresponding capacity for each stream group. Creating a stream group in a location that's nearest to your end users can help minimize latency and improve quality.

This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the stream class option: 2 for 'High' and 1 for 'Ultra' and 'Win2022'. This operation also copies the content files of all associated applications to an internal S3 bucket at each location. This allows Amazon GameLift Streams to host performant stream sessions.

func (*Client) AssociateApplications

func (c *Client) AssociateApplications(ctx context.Context, params *AssociateApplicationsInput, optFns ...func(*Options)) (*AssociateApplicationsOutput, error)

When you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group's allocated compute resources. The stream group must be in ACTIVE status. You can reverse this action by using DisassociateApplications.

If a stream group does not already have a linked application, Amazon GameLift Streams will automatically assign the first application provided in ApplicationIdentifiers as the default.

func (*Client) CreateApplication

func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)

Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it.

Before you create an application, upload your application content files to an Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Getting Started in the Amazon GameLift Streams Developer Guide.

Make sure that your files in the Amazon S3 bucket are the correct version you want to use. If you change the files at a later time, you will need to create a new Amazon GameLift Streams application.

If the request is successful, Amazon GameLift Streams begins to create an application and sets the status to INITIALIZED . When an application reaches READY status, you can use the application to set up stream groups and start streams. To track application status, call GetApplication.

func (*Client) CreateStreamGroup

func (c *Client) CreateStreamGroup(ctx context.Context, params *CreateStreamGroupInput, optFns ...func(*Options)) (*CreateStreamGroupOutput, error)
Stream groups manage how Amazon GameLift Streams allocates resources and

handles concurrent streams, allowing you to effectively manage capacity and costs. Within a stream group, you specify an application to stream, streaming locations and their capacity, and the stream class you want to use when streaming applications to your end-users. A stream class defines the hardware configuration of the compute resources that Amazon GameLift Streams will use when streaming, such as the CPU, GPU, and memory.

Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:

  • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 (2 for high stream classes) when creating a stream group or adding a location.

  • On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.

Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.

To adjust the capacity of any ACTIVE stream group, call UpdateStreamGroup.

If the CreateStreamGroup request is successful, Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING . It can take a few minutes for Amazon GameLift Streams to finish creating the stream group while it searches for unallocated compute resources and provisions them. When complete, the stream group status will be ACTIVE and you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup.

Stream groups should be recreated every 3-4 weeks to pick up important service updates and fixes. Stream groups that are older than 180 days can no longer be updated with new application associations. Stream groups expire when they are 365 days old, at which point they can no longer stream sessions. The exact expiration date is indicated by the date value in the ExpiresAt field.

func (*Client) CreateStreamSessionConnection

func (c *Client) CreateStreamSessionConnection(ctx context.Context, params *CreateStreamSessionConnectionInput, optFns ...func(*Options)) (*CreateStreamSessionConnectionOutput, error)

Enables clients to reconnect to a stream session while preserving all session state and data in the disconnected session. This reconnection process can be initiated when a stream session is in either PENDING_CLIENT_RECONNECTION or ACTIVE status. The process works as follows:

  • Initial disconnect:

  • When a client disconnects or loses connection, the stream session transitions from CONNECTED to PENDING_CLIENT_RECONNECTION

  • Reconnection time window:

  • Clients have ConnectionTimeoutSeconds (defined in StartStreamSession) to reconnect before session termination

  • Your backend server must call CreateStreamSessionConnection to initiate reconnection

  • Session transitions to RECONNECTING status

  • Reconnection completion:

  • On successful CreateStreamSessionConnection, session status changes to ACTIVE

  • Provide the new connection information to the requesting client

  • Client must establish connection within ConnectionTimeoutSeconds

  • Session terminates automatically if client fails to connect in time

For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.

To begin re-connecting to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, and the signal request to use with the stream.

func (*Client) DeleteApplication

func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)

Permanently deletes an Amazon GameLift Streams application resource. This also deletes the application content files stored with Amazon GameLift Streams. However, this does not delete the original files that you uploaded to your Amazon S3 bucket; you can delete these any time after Amazon GameLift Streams creates an application, which is the only time Amazon GameLift Streams accesses your Amazon S3 bucket.

You can only delete an application that meets the following conditions:

  • The application is in READY or ERROR status. You cannot delete an application that's in PROCESSING or INITIALIZED status.

  • The application is not the default application of any stream groups. You must first delete the stream group by using DeleteStreamGroup.

  • The application is not linked to any stream groups. You must first unlink the stream group by using DisassociateApplications.

  • An application is not streaming in any ongoing stream session. You must wait until the client ends the stream session or call TerminateStreamSessionto end the stream.

If any active stream groups exist for this application, this request returns a ValidationException .

func (*Client) DeleteStreamGroup

func (c *Client) DeleteStreamGroup(ctx context.Context, params *DeleteStreamGroupInput, optFns ...func(*Options)) (*DeleteStreamGroupOutput, error)

Permanently deletes all compute resources and information related to a stream group. To delete a stream group, specify the unique stream group identifier. During the deletion process, the stream group's status is DELETING . This operation stops streams in progress and prevents new streams from starting. As a best practice, before deleting the stream group, call ListStreamSessionsto check for streams in progress and take action to stop them. When you delete a stream group, any application associations referring to that stream group are automatically removed.

func (*Client) DisassociateApplications

func (c *Client) DisassociateApplications(ctx context.Context, params *DisassociateApplicationsInput, optFns ...func(*Options)) (*DisassociateApplicationsOutput, error)
When you disassociate, or unlink, an application from a stream group, you can

no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams in the stream group using the disassociated application. The disassociate action does not affect the stream capacity of a stream group. To disassociate an application, the stream group must be in ACTIVE status.

If you disassociate the default application, Amazon GameLift Streams will automatically choose a new default application from the remaining associated applications. To change which application is the default application, call UpdateStreamGroupand specify a new DefaultApplicationIdentifier .

func (*Client) ExportStreamSessionFiles

func (c *Client) ExportStreamSessionFiles(ctx context.Context, params *ExportStreamSessionFilesInput, optFns ...func(*Options)) (*ExportStreamSessionFilesOutput, error)
Export the files that your application modifies or generates in a stream

session, which can help you debug or verify your application. When your application runs, it generates output files such as logs, diagnostic information, crash dumps, save files, user data, screenshots, and so on. The files can be defined by the engine or frameworks that your application uses, or information that you've programmed your application to output.

You can only call this action on a stream session that is in progress, specifically in one of the following statuses ACTIVE , CONNECTED , PENDING_CLIENT_RECONNECTION , and RECONNECTING . You must provide an Amazon Simple Storage Service (Amazon S3) bucket to store the files in. When the session ends, Amazon GameLift Streams produces a compressed folder that contains all of the files and directories that were modified or created by the application during the stream session. AWS uses your security credentials to authenticate and authorize access to your Amazon S3 bucket.

Amazon GameLift Streams collects the following generated and modified files. Find them in the corresponding folders in the .zip archive.

  • application/ : The folder where your application or game is stored.

  • profile/ : The user profile folder.

  • temp/ : The system temp folder.

To verify the status of the exported files, use GetStreamSession.

To delete the files, delete the object in the S3 bucket.

func (*Client) GetApplication

func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)

Retrieves properties for an Amazon GameLift Streams application resource. Specify the ID of the application that you want to retrieve. If the operation is successful, it returns properties for the requested application.

func (*Client) GetStreamGroup

func (c *Client) GetStreamGroup(ctx context.Context, params *GetStreamGroupInput, optFns ...func(*Options)) (*GetStreamGroupOutput, error)

Retrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream group that you want to retrieve. If the operation is successful, it returns properties for the requested stream group.

func (*Client) GetStreamSession

func (c *Client) GetStreamSession(ctx context.Context, params *GetStreamSessionInput, optFns ...func(*Options)) (*GetStreamSessionOutput, error)

Retrieves properties for a Amazon GameLift Streams stream session resource. Specify the Amazon Resource Name (ARN) of the stream session that you want to retrieve and its stream group ARN. If the operation is successful, it returns properties for the requested resource.

func (*Client) ListApplications

func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)

Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. This operation returns applications in all statuses, in no particular order. You can paginate the results as needed.

func (*Client) ListStreamGroups

func (c *Client) ListStreamGroups(ctx context.Context, params *ListStreamGroupsInput, optFns ...func(*Options)) (*ListStreamGroupsOutput, error)

Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed.

func (*Client) ListStreamSessions

func (c *Client) ListStreamSessions(ctx context.Context, params *ListStreamSessionsInput, optFns ...func(*Options)) (*ListStreamSessionsOutput, error)

Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting.

To retrieve stream sessions, specify the stream group, and optionally filter by stream session status. You can paginate the results as needed.

This operation returns the requested stream sessions in no particular order.

func (*Client) ListStreamSessionsByAccount

func (c *Client) ListStreamSessionsByAccount(ctx context.Context, params *ListStreamSessionsByAccountInput, optFns ...func(*Options)) (*ListStreamSessionsByAccountOutput, error)

Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to.

In the returned list of stream sessions, the ExportFilesMetadata property only shows the Status value. To get the OutpurUri and StatusReason values, use GetStreamSession.

We don't recommend using this operation to regularly check stream session statuses because it's costly. Instead, to check status updates for a specific stream session, use GetStreamSession.

func (*Client) ListTagsForResource

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

Retrieves all tags assigned to a Amazon GameLift Streams resource. To list tags for a resource, specify the ARN value for the resource.

Learn more

Tagging Amazon Web Services Resourcesin the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

func (*Client) Options

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) RemoveStreamGroupLocations

func (c *Client) RemoveStreamGroupLocations(ctx context.Context, params *RemoveStreamGroupLocationsInput, optFns ...func(*Options)) (*RemoveStreamGroupLocationsOutput, error)
Removes a set of remote locations from this stream group. To remove a

location, the stream group must be in ACTIVE status. When you remove a location, Amazon GameLift Streams releases allocated compute resources in that location. Stream sessions can no longer start from removed locations in a stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal Amazon S3 bucket at this location.

You cannot remove the Amazon Web Services Region location where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero to avoid incurring costs for allocated compute resources in that location.

func (*Client) StartStreamSession

func (c *Client) StartStreamSession(ctx context.Context, params *StartStreamSessionInput, optFns ...func(*Options)) (*StartStreamSessionOutput, error)
This action initiates a new stream session and outputs connection information

that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource that a stream group has allocated. The start stream session process works as follows:

  • Prerequisites:

  • You must have a stream group in ACTIVE status

  • You must have idle or on-demand capacity in a stream group in the location you want to stream from

  • You must have at least one application associated to the stream group (use AssociateApplications if needed)

  • Start stream request:

  • Your backend server calls StartStreamSession to initiate connection

  • Amazon GameLift Streams creates the stream session resource, assigns an Amazon Resource Name (ARN) value, and begins searching for available stream capacity to run the stream

  • Session transitions to ACTIVATING status

  • Placement completion:

  • If Amazon GameLift Streams is successful in finding capacity for the stream, the stream session status changes to ACTIVE status and StartStreamSession returns stream connection information

  • If Amazon GameLift Streams was not successful in finding capacity within the placement timeout period (defined according to the capacity type and platform type), the stream session status changes to ERROR status and StartStreamSession returns a StatusReason of placementTimeout

  • Connection completion:

  • Provide the new connection information to the requesting client

  • Client must establish connection within ConnectionTimeoutSeconds (specified in StartStreamSession parameters)

  • Session terminates automatically if client fails to connect in time

For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.

Timeouts to be aware of that affect a stream session:

  • Placement timeout: The amount of time that Amazon GameLift Streams has to find capacity for a stream request. Placement timeout varies based on the capacity type used to fulfill your stream request:

  • Always-on capacity: 75 seconds

  • On-demand capacity:

  • Linux/Proton runtimes: 90 seconds

  • Windows runtime: 10 minutes

  • Connection timeout: The amount of time that Amazon GameLift Streams waits for a client to connect to a stream session in ACTIVE status, or reconnect to a stream session in PENDING_CLIENT_RECONNECTION status, the latter of which occurs when a client disconnects or loses connection from a stream session. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. This value is specified by ConnectionTimeoutSeconds in the StartStreamSession parameters.

  • Idle timeout: A stream session will be terminated if no user input has been received for 60 minutes.

  • Maximum session length: A stream session will be terminated after this amount of time has elapsed since it started, regardless of any existing client connections. This value is specified by SessionLengthSeconds in the StartStreamSession parameters.

To start a new stream session, specify a stream group ID and application ID, along with the transport protocol and signal request to use with the stream session.

For stream groups that have multiple locations, provide a set of locations ordered by priority using a Locations parameter. Amazon GameLift Streams will start a single stream session in the next available location. An application must be finished replicating to a remote location before the remote location can host a stream.

To reconnect to a stream session after a client disconnects or loses connection, use CreateStreamSessionConnection.

func (*Client) TagResource

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

Assigns one or more tags to a Amazon GameLift Streams resource. Use tags to organize Amazon Web Services resources for a range of purposes. You can assign tags to the following Amazon GameLift Streams resource types:

  • Application

  • StreamGroup

Learn more

Tagging Amazon Web Services Resourcesin the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

func (*Client) TerminateStreamSession

func (c *Client) TerminateStreamSession(ctx context.Context, params *TerminateStreamSessionInput, optFns ...func(*Options)) (*TerminateStreamSessionOutput, error)

Permanently terminates an active stream session. When called, the stream session status changes to TERMINATING . You can terminate a stream session in any status except ACTIVATING . If the stream session is in ACTIVATING status, an exception is thrown.

func (*Client) UntagResource

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

Removes one or more tags from a Amazon GameLift Streams resource. To remove tags, specify the Amazon GameLift Streams resource and a list of one or more tags to remove.

func (*Client) UpdateApplication

func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)
Updates the mutable configuration settings for a Amazon GameLift Streams

application resource. You can change the Description , ApplicationLogOutputUri , and ApplicationLogPaths .

To update application settings, specify the application ID and provide the new values. If the operation is successful, it returns the complete updated set of settings for the application.

func (*Client) UpdateStreamGroup

func (c *Client) UpdateStreamGroup(ctx context.Context, params *UpdateStreamGroupInput, optFns ...func(*Options)) (*UpdateStreamGroupOutput, error)
Updates the configuration settings for an Amazon GameLift Streams stream group

resource. To update a stream group, it must be in ACTIVE status. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group.

Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:

  • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 (2 for high stream classes) when creating a stream group or adding a location.

  • On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.

Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.

To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group. Expired stream groups cannot be updated.

type CreateApplicationInput

type CreateApplicationInput struct {

	// The location of the content that you want to stream. Enter an Amazon S3 URI to
	// a bucket that contains your game or other application. The location can have a
	// multi-level prefix structure, but it must include all the files needed to run
	// the content. Amazon GameLift Streams copies everything under the specified
	// location.
	//
	// This value is immutable. To designate a different content location, create a
	// new application.
	//
	// The Amazon S3 bucket and the Amazon GameLift Streams application must be in the
	// same Amazon Web Services Region.
	//
	// This member is required.
	ApplicationSourceUri *string

	// A human-readable label for the application. You can update this value later.
	//
	// This member is required.
	Description *string

	// The relative path and file name of the executable file that Amazon GameLift
	// Streams will stream. Specify a path relative to the location set in
	// ApplicationSourceUri . The file must be contained within the application's root
	// folder. For Windows applications, the file must be a valid Windows executable or
	// batch file with a filename ending in .exe, .cmd, or .bat. For Linux
	// applications, the file must be a valid Linux binary executable or a script that
	// contains an initial interpreter line starting with a shebang (' #! ').
	//
	// This member is required.
	ExecutablePath *string

	// Configuration settings that identify the operating system for an application
	// resource. This can also include a compatibility layer and other drivers.
	//
	// A runtime environment can be one of the following:
	//
	//   - For Linux applications
	//
	//   - Ubuntu 22.04 LTS ( Type=UBUNTU, Version=22_04_LTS )
	//
	//   - For Windows applications
	//
	//   - Microsoft Windows Server 2022 Base ( Type=WINDOWS, Version=2022 )
	//
	//   - Proton 9.0-2 ( Type=PROTON, Version=20250516 )
	//
	//   - Proton 8.0-5 ( Type=PROTON, Version=20241007 )
	//
	//   - Proton 8.0-2c ( Type=PROTON, Version=20230704 )
	//
	// This member is required.
	RuntimeEnvironment *types.RuntimeEnvironment

	// An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to
	// save application logs. Required if you specify one or more ApplicationLogPaths .
	//
	// The log bucket must have permissions that give Amazon GameLift Streams access
	// to write the log files. For more information, see [Application log bucket permission policy]in the Amazon GameLift
	// Streams Developer Guide.
	//
	// [Application log bucket permission policy]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template
	ApplicationLogOutputUri *string

	// Locations of log files that your content generates during a stream session.
	// Enter path values that are relative to the ApplicationSourceUri location. You
	// can specify up to 10 log paths. Amazon GameLift Streams uploads designated log
	// files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at
	// the end of a stream session. To retrieve stored log files, call [GetStreamSession]and get the
	// LogFileLocationUri .
	//
	// [GetStreamSession]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html
	ApplicationLogPaths []string

	//  A unique identifier that represents a client request. The request is
	// idempotent, which ensures that an API request completes only once. When users
	// send a request, Amazon GameLift Streams automatically populates this field.
	ClientToken *string

	// A list of labels to assign to the new application resource. Tags are
	// developer-defined key-value pairs. Tagging Amazon Web Services resources is
	// useful for resource management, access management and cost allocation. See [Tagging Amazon Web Services Resources]in
	// the Amazon Web Services General Reference. You can use [TagResource]to add tags, [UntagResource] to remove
	// tags, and [ListTagsForResource]to view tags on existing resources.
	//
	// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
	// [TagResource]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TagResource.html
	// [UntagResource]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UntagResource.html
	// [ListTagsForResource]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListTagsForResource.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateApplicationOutput

type CreateApplicationOutput struct {

	// The [Amazon Resource Name (ARN)] that's assigned to an application resource and uniquely identifies it
	// across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS
	// Region]:[AWS account]:application/[resource ID] .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Arn *string

	// An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to
	// save application logs. Required if you specify one or more ApplicationLogPaths .
	ApplicationLogOutputUri *string

	// Locations of log files that your content generates during a stream session.
	// Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you
	// specify in ApplicationLogOutputUri at the end of a stream session. To retrieve
	// stored log files, call [GetStreamSession]and get the LogFileLocationUri .
	//
	// [GetStreamSession]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html
	ApplicationLogPaths []string

	// The original Amazon S3 location of uploaded stream content for the application.
	ApplicationSourceUri *string

	// A newly created application is not associated to any stream groups. This value
	// is empty.
	AssociatedStreamGroups []string

	// A timestamp that indicates when this resource was created. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	CreatedAt *time.Time

	// A human-readable label for the application. You can edit this value.
	Description *string

	// The relative path and file name of the executable file that launches the
	// content for streaming.
	ExecutablePath *string

	// A unique ID value that is assigned to the resource when it's created. Format
	// example: a-9ZY8X7Wv6 .
	Id *string

	// A timestamp that indicates when this resource was last updated. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	LastUpdatedAt *time.Time

	// A set of replication statuses for each location.
	ReplicationStatuses []types.ReplicationStatus

	//  Configuration settings that identify the operating system for an application
	// resource. This can also include a compatibility layer and other drivers.
	//
	// A runtime environment can be one of the following:
	//
	//   - For Linux applications
	//
	//   - Ubuntu 22.04 LTS ( Type=UBUNTU, Version=22_04_LTS )
	//
	//   - For Windows applications
	//
	//   - Microsoft Windows Server 2022 Base ( Type=WINDOWS, Version=2022 )
	//
	//   - Proton 9.0-2 ( Type=PROTON, Version=20250516 )
	//
	//   - Proton 8.0-5 ( Type=PROTON, Version=20241007 )
	//
	//   - Proton 8.0-2c ( Type=PROTON, Version=20230704 )
	RuntimeEnvironment *types.RuntimeEnvironment

	// The current status of the application resource. Possible statuses include the
	// following:
	//
	//   - INITIALIZED : Amazon GameLift Streams has received the request and is
	//   initiating the work flow to create an application.
	//
	//   - PROCESSING : The create application work flow is in process. Amazon GameLift
	//   Streams is copying the content and caching for future deployment in a stream
	//   group.
	//
	//   - READY : The application is ready to deploy in a stream group.
	//
	//   - ERROR : An error occurred when setting up the application. See StatusReason
	//   for more information.
	//
	//   - DELETING : Amazon GameLift Streams is in the process of deleting the
	//   application.
	Status types.ApplicationStatus

	// A short description of the status reason when the application is in ERROR
	// status.
	StatusReason types.ApplicationStatusReason

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

type CreateStreamGroupInput

type CreateStreamGroupInput struct {

	// A descriptive label for the stream group.
	//
	// This member is required.
	Description *string

	// The target stream quality for sessions that are hosted in this stream group.
	// Set a stream class that is appropriate to the type of content that you're
	// streaming. Stream class determines the type of computing resources Amazon
	// GameLift Streams uses and impacts the cost of streaming. The following options
	// are available:
	//
	// A stream class can be one of the following:
	//
	//   - gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Runs applications on Microsoft Windows Server 2022 Base and
	//   supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32
	//   and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D
	//   scene complexity. Uses NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
	//
	//   - Tenancy: Supports up to 2 concurrent stream sessions
	//
	//   - gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Runs applications on Microsoft Windows Server 2022 Base and
	//   supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32
	//   and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D
	//   scene complexity. Uses NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
	//
	//   - Tenancy: Supports up to 2 concurrent stream sessions
	//
	//   - gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene
	//   complexity. Uses dedicated NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	// This member is required.
	StreamClass types.StreamClass

	//  A unique identifier that represents a client request. The request is
	// idempotent, which ensures that an API request completes only once. When users
	// send a request, Amazon GameLift Streams automatically populates this field.
	ClientToken *string

	// The unique identifier of the Amazon GameLift Streams application that you want
	// to set as the default application in a stream group. The application that you
	// specify must be in READY status. The default application is pre-cached on
	// always-on compute resources, reducing stream startup times. Other applications
	// are automatically cached as needed.
	//
	// If you do not link an application when you create a stream group, you will need
	// to link one later, before you can start streaming, using [AssociateApplications].
	//
	// This value is an [Amazon Resource Name (ARN)] or ID that uniquely identifies the application resource.
	// Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 . Example
	// ID: a-9ZY8X7Wv6 .
	//
	// [AssociateApplications]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	DefaultApplicationIdentifier *string

	//  A set of one or more locations and the streaming capacity for each location.
	LocationConfigurations []types.LocationConfiguration

	// A list of labels to assign to the new stream group resource. Tags are
	// developer-defined key-value pairs. Tagging Amazon Web Services resources is
	// useful for resource management, access management and cost allocation. See [Tagging Amazon Web Services Resources]in
	// the Amazon Web Services General Reference. You can use [TagResource]to add tags, [UntagResource] to remove
	// tags, and [ListTagsForResource]to view tags on existing resources.
	//
	// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
	// [TagResource]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TagResource.html
	// [UntagResource]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UntagResource.html
	// [ListTagsForResource]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListTagsForResource.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateStreamGroupOutput

type CreateStreamGroupOutput struct {

	// The [Amazon Resource Name (ARN)] that is assigned to the stream group resource and that uniquely identifies
	// the group across all Amazon Web Services Regions. Format is
	// arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID] .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Arn *string

	//  A set of applications that this stream group is associated to. You can stream
	// any of these applications by using this stream group.
	//
	// This value is a set of [Amazon Resource Names (ARNs)] that uniquely identify application resources. Example
	// ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	AssociatedApplications []string

	// A timestamp that indicates when this resource was created. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	CreatedAt *time.Time

	// The default Amazon GameLift Streams application that is associated with this
	// stream group.
	DefaultApplication *types.DefaultApplication

	// A descriptive label for the stream group.
	Description *string

	// The time at which this stream group expires. Timestamps are expressed using in
	// ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you
	// will no longer be able to update this stream group or use it to start stream
	// sessions. Only Get and Delete operations will work on an expired stream group.
	ExpiresAt *time.Time

	// A unique ID value that is assigned to the resource when it's created. Format
	// example: sg-1AB2C3De4 .
	Id *string

	// A timestamp that indicates when this resource was last updated. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	LastUpdatedAt *time.Time

	// This value is the set of locations, including their name, current status, and
	// capacities.
	//
	// A location can be in one of the following states:
	//
	//   - ACTIVATING : Amazon GameLift Streams is preparing the location. You cannot
	//   stream from, scale the capacity of, or remove this location yet.
	//
	//   - ACTIVE : The location is provisioned with initial capacity. You can now
	//   stream from, scale the capacity of, or remove this location.
	//
	//   - ERROR : Amazon GameLift Streams failed to set up this location. The
	//   StatusReason field describes the error. You can remove this location and try
	//   to add it again.
	//
	//   - REMOVING : Amazon GameLift Streams is working to remove this location. This
	//   will release all provisioned capacity for this location in this stream group.
	LocationStates []types.LocationState

	// The current status of the stream group resource. Possible statuses include the
	// following:
	//
	//   - ACTIVATING : The stream group is deploying and isn't ready to host streams.
	//
	//   - ACTIVE : The stream group is ready to host streams.
	//
	//   - ACTIVE_WITH_ERRORS : One or more locations in the stream group are in an
	//   error state. Verify the details of individual locations and remove any locations
	//   which are in error.
	//
	//   - DELETING : Amazon GameLift Streams is in the process of deleting the stream
	//   group.
	//
	//   - ERROR : An error occurred when the stream group deployed. See StatusReason
	//   (returned by CreateStreamGroup , GetStreamGroup , and UpdateStreamGroup ) for
	//   more information.
	//
	//   - EXPIRED : The stream group is expired and can no longer host streams. This
	//   typically occurs when a stream group is 365 days old, as indicated by the value
	//   of ExpiresAt . Create a new stream group to resume streaming capabilities.
	//
	//   - UPDATING_LOCATIONS : One or more locations in the stream group are in the
	//   process of updating (either activating or deleting).
	Status types.StreamGroupStatus

	//  A short description of the reason that the stream group is in ERROR status.
	// The possible reasons can be one of the following:
	//
	//   - internalError : The request can't process right now because of an issue with
	//   the server. Try again later.
	//
	//   - noAvailableInstances : Amazon GameLift Streams does not currently have
	//   enough available on-demand capacity to fulfill your request. Wait a few minutes
	//   and retry the request as capacity can shift frequently. You can also try to make
	//   the request using a different stream class or in another region.
	StatusReason types.StreamGroupStatusReason

	// The target stream quality for the stream group.
	//
	// A stream class can be one of the following:
	//
	//   - gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Runs applications on Microsoft Windows Server 2022 Base and
	//   supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32
	//   and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D
	//   scene complexity. Uses NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
	//
	//   - Tenancy: Supports up to 2 concurrent stream sessions
	//
	//   - gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Runs applications on Microsoft Windows Server 2022 Base and
	//   supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32
	//   and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D
	//   scene complexity. Uses NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
	//
	//   - Tenancy: Supports up to 2 concurrent stream sessions
	//
	//   - gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene
	//   complexity. Uses dedicated NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	StreamClass types.StreamClass

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

type CreateStreamSessionConnectionInput

type CreateStreamSessionConnectionInput struct {

	// [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// The stream group that you want to run this stream session with. The stream
	// group must be in ACTIVE status.
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	// A WebRTC ICE offer string to use when initializing a WebRTC connection. The
	// offer is a very long JSON string. Provide the string as a text value in quotes.
	// The offer must be newly generated, not the same offer provided to
	// StartStreamSession .
	//
	// This member is required.
	SignalRequest *string

	// [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream session resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567
	// . Example ID: ABC123def4567 .
	//
	// The stream session must be in PENDING_CLIENT_RECONNECTION or ACTIVE status.
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	StreamSessionIdentifier *string

	//  A unique identifier that represents a client request. The request is
	// idempotent, which ensures that an API request completes only once. When users
	// send a request, Amazon GameLift Streams automatically populates this field.
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateStreamSessionConnectionOutput

type CreateStreamSessionConnectionOutput struct {

	// The WebRTC answer string that the stream server generates in response to the
	// SignalRequest .
	SignalResponse *string

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

type DeleteApplicationInput

type DeleteApplicationInput struct {

	// An [Amazon Resource Name (ARN)] or ID that uniquely identifies the application resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 . Example
	// ID: a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteApplicationOutput

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

type DeleteStreamGroupInput

type DeleteStreamGroupInput struct {

	// An [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteStreamGroupOutput

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

type DisassociateApplicationsInput

type DisassociateApplicationsInput struct {

	// A set of applications that you want to disassociate from the stream group.
	//
	// This value is a set of either [Amazon Resource Names (ARN)] or IDs that uniquely identify application
	// resources. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 . Example
	// ID: a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Names (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	ApplicationIdentifiers []string

	// A stream group to disassociate these applications from.
	//
	// This value is an [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource.
	// Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DisassociateApplicationsOutput

type DisassociateApplicationsOutput struct {

	// A set of applications that are disassociated from this stream group.
	//
	// This value is a set of [Amazon Resource Names (ARNs)] that uniquely identify application resources. Example
	// ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	ApplicationArns []string

	// An [Amazon Resource Name (ARN)] that uniquely identifies the stream group resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	Arn *string

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

type EndpointParameters

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

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

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults

func (p EndpointParameters) WithDefaults() EndpointParameters

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

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

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

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

type EndpointResolverFunc

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

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

func (EndpointResolverFunc) ResolveEndpoint

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

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2

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

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExportStreamSessionFilesInput

type ExportStreamSessionFilesInput struct {

	// An [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	//  The S3 bucket URI where Amazon GameLift Streams uploads the set of compressed
	// exported files for this stream session. Amazon GameLift Streams generates a ZIP
	// file name based on the stream session metadata. Alternatively, you can provide a
	// custom file name with a .zip file extension.
	//
	// Example 1: If you provide an S3 URI called
	// s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip , then Amazon GameLift
	// Streams will save the files at that location.
	//
	// Example 2: If you provide an S3 URI called
	// s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/ , then Amazon
	// GameLift Streams will save the files at
	// s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip
	// or another similar name.
	//
	// This member is required.
	OutputUri *string

	// An [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream session resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567
	// . Example ID: ABC123def4567 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	StreamSessionIdentifier *string
	// contains filtered or unexported fields
}

type ExportStreamSessionFilesOutput

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

type GetApplicationAPIClient

type GetApplicationAPIClient interface {
	GetApplication(context.Context, *GetApplicationInput, ...func(*Options)) (*GetApplicationOutput, error)
}

GetApplicationAPIClient is a client that implements the GetApplication operation.

type GetApplicationInput

type GetApplicationInput struct {

	// An [Amazon Resource Name (ARN)] or ID that uniquely identifies the application resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 . Example
	// ID: a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetApplicationOutput

type GetApplicationOutput struct {

	// The [Amazon Resource Name (ARN)] that's assigned to an application resource and uniquely identifies it
	// across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS
	// Region]:[AWS account]:application/[resource ID] .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Arn *string

	// An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to
	// save application logs. Required if you specify one or more ApplicationLogPaths .
	ApplicationLogOutputUri *string

	// Locations of log files that your content generates during a stream session.
	// Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you
	// specify in ApplicationLogOutputUri at the end of a stream session. To retrieve
	// stored log files, call [GetStreamSession]and get the LogFileLocationUri .
	//
	// [GetStreamSession]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html
	ApplicationLogPaths []string

	// The original Amazon S3 location of uploaded stream content for the application.
	ApplicationSourceUri *string

	//  A set of stream groups that this application is associated with. You can use
	// any of these stream groups to stream your application.
	//
	// This value is a set of [Amazon Resource Names (ARNs)] that uniquely identify stream group resources. Example
	// ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	AssociatedStreamGroups []string

	// A timestamp that indicates when this resource was created. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	CreatedAt *time.Time

	// A human-readable label for the application. You can edit this value.
	Description *string

	// The relative path and file name of the executable file that launches the
	// content for streaming.
	ExecutablePath *string

	// A unique ID value that is assigned to the resource when it's created. Format
	// example: a-9ZY8X7Wv6 .
	Id *string

	// A timestamp that indicates when this resource was last updated. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	LastUpdatedAt *time.Time

	// A set of replication statuses for each location.
	ReplicationStatuses []types.ReplicationStatus

	//  Configuration settings that identify the operating system for an application
	// resource. This can also include a compatibility layer and other drivers.
	//
	// A runtime environment can be one of the following:
	//
	//   - For Linux applications
	//
	//   - Ubuntu 22.04 LTS ( Type=UBUNTU, Version=22_04_LTS )
	//
	//   - For Windows applications
	//
	//   - Microsoft Windows Server 2022 Base ( Type=WINDOWS, Version=2022 )
	//
	//   - Proton 9.0-2 ( Type=PROTON, Version=20250516 )
	//
	//   - Proton 8.0-5 ( Type=PROTON, Version=20241007 )
	//
	//   - Proton 8.0-2c ( Type=PROTON, Version=20230704 )
	RuntimeEnvironment *types.RuntimeEnvironment

	// The current status of the application resource. Possible statuses include the
	// following:
	//
	//   - INITIALIZED : Amazon GameLift Streams has received the request and is
	//   initiating the work flow to create an application.
	//
	//   - PROCESSING : The create application work flow is in process. Amazon GameLift
	//   Streams is copying the content and caching for future deployment in a stream
	//   group.
	//
	//   - READY : The application is ready to deploy in a stream group.
	//
	//   - ERROR : An error occurred when setting up the application. See StatusReason
	//   for more information.
	//
	//   - DELETING : Amazon GameLift Streams is in the process of deleting the
	//   application.
	Status types.ApplicationStatus

	// A short description of the status reason when the application is in ERROR
	// status.
	StatusReason types.ApplicationStatusReason

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

type GetStreamGroupAPIClient

type GetStreamGroupAPIClient interface {
	GetStreamGroup(context.Context, *GetStreamGroupInput, ...func(*Options)) (*GetStreamGroupOutput, error)
}

GetStreamGroupAPIClient is a client that implements the GetStreamGroup operation.

type GetStreamGroupInput

type GetStreamGroupInput struct {

	// An [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetStreamGroupOutput

type GetStreamGroupOutput struct {

	// The [Amazon Resource Name (ARN)] that is assigned to the stream group resource and that uniquely identifies
	// the group across all Amazon Web Services Regions. Format is
	// arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID] .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Arn *string

	//  A set of applications that this stream group is associated to. You can stream
	// any of these applications by using this stream group.
	//
	// This value is a set of [Amazon Resource Names (ARNs)] that uniquely identify application resources. Example
	// ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	AssociatedApplications []string

	// A timestamp that indicates when this resource was created. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	CreatedAt *time.Time

	// The default Amazon GameLift Streams application that is associated with this
	// stream group.
	DefaultApplication *types.DefaultApplication

	// A descriptive label for the stream group.
	Description *string

	// The time at which this stream group expires. Timestamps are expressed using in
	// ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you
	// will no longer be able to update this stream group or use it to start stream
	// sessions. Only Get and Delete operations will work on an expired stream group.
	ExpiresAt *time.Time

	// A unique ID value that is assigned to the resource when it's created. Format
	// example: sg-1AB2C3De4 .
	Id *string

	// A timestamp that indicates when this resource was last updated. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	LastUpdatedAt *time.Time

	// This value is the set of locations, including their name, current status, and
	// capacities.
	//
	// A location can be in one of the following states:
	//
	//   - ACTIVATING : Amazon GameLift Streams is preparing the location. You cannot
	//   stream from, scale the capacity of, or remove this location yet.
	//
	//   - ACTIVE : The location is provisioned with initial capacity. You can now
	//   stream from, scale the capacity of, or remove this location.
	//
	//   - ERROR : Amazon GameLift Streams failed to set up this location. The
	//   StatusReason field describes the error. You can remove this location and try
	//   to add it again.
	//
	//   - REMOVING : Amazon GameLift Streams is working to remove this location. This
	//   will release all provisioned capacity for this location in this stream group.
	LocationStates []types.LocationState

	// The current status of the stream group resource. Possible statuses include the
	// following:
	//
	//   - ACTIVATING : The stream group is deploying and isn't ready to host streams.
	//
	//   - ACTIVE : The stream group is ready to host streams.
	//
	//   - ACTIVE_WITH_ERRORS : One or more locations in the stream group are in an
	//   error state. Verify the details of individual locations and remove any locations
	//   which are in error.
	//
	//   - DELETING : Amazon GameLift Streams is in the process of deleting the stream
	//   group.
	//
	//   - ERROR : An error occurred when the stream group deployed. See StatusReason
	//   (returned by CreateStreamGroup , GetStreamGroup , and UpdateStreamGroup ) for
	//   more information.
	//
	//   - EXPIRED : The stream group is expired and can no longer host streams. This
	//   typically occurs when a stream group is 365 days old, as indicated by the value
	//   of ExpiresAt . Create a new stream group to resume streaming capabilities.
	//
	//   - UPDATING_LOCATIONS : One or more locations in the stream group are in the
	//   process of updating (either activating or deleting).
	Status types.StreamGroupStatus

	//  A short description of the reason that the stream group is in ERROR status.
	// The possible reasons can be one of the following:
	//
	//   - internalError : The request can't process right now because of an issue with
	//   the server. Try again later.
	//
	//   - noAvailableInstances : Amazon GameLift Streams does not currently have
	//   enough available on-demand capacity to fulfill your request. Wait a few minutes
	//   and retry the request as capacity can shift frequently. You can also try to make
	//   the request using a different stream class or in another region.
	StatusReason types.StreamGroupStatusReason

	// The target stream quality for the stream group.
	//
	// A stream class can be one of the following:
	//
	//   - gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Runs applications on Microsoft Windows Server 2022 Base and
	//   supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32
	//   and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D
	//   scene complexity. Uses NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
	//
	//   - Tenancy: Supports up to 2 concurrent stream sessions
	//
	//   - gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Runs applications on Microsoft Windows Server 2022 Base and
	//   supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32
	//   and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D
	//   scene complexity. Uses NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
	//
	//   - Tenancy: Supports up to 2 concurrent stream sessions
	//
	//   - gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene
	//   complexity. Uses dedicated NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	StreamClass types.StreamClass

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

type GetStreamSessionAPIClient

type GetStreamSessionAPIClient interface {
	GetStreamSession(context.Context, *GetStreamSessionInput, ...func(*Options)) (*GetStreamSessionOutput, error)
}

GetStreamSessionAPIClient is a client that implements the GetStreamSession operation.

type GetStreamSessionInput

type GetStreamSessionInput struct {

	// The stream group that runs this stream session.
	//
	// This value is an [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource.
	// Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	// An [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream session resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567
	// . Example ID: ABC123def4567 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	StreamSessionIdentifier *string
	// contains filtered or unexported fields
}

type GetStreamSessionOutput

type GetStreamSessionOutput struct {

	// A set of options that you can use to control the stream session runtime
	// environment, expressed as a set of key-value pairs. You can use this to
	// configure the application or stream session details. You can also provide custom
	// environment variables that Amazon GameLift Streams passes to your game client.
	//
	// If you want to debug your application with environment variables, we recommend
	// that you do so in a local environment outside of Amazon GameLift Streams. For
	// more information, refer to the Compatibility Guidance in the troubleshooting
	// section of the Developer Guide.
	//
	// AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes.
	// AdditionalEnvironmentVariables passes data using environment variables; while
	// AdditionalLaunchArgs passes data using command-line arguments.
	AdditionalEnvironmentVariables map[string]string

	// A list of CLI arguments that are sent to the streaming server when a stream
	// session launches. You can use this to configure the application or stream
	// session details. You can also provide custom arguments that Amazon GameLift
	// Streams passes to your game client.
	//
	// AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes.
	// AdditionalEnvironmentVariables passes data using environment variables; while
	// AdditionalLaunchArgs passes data using command-line arguments.
	AdditionalLaunchArgs []string

	// The application streaming in this session.
	//
	// This value is an [Amazon Resource Name (ARN)] that uniquely identifies the application resource. Example
	// ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	ApplicationArn *string

	// The [Amazon Resource Name (ARN)] that's assigned to a stream session resource. When combined with the
	// stream group resource ID, this value uniquely identifies the stream session
	// across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS
	// Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session
	// resource ID] .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	Arn *string

	// The length of time that Amazon GameLift Streams should wait for a client to
	// connect or reconnect to the stream session. This time span starts when the
	// stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no
	// client connects (or reconnects) before the timeout, Amazon GameLift Streams
	// terminates the stream session.
	ConnectionTimeoutSeconds *int32

	// A timestamp that indicates when this resource was created. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	CreatedAt *time.Time

	// A human-readable label for the stream session. You can update this value at any
	// time.
	Description *string

	// Provides details about the stream session's exported files.
	ExportFilesMetadata *types.ExportFilesMetadata

	// A timestamp that indicates when this resource was last updated. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	LastUpdatedAt *time.Time

	// The location where Amazon GameLift Streams hosts and streams your application.
	// For example, us-east-1 . For a complete list of locations that Amazon GameLift
	// Streams supports, refer to [Regions, quotas, and limitations]in the Amazon GameLift Streams Developer Guide.
	//
	// [Regions, quotas, and limitations]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html
	Location *string

	// Access location for log files that your content generates during a stream
	// session. These log files are uploaded to cloud storage location at the end of a
	// stream session. The Amazon GameLift Streams application resource defines which
	// log files to upload.
	LogFileLocationUri *string

	// The data transfer protocol in use with the stream session.
	Protocol types.Protocol

	// The maximum duration of a session. Amazon GameLift Streams will automatically
	// terminate a session after this amount of time has elapsed, regardless of any
	// existing client connections.
	SessionLengthSeconds *int32

	// The WebRTC ICE offer string that a client generates to initiate a connection to
	// the stream session.
	SignalRequest *string

	// The WebRTC answer string that the stream server generates in response to the
	// SignalRequest .
	SignalResponse *string

	// The current status of the stream session. A stream session is ready for a
	// client to connect when in ACTIVE status.
	//
	//   - ACTIVATING : The stream session is starting and preparing to stream.
	//
	//   - ACTIVE : The stream session is ready and waiting for a client connection. A
	//   client has ConnectionTimeoutSeconds (specified in StartStreamSession ) from
	//   when the session reaches ACTIVE state to establish a connection. If no client
	//   connects within this timeframe, the session automatically terminates.
	//
	//   - CONNECTED : The stream session has a connected client. A session will
	//   automatically terminate if there is no user input for 60 minutes, or if the
	//   maximum length of a session specified by SessionLengthSeconds in
	//   StartStreamSession is exceeded.
	//
	//   - ERROR : The stream session failed to activate. See StatusReason (returned by
	//   GetStreamSession and StartStreamSession ) for more information.
	//
	//   - PENDING_CLIENT_RECONNECTION : A client has recently disconnected and the
	//   stream session is waiting for the client to reconnect. A client has
	//   ConnectionTimeoutSeconds (specified in StartStreamSession ) from when the
	//   session reaches PENDING_CLIENT_RECONNECTION state to re-establish a
	//   connection. If no client connects within this timeframe, the session
	//   automatically terminates.
	//
	//   - RECONNECTING : A client has initiated a reconnect to a session that was in
	//   PENDING_CLIENT_RECONNECTION state.
	//
	//   - TERMINATING : The stream session is ending.
	//
	//   - TERMINATED : The stream session has ended.
	Status types.StreamSessionStatus

	// A short description of the reason the stream session is in ERROR status or
	// TERMINATED status.
	//
	// ERROR status reasons:
	//
	//   - applicationLogS3DestinationError : Could not write the application log to
	//   the Amazon S3 bucket that is configured for the streaming application. Make sure
	//   the bucket still exists.
	//
	//   - internalError : An internal service error occurred. Start a new stream
	//   session to continue streaming.
	//
	//   - invalidSignalRequest : The WebRTC signal request that was sent is not valid.
	//   When starting or reconnecting to a stream session, use generateSignalRequest
	//   in the Amazon GameLift Streams Web SDK to generate a new signal request.
	//
	//   - placementTimeout : Amazon GameLift Streams could not find available stream
	//   capacity to start a stream session. Increase the stream capacity in the stream
	//   group or wait until capacity becomes available.
	//
	// TERMINATED status reasons:
	//
	//   - apiTerminated : The stream session was terminated by an API call to [TerminateStreamSession].
	//
	//   - applicationExit : The streaming application exited or crashed. The stream
	//   session was terminated because the application is no longer running.
	//
	//   - connectionTimeout : The stream session was terminated because the client
	//   failed to connect within the connection timeout period specified by
	//   ConnectionTimeoutSeconds .
	//
	//   - idleTimeout : The stream session was terminated because it exceeded the idle
	//   timeout period of 60 minutes with no user input activity.
	//
	//   - maxSessionLengthTimeout : The stream session was terminated because it
	//   exceeded the maximum session length timeout period specified by
	//   SessionLengthSeconds .
	//
	//   - reconnectionTimeout : The stream session was terminated because the client
	//   failed to reconnect within the reconnection timeout period specified by
	//   ConnectionTimeoutSeconds after losing connection.
	//
	// [TerminateStreamSession]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TerminateStreamSession.html
	StatusReason types.StreamSessionStatusReason

	// The unique identifier for the Amazon GameLift Streams stream group that is
	// hosting the stream session. Format example: sg-1AB2C3De4 .
	StreamGroupId *string

	//  An opaque, unique identifier for an end-user, defined by the developer.
	UserId *string

	// The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The
	// URL is used to establish connection with the client.
	WebSdkProtocolUrl *string

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

type HTTPClient

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

type HTTPSignerV4

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

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListApplicationsAPIClient

type ListApplicationsAPIClient interface {
	ListApplications(context.Context, *ListApplicationsInput, ...func(*Options)) (*ListApplicationsOutput, error)
}

ListApplicationsAPIClient is a client that implements the ListApplications operation.

type ListApplicationsInput

type ListApplicationsInput struct {

	// The number of results to return. Use this parameter with NextToken to return
	// results in sequential pages. Default value is 25 .
	MaxResults *int32

	// The token that marks the start of the next set of results. Use this token when
	// you retrieve results as sequential pages. To get the first page of results, omit
	// a token value. To get the remaining pages, provide the token returned with the
	// previous result set.
	NextToken *string
	// contains filtered or unexported fields
}

type ListApplicationsOutput

type ListApplicationsOutput struct {

	// A collection of Amazon GameLift Streams applications that are associated with
	// the Amazon Web Services account in use. Each item includes application metadata
	// and status.
	Items []types.ApplicationSummary

	// A token that marks the start of the next sequential page of results. If an
	// operation doesn't return a token, you've reached the end of the list.
	NextToken *string

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

type ListApplicationsPaginator

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

ListApplicationsPaginator is a paginator for ListApplications

func NewListApplicationsPaginator

func NewListApplicationsPaginator(client ListApplicationsAPIClient, params *ListApplicationsInput, optFns ...func(*ListApplicationsPaginatorOptions)) *ListApplicationsPaginator

NewListApplicationsPaginator returns a new ListApplicationsPaginator

func (*ListApplicationsPaginator) HasMorePages

func (p *ListApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApplicationsPaginator) NextPage

func (p *ListApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationsOutput, error)

NextPage retrieves the next ListApplications page.

type ListApplicationsPaginatorOptions

type ListApplicationsPaginatorOptions struct {
	// The number of results to return. Use this parameter with NextToken to return
	// results in sequential pages. Default value is 25 .
	Limit int32

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

ListApplicationsPaginatorOptions is the paginator options for ListApplications

type ListStreamGroupsAPIClient

type ListStreamGroupsAPIClient interface {
	ListStreamGroups(context.Context, *ListStreamGroupsInput, ...func(*Options)) (*ListStreamGroupsOutput, error)
}

ListStreamGroupsAPIClient is a client that implements the ListStreamGroups operation.

type ListStreamGroupsInput

type ListStreamGroupsInput struct {

	// The number of results to return. Use this parameter with NextToken to return
	// results in sequential pages. Default value is 25 .
	MaxResults *int32

	// A token that marks the start of the next set of results. Use this token when
	// you retrieve results as sequential pages. To get the first page of results, omit
	// a token value. To get the remaining pages, provide the token returned with the
	// previous result set.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStreamGroupsOutput

type ListStreamGroupsOutput struct {

	// A collection of Amazon GameLift Streams stream groups that are associated with
	// the Amazon Web Services account in use. Each item includes stream group metadata
	// and status, but doesn't include capacity information.
	Items []types.StreamGroupSummary

	// A token that marks the start of the next sequential page of results. If an
	// operation doesn't return a token, you've reached the end of the list.
	NextToken *string

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

type ListStreamGroupsPaginator

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

ListStreamGroupsPaginator is a paginator for ListStreamGroups

func NewListStreamGroupsPaginator

func NewListStreamGroupsPaginator(client ListStreamGroupsAPIClient, params *ListStreamGroupsInput, optFns ...func(*ListStreamGroupsPaginatorOptions)) *ListStreamGroupsPaginator

NewListStreamGroupsPaginator returns a new ListStreamGroupsPaginator

func (*ListStreamGroupsPaginator) HasMorePages

func (p *ListStreamGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamGroupsPaginator) NextPage

func (p *ListStreamGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamGroupsOutput, error)

NextPage retrieves the next ListStreamGroups page.

type ListStreamGroupsPaginatorOptions

type ListStreamGroupsPaginatorOptions struct {
	// The number of results to return. Use this parameter with NextToken to return
	// results in sequential pages. Default value is 25 .
	Limit int32

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

ListStreamGroupsPaginatorOptions is the paginator options for ListStreamGroups

type ListStreamSessionsAPIClient

type ListStreamSessionsAPIClient interface {
	ListStreamSessions(context.Context, *ListStreamSessionsInput, ...func(*Options)) (*ListStreamSessionsOutput, error)
}

ListStreamSessionsAPIClient is a client that implements the ListStreamSessions operation.

type ListStreamSessionsByAccountAPIClient

type ListStreamSessionsByAccountAPIClient interface {
	ListStreamSessionsByAccount(context.Context, *ListStreamSessionsByAccountInput, ...func(*Options)) (*ListStreamSessionsByAccountOutput, error)
}

ListStreamSessionsByAccountAPIClient is a client that implements the ListStreamSessionsByAccount operation.

type ListStreamSessionsByAccountInput

type ListStreamSessionsByAccountInput struct {

	// Filter by the exported files status. You can specify one status in each request
	// to retrieve only sessions that currently have that exported files status.
	ExportFilesStatus types.ExportFilesStatus

	// The number of results to return. Use this parameter with NextToken to return
	// results in sequential pages. Default value is 25 .
	MaxResults *int32

	// The token that marks the start of the next set of results. Use this token when
	// you retrieve results as sequential pages. To get the first page of results, omit
	// a token value. To get the remaining pages, provide the token returned with the
	// previous result set.
	NextToken *string

	// Filter by the stream session status. You can specify one status in each request
	// to retrieve only sessions that are currently in that status.
	Status types.StreamSessionStatus
	// contains filtered or unexported fields
}

type ListStreamSessionsByAccountOutput

type ListStreamSessionsByAccountOutput struct {

	// A collection of Amazon GameLift Streams stream sessions that are associated
	// with a stream group and returned in response to a list request. Each item
	// includes stream session metadata and status.
	Items []types.StreamSessionSummary

	// A token that marks the start of the next sequential page of results. If an
	// operation doesn't return a token, you've reached the end of the list.
	NextToken *string

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

type ListStreamSessionsByAccountPaginator

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

ListStreamSessionsByAccountPaginator is a paginator for ListStreamSessionsByAccount

func NewListStreamSessionsByAccountPaginator

NewListStreamSessionsByAccountPaginator returns a new ListStreamSessionsByAccountPaginator

func (*ListStreamSessionsByAccountPaginator) HasMorePages

func (p *ListStreamSessionsByAccountPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamSessionsByAccountPaginator) NextPage

NextPage retrieves the next ListStreamSessionsByAccount page.

type ListStreamSessionsByAccountPaginatorOptions

type ListStreamSessionsByAccountPaginatorOptions struct {
	// The number of results to return. Use this parameter with NextToken to return
	// results in sequential pages. Default value is 25 .
	Limit int32

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

ListStreamSessionsByAccountPaginatorOptions is the paginator options for ListStreamSessionsByAccount

type ListStreamSessionsInput

type ListStreamSessionsInput struct {

	// The unique identifier of a Amazon GameLift Streams stream group to retrieve the
	// stream session for. You can use either the stream group ID or the [Amazon Resource Name (ARN)].
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	// Filter by the exported files status. You can specify one status in each request
	// to retrieve only sessions that currently have that exported files status.
	//
	// Exported files can be in one of the following states:
	//
	//   - SUCCEEDED : The exported files are successfully stored in an S3 bucket.
	//
	//   - FAILED : The session ended but Amazon GameLift Streams couldn't collect and
	//   upload the files to S3.
	//
	//   - PENDING : Either the stream session is still in progress, or uploading the
	//   exported files to the S3 bucket is in progress.
	ExportFilesStatus types.ExportFilesStatus

	// The number of results to return. Use this parameter with NextToken to return
	// results in sequential pages. Default value is 25 .
	MaxResults *int32

	// The token that marks the start of the next set of results. Use this token when
	// you retrieve results as sequential pages. To get the first page of results, omit
	// a token value. To get the remaining pages, provide the token returned with the
	// previous result set.
	NextToken *string

	// Filter by the stream session status. You can specify one status in each request
	// to retrieve only sessions that are currently in that status.
	Status types.StreamSessionStatus
	// contains filtered or unexported fields
}

type ListStreamSessionsOutput

type ListStreamSessionsOutput struct {

	// A collection of Amazon GameLift Streams stream sessions that are associated
	// with a stream group and returned in response to a list request. Each item
	// includes stream session metadata and status.
	Items []types.StreamSessionSummary

	// A token that marks the start of the next sequential page of results. If an
	// operation doesn't return a token, you've reached the end of the list.
	NextToken *string

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

type ListStreamSessionsPaginator

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

ListStreamSessionsPaginator is a paginator for ListStreamSessions

func NewListStreamSessionsPaginator

func NewListStreamSessionsPaginator(client ListStreamSessionsAPIClient, params *ListStreamSessionsInput, optFns ...func(*ListStreamSessionsPaginatorOptions)) *ListStreamSessionsPaginator

NewListStreamSessionsPaginator returns a new ListStreamSessionsPaginator

func (*ListStreamSessionsPaginator) HasMorePages

func (p *ListStreamSessionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamSessionsPaginator) NextPage

func (p *ListStreamSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamSessionsOutput, error)

NextPage retrieves the next ListStreamSessions page.

type ListStreamSessionsPaginatorOptions

type ListStreamSessionsPaginatorOptions struct {
	// The number of results to return. Use this parameter with NextToken to return
	// results in sequential pages. Default value is 25 .
	Limit int32

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

ListStreamSessionsPaginatorOptions is the paginator options for ListStreamSessions

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The [Amazon Resource Name (ARN)] that you want to retrieve tags for. To get an Amazon GameLift Streams
	// resource ARN, call a List or Get operation for the resource.
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// A collection of tags that have been assigned to the specified resource.
	Tags map[string]string

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

type Options

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

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

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

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

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

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

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

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

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

	// The client meter provider.
	MeterProvider metrics.MeterProvider

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

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

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

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

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

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// Client registry of operation interceptors.
	Interceptors smithyhttp.InterceptorRegistry

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme

	// Priority list of preferred auth scheme names (e.g. sigv4a).
	AuthSchemePreference []string
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type RemoveStreamGroupLocationsInput

type RemoveStreamGroupLocationsInput struct {

	//  A stream group to remove the specified locations from.
	//
	// This value is an [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource.
	// Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	//  A set of locations to remove this stream group. For example, us-east-1 .
	//
	// For a complete list of locations that Amazon GameLift Streams supports, refer
	// to [Regions, quotas, and limitations]in the Amazon GameLift Streams Developer Guide.
	//
	// [Regions, quotas, and limitations]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html
	//
	// This member is required.
	Locations []string
	// contains filtered or unexported fields
}

type RemoveStreamGroupLocationsOutput

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type StartStreamSessionInput

type StartStreamSessionInput struct {

	// An [Amazon Resource Name (ARN)] or ID that uniquely identifies the application resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 . Example
	// ID: a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	ApplicationIdentifier *string

	// The stream group to run this stream session with.
	//
	// This value is an [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource.
	// Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	// The data transport protocol to use for the stream session.
	//
	// This member is required.
	Protocol types.Protocol

	// A WebRTC ICE offer string to use when initializing a WebRTC connection.
	// Typically, the offer is a very long JSON string. Provide the string as a text
	// value in quotes.
	//
	// Amazon GameLift Streams also supports setting the field to
	// "NO_CLIENT_CONNECTION". This will create a session without needing any browser
	// request or Web SDK integration. The session starts up as usual and waits for a
	// reconnection from a browser, which is accomplished using [CreateStreamSessionConnection].
	//
	// [CreateStreamSessionConnection]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html
	//
	// This member is required.
	SignalRequest *string

	// A set of options that you can use to control the stream session runtime
	// environment, expressed as a set of key-value pairs. You can use this to
	// configure the application or stream session details. You can also provide custom
	// environment variables that Amazon GameLift Streams passes to your game client.
	//
	// If you want to debug your application with environment variables, we recommend
	// that you do so in a local environment outside of Amazon GameLift Streams. For
	// more information, refer to the Compatibility Guidance in the troubleshooting
	// section of the Developer Guide.
	//
	// AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes.
	// AdditionalEnvironmentVariables passes data using environment variables; while
	// AdditionalLaunchArgs passes data using command-line arguments.
	AdditionalEnvironmentVariables map[string]string

	// A list of CLI arguments that are sent to the streaming server when a stream
	// session launches. You can use this to configure the application or stream
	// session details. You can also provide custom arguments that Amazon GameLift
	// Streams passes to your game client.
	//
	// AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes.
	// AdditionalEnvironmentVariables passes data using environment variables; while
	// AdditionalLaunchArgs passes data using command-line arguments.
	AdditionalLaunchArgs []string

	//  A unique identifier that represents a client request. The request is
	// idempotent, which ensures that an API request completes only once. When users
	// send a request, Amazon GameLift Streams automatically populates this field.
	ClientToken *string

	// Length of time (in seconds) that Amazon GameLift Streams should wait for a
	// client to connect or reconnect to the stream session. Applies to both connection
	// and reconnection scenarios. This time span starts when the stream session
	// reaches ACTIVE state. If no client connects before the timeout, Amazon GameLift
	// Streams terminates the stream session. Default value is 120.
	ConnectionTimeoutSeconds *int32

	// A human-readable label for the stream session. You can update this value later.
	Description *string

	//  A list of locations, in order of priority, where you want Amazon GameLift
	// Streams to start a stream from. For example, us-east-1 . Amazon GameLift Streams
	// selects the location with the next available capacity to start a single stream
	// session in. If this value is empty, Amazon GameLift Streams attempts to start a
	// stream session in the primary location.
	//
	// For a complete list of locations that Amazon GameLift Streams supports, refer
	// to [Regions, quotas, and limitations]in the Amazon GameLift Streams Developer Guide.
	//
	// [Regions, quotas, and limitations]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html
	Locations []string

	// The maximum duration of a session. Amazon GameLift Streams will automatically
	// terminate a session after this amount of time has elapsed, regardless of any
	// existing client connections. Default value is 43200 (12 hours).
	SessionLengthSeconds *int32

	//  An opaque, unique identifier for an end-user, defined by the developer.
	UserId *string
	// contains filtered or unexported fields
}

type StartStreamSessionOutput

type StartStreamSessionOutput struct {

	// A set of options that you can use to control the stream session runtime
	// environment, expressed as a set of key-value pairs. You can use this to
	// configure the application or stream session details. You can also provide custom
	// environment variables that Amazon GameLift Streams passes to your game client.
	//
	// If you want to debug your application with environment variables, we recommend
	// that you do so in a local environment outside of Amazon GameLift Streams. For
	// more information, refer to the Compatibility Guidance in the troubleshooting
	// section of the Developer Guide.
	//
	// AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes.
	// AdditionalEnvironmentVariables passes data using environment variables; while
	// AdditionalLaunchArgs passes data using command-line arguments.
	AdditionalEnvironmentVariables map[string]string

	// A list of CLI arguments that are sent to the streaming server when a stream
	// session launches. You can use this to configure the application or stream
	// session details. You can also provide custom arguments that Amazon GameLift
	// Streams passes to your game client.
	//
	// AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes.
	// AdditionalEnvironmentVariables passes data using environment variables; while
	// AdditionalLaunchArgs passes data using command-line arguments.
	AdditionalLaunchArgs []string

	// The application streaming in this session.
	//
	// This value is an [Amazon Resource Name (ARN)] that uniquely identifies the application resource. Example
	// ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	ApplicationArn *string

	// The [Amazon Resource Name (ARN)] that's assigned to a stream session resource. When combined with the
	// stream group resource ID, this value uniquely identifies the stream session
	// across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS
	// Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session
	// resource ID] .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	Arn *string

	// The length of time that Amazon GameLift Streams should wait for a client to
	// connect or reconnect to the stream session. This time span starts when the
	// stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no
	// client connects (or reconnects) before the timeout, Amazon GameLift Streams
	// terminates the stream session.
	ConnectionTimeoutSeconds *int32

	// A timestamp that indicates when this resource was created. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	CreatedAt *time.Time

	// A human-readable label for the stream session. You can update this value at any
	// time.
	Description *string

	// Provides details about the stream session's exported files.
	ExportFilesMetadata *types.ExportFilesMetadata

	// A timestamp that indicates when this resource was last updated. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	LastUpdatedAt *time.Time

	// The location where Amazon GameLift Streams hosts and streams your application.
	// For example, us-east-1 . For a complete list of locations that Amazon GameLift
	// Streams supports, refer to [Regions, quotas, and limitations]in the Amazon GameLift Streams Developer Guide.
	//
	// [Regions, quotas, and limitations]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html
	Location *string

	// Access location for log files that your content generates during a stream
	// session. These log files are uploaded to cloud storage location at the end of a
	// stream session. The Amazon GameLift Streams application resource defines which
	// log files to upload.
	LogFileLocationUri *string

	// The data transfer protocol in use with the stream session.
	Protocol types.Protocol

	// The maximum duration of a session. Amazon GameLift Streams will automatically
	// terminate a session after this amount of time has elapsed, regardless of any
	// existing client connections.
	SessionLengthSeconds *int32

	// The WebRTC ICE offer string that a client generates to initiate a connection to
	// the stream session.
	SignalRequest *string

	// The WebRTC answer string that the stream server generates in response to the
	// SignalRequest .
	SignalResponse *string

	// The current status of the stream session. A stream session is ready for a
	// client to connect when in ACTIVE status.
	//
	//   - ACTIVATING : The stream session is starting and preparing to stream.
	//
	//   - ACTIVE : The stream session is ready and waiting for a client connection. A
	//   client has ConnectionTimeoutSeconds (specified in StartStreamSession ) from
	//   when the session reaches ACTIVE state to establish a connection. If no client
	//   connects within this timeframe, the session automatically terminates.
	//
	//   - CONNECTED : The stream session has a connected client. A session will
	//   automatically terminate if there is no user input for 60 minutes, or if the
	//   maximum length of a session specified by SessionLengthSeconds in
	//   StartStreamSession is exceeded.
	//
	//   - ERROR : The stream session failed to activate. See StatusReason (returned by
	//   GetStreamSession and StartStreamSession ) for more information.
	//
	//   - PENDING_CLIENT_RECONNECTION : A client has recently disconnected and the
	//   stream session is waiting for the client to reconnect. A client has
	//   ConnectionTimeoutSeconds (specified in StartStreamSession ) from when the
	//   session reaches PENDING_CLIENT_RECONNECTION state to re-establish a
	//   connection. If no client connects within this timeframe, the session
	//   automatically terminates.
	//
	//   - RECONNECTING : A client has initiated a reconnect to a session that was in
	//   PENDING_CLIENT_RECONNECTION state.
	//
	//   - TERMINATING : The stream session is ending.
	//
	//   - TERMINATED : The stream session has ended.
	Status types.StreamSessionStatus

	// A short description of the reason the stream session is in ERROR status or
	// TERMINATED status.
	//
	// ERROR status reasons:
	//
	//   - applicationLogS3DestinationError : Could not write the application log to
	//   the Amazon S3 bucket that is configured for the streaming application. Make sure
	//   the bucket still exists.
	//
	//   - internalError : An internal service error occurred. Start a new stream
	//   session to continue streaming.
	//
	//   - invalidSignalRequest : The WebRTC signal request that was sent is not valid.
	//   When starting or reconnecting to a stream session, use generateSignalRequest
	//   in the Amazon GameLift Streams Web SDK to generate a new signal request.
	//
	//   - placementTimeout : Amazon GameLift Streams could not find available stream
	//   capacity to start a stream session. Increase the stream capacity in the stream
	//   group or wait until capacity becomes available.
	//
	// TERMINATED status reasons:
	//
	//   - apiTerminated : The stream session was terminated by an API call to [TerminateStreamSession].
	//
	//   - applicationExit : The streaming application exited or crashed. The stream
	//   session was terminated because the application is no longer running.
	//
	//   - connectionTimeout : The stream session was terminated because the client
	//   failed to connect within the connection timeout period specified by
	//   ConnectionTimeoutSeconds .
	//
	//   - idleTimeout : The stream session was terminated because it exceeded the idle
	//   timeout period of 60 minutes with no user input activity.
	//
	//   - maxSessionLengthTimeout : The stream session was terminated because it
	//   exceeded the maximum session length timeout period specified by
	//   SessionLengthSeconds .
	//
	//   - reconnectionTimeout : The stream session was terminated because the client
	//   failed to reconnect within the reconnection timeout period specified by
	//   ConnectionTimeoutSeconds after losing connection.
	//
	// [TerminateStreamSession]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TerminateStreamSession.html
	StatusReason types.StreamSessionStatusReason

	// The unique identifier for the Amazon GameLift Streams stream group that is
	// hosting the stream session. Format example: sg-1AB2C3De4 .
	StreamGroupId *string

	//  An opaque, unique identifier for an end-user, defined by the developer.
	UserId *string

	// The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The
	// URL is used to establish connection with the client.
	WebSdkProtocolUrl *string

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

type StreamGroupActiveWaiter

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

StreamGroupActiveWaiter defines the waiters for StreamGroupActive

func NewStreamGroupActiveWaiter

func NewStreamGroupActiveWaiter(client GetStreamGroupAPIClient, optFns ...func(*StreamGroupActiveWaiterOptions)) *StreamGroupActiveWaiter

NewStreamGroupActiveWaiter constructs a StreamGroupActiveWaiter.

func (*StreamGroupActiveWaiter) Wait

Wait calls the waiter function for StreamGroupActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StreamGroupActiveWaiter) WaitForOutput

func (w *StreamGroupActiveWaiter) WaitForOutput(ctx context.Context, params *GetStreamGroupInput, maxWaitDur time.Duration, optFns ...func(*StreamGroupActiveWaiterOptions)) (*GetStreamGroupOutput, error)

WaitForOutput calls the waiter function for StreamGroupActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StreamGroupActiveWaiterOptions

type StreamGroupActiveWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StreamGroupActiveWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StreamGroupActiveWaiter will use default max delay of 3600 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStreamGroupInput, *GetStreamGroupOutput, error) (bool, error)
}

StreamGroupActiveWaiterOptions are waiter options for StreamGroupActiveWaiter

type StreamGroupDeletedWaiter

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

StreamGroupDeletedWaiter defines the waiters for StreamGroupDeleted

func NewStreamGroupDeletedWaiter

func NewStreamGroupDeletedWaiter(client GetStreamGroupAPIClient, optFns ...func(*StreamGroupDeletedWaiterOptions)) *StreamGroupDeletedWaiter

NewStreamGroupDeletedWaiter constructs a StreamGroupDeletedWaiter.

func (*StreamGroupDeletedWaiter) Wait

Wait calls the waiter function for StreamGroupDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StreamGroupDeletedWaiter) WaitForOutput

WaitForOutput calls the waiter function for StreamGroupDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StreamGroupDeletedWaiterOptions

type StreamGroupDeletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StreamGroupDeletedWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StreamGroupDeletedWaiter will use default max delay of 1800
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStreamGroupInput, *GetStreamGroupOutput, error) (bool, error)
}

StreamGroupDeletedWaiterOptions are waiter options for StreamGroupDeletedWaiter

type StreamSessionActiveWaiter

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

StreamSessionActiveWaiter defines the waiters for StreamSessionActive

func NewStreamSessionActiveWaiter

func NewStreamSessionActiveWaiter(client GetStreamSessionAPIClient, optFns ...func(*StreamSessionActiveWaiterOptions)) *StreamSessionActiveWaiter

NewStreamSessionActiveWaiter constructs a StreamSessionActiveWaiter.

func (*StreamSessionActiveWaiter) Wait

Wait calls the waiter function for StreamSessionActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StreamSessionActiveWaiter) WaitForOutput

WaitForOutput calls the waiter function for StreamSessionActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StreamSessionActiveWaiterOptions

type StreamSessionActiveWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StreamSessionActiveWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StreamSessionActiveWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStreamSessionInput, *GetStreamSessionOutput, error) (bool, error)
}

StreamSessionActiveWaiterOptions are waiter options for StreamSessionActiveWaiter

type TagResourceInput

type TagResourceInput struct {

	// The [Amazon Resource Name (ARN)] of the Amazon GameLift Streams resource that you want to apply tags to.
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	ResourceArn *string

	// A list of tags, in the form of key-value pairs, to assign to the specified
	// Amazon GameLift Streams resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput

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

type TerminateStreamSessionInput

type TerminateStreamSessionInput struct {

	// [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// The stream group that runs this stream session.
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	// [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream session resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567
	// . Example ID: ABC123def4567 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	StreamSessionIdentifier *string
	// contains filtered or unexported fields
}

type TerminateStreamSessionOutput

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

type UntagResourceInput

type UntagResourceInput struct {

	// The [Amazon Resource Name (ARN)] of the Amazon GameLift Streams resource that you want to remove tags from.
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	ResourceArn *string

	// A list of tag keys to remove from the specified Amazon GameLift Streams
	// resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

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

type UpdateApplicationInput

type UpdateApplicationInput struct {

	// An [Amazon Resource Name (ARN)] or ID that uniquely identifies the application resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 . Example
	// ID: a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	// An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to
	// save application logs. Required if you specify one or more ApplicationLogPaths .
	//
	// The log bucket must have permissions that give Amazon GameLift Streams access
	// to write the log files. For more information, see [Application log bucket permission policy]in the Amazon GameLift
	// Streams Developer Guide.
	//
	// [Application log bucket permission policy]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template
	ApplicationLogOutputUri *string

	// Locations of log files that your content generates during a stream session.
	// Enter path values that are relative to the ApplicationSourceUri location. You
	// can specify up to 10 log paths. Amazon GameLift Streams uploads designated log
	// files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at
	// the end of a stream session. To retrieve stored log files, call [GetStreamSession]and get the
	// LogFileLocationUri .
	//
	// [GetStreamSession]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html
	ApplicationLogPaths []string

	// A human-readable label for the application.
	Description *string
	// contains filtered or unexported fields
}

type UpdateApplicationOutput

type UpdateApplicationOutput struct {

	// The [Amazon Resource Name (ARN)] that's assigned to an application resource and uniquely identifies it
	// across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS
	// Region]:[AWS account]:application/[resource ID] .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Arn *string

	// An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to
	// save application logs. Required if you specify one or more ApplicationLogPaths .
	ApplicationLogOutputUri *string

	// Locations of log files that your content generates during a stream session.
	// Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you
	// specify in ApplicationLogOutputUri at the end of a stream session. To retrieve
	// stored log files, call [GetStreamSession]and get the LogFileLocationUri .
	//
	// [GetStreamSession]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html
	ApplicationLogPaths []string

	// The original Amazon S3 location of uploaded stream content for the application.
	ApplicationSourceUri *string

	//  A set of stream groups that this application is associated with. You can use
	// any of these stream groups to stream your application.
	//
	// This value is a set of [Amazon Resource Names (ARNs)] that uniquely identify stream group resources. Example
	// ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	AssociatedStreamGroups []string

	// A timestamp that indicates when this resource was created. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	CreatedAt *time.Time

	// A human-readable label for the application. You can edit this value.
	Description *string

	// The relative path and file name of the executable file that launches the
	// content for streaming.
	ExecutablePath *string

	// A unique ID value that is assigned to the resource when it's created. Format
	// example: a-9ZY8X7Wv6 .
	Id *string

	// A timestamp that indicates when this resource was last updated. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	LastUpdatedAt *time.Time

	// A set of replication statuses for each location.
	ReplicationStatuses []types.ReplicationStatus

	//  Configuration settings that identify the operating system for an application
	// resource. This can also include a compatibility layer and other drivers.
	//
	// A runtime environment can be one of the following:
	//
	//   - For Linux applications
	//
	//   - Ubuntu 22.04 LTS ( Type=UBUNTU, Version=22_04_LTS )
	//
	//   - For Windows applications
	//
	//   - Microsoft Windows Server 2022 Base ( Type=WINDOWS, Version=2022 )
	//
	//   - Proton 9.0-2 ( Type=PROTON, Version=20250516 )
	//
	//   - Proton 8.0-5 ( Type=PROTON, Version=20241007 )
	//
	//   - Proton 8.0-2c ( Type=PROTON, Version=20230704 )
	RuntimeEnvironment *types.RuntimeEnvironment

	// The current status of the application resource. Possible statuses include the
	// following:
	//
	//   - INITIALIZED : Amazon GameLift Streams has received the request and is
	//   initiating the work flow to create an application.
	//
	//   - PROCESSING : The create application work flow is in process. Amazon GameLift
	//   Streams is copying the content and caching for future deployment in a stream
	//   group.
	//
	//   - READY : The application is ready to deploy in a stream group.
	//
	//   - ERROR : An error occurred when setting up the application. See StatusReason
	//   for more information.
	//
	//   - DELETING : Amazon GameLift Streams is in the process of deleting the
	//   application.
	Status types.ApplicationStatus

	// A short description of the status reason when the application is in ERROR
	// status.
	StatusReason types.ApplicationStatusReason

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

type UpdateStreamGroupInput

type UpdateStreamGroupInput struct {

	// An [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource. Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .
	// Example ID: sg-1AB2C3De4 .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Identifier *string

	// The unique identifier of the Amazon GameLift Streams application that you want
	// to set as the default application in a stream group. The application that you
	// specify must be in READY status. The default application is pre-cached on
	// always-on compute resources, reducing stream startup times. Other applications
	// are automatically cached as needed.
	//
	// Note that this parameter only sets the default application in a stream group.
	// To associate a new application to an existing stream group, you must use [AssociateApplications].
	//
	// When you switch default applications in a stream group, it can take up to a few
	// hours for the new default application to be pre-cached.
	//
	// This value is an [Amazon Resource Name (ARN)] or ID that uniquely identifies the application resource.
	// Example ARN:
	// arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 . Example
	// ID: a-9ZY8X7Wv6 .
	//
	// [AssociateApplications]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	DefaultApplicationIdentifier *string

	// A descriptive label for the stream group.
	Description *string

	//  A set of one or more locations and the streaming capacity for each location.
	LocationConfigurations []types.LocationConfiguration
	// contains filtered or unexported fields
}

type UpdateStreamGroupOutput

type UpdateStreamGroupOutput struct {

	// The [Amazon Resource Name (ARN)] that is assigned to the stream group resource and that uniquely identifies
	// the group across all Amazon Web Services Regions. Format is
	// arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID] .
	//
	// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	//
	// This member is required.
	Arn *string

	//  A set of applications that this stream group is associated with. You can
	// stream any of these applications with the stream group.
	//
	// This value is a set of [Amazon Resource Names (ARNs)] that uniquely identify application resources. Example
	// ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
	AssociatedApplications []string

	// A timestamp that indicates when this resource was created. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	CreatedAt *time.Time

	// The default Amazon GameLift Streams application that is associated with this
	// stream group.
	DefaultApplication *types.DefaultApplication

	// A descriptive label for the stream group.
	Description *string

	// The time at which this stream group expires. Timestamps are expressed using in
	// ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you
	// will no longer be able to update this stream group or use it to start stream
	// sessions. Only Get and Delete operations will work on an expired stream group.
	ExpiresAt *time.Time

	// A unique ID value that is assigned to the resource when it's created. Format
	// example: sg-1AB2C3De4 .
	Id *string

	// A timestamp that indicates when this resource was last updated. Timestamps are
	// expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
	LastUpdatedAt *time.Time

	// This value is set of locations, including their name, current status, and
	// capacities.
	//
	// A location can be in one of the following states:
	//
	//   - ACTIVATING : Amazon GameLift Streams is preparing the location. You cannot
	//   stream from, scale the capacity of, or remove this location yet.
	//
	//   - ACTIVE : The location is provisioned with initial capacity. You can now
	//   stream from, scale the capacity of, or remove this location.
	//
	//   - ERROR : Amazon GameLift Streams failed to set up this location. The
	//   StatusReason field describes the error. You can remove this location and try
	//   to add it again.
	//
	//   - REMOVING : Amazon GameLift Streams is working to remove this location. This
	//   will release all provisioned capacity for this location in this stream group.
	LocationStates []types.LocationState

	// The current status of the stream group resource. Possible statuses include the
	// following:
	//
	//   - ACTIVATING : The stream group is deploying and isn't ready to host streams.
	//
	//   - ACTIVE : The stream group is ready to host streams.
	//
	//   - ACTIVE_WITH_ERRORS : One or more locations in the stream group are in an
	//   error state. Verify the details of individual locations and remove any locations
	//   which are in error.
	//
	//   - DELETING : Amazon GameLift Streams is in the process of deleting the stream
	//   group.
	//
	//   - ERROR : An error occurred when the stream group deployed. See StatusReason
	//   (returned by CreateStreamGroup , GetStreamGroup , and UpdateStreamGroup ) for
	//   more information.
	//
	//   - EXPIRED : The stream group is expired and can no longer host streams. This
	//   typically occurs when a stream group is 365 days old, as indicated by the value
	//   of ExpiresAt . Create a new stream group to resume streaming capabilities.
	//
	//   - UPDATING_LOCATIONS : One or more locations in the stream group are in the
	//   process of updating (either activating or deleting).
	Status types.StreamGroupStatus

	//  A short description of the reason that the stream group is in ERROR status.
	// The possible reasons can be one of the following:
	//
	//   - internalError : The request can't process right now because of an issue with
	//   the server. Try again later.
	//
	//   - noAvailableInstances : Amazon GameLift Streams does not currently have
	//   enough available on-demand capacity to fulfill your request. Wait a few minutes
	//   and retry the request as capacity can shift frequently. You can also try to make
	//   the request using a different stream class or in another region.
	StatusReason types.StreamGroupStatusReason

	// The target stream quality for the stream group.
	//
	// A stream class can be one of the following:
	//
	//   - gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Runs applications on Microsoft Windows Server 2022 Base and
	//   supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32
	//   and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D
	//   scene complexity. Uses NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
	//
	//   - Tenancy: Supports up to 2 concurrent stream sessions
	//
	//   - gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D
	//   scene complexity. Runs applications on Microsoft Windows Server 2022 Base and
	//   supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32
	//   and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	//
	//   - gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D
	//   scene complexity. Uses NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
	//
	//   - Tenancy: Supports up to 2 concurrent stream sessions
	//
	//   - gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene
	//   complexity. Uses dedicated NVIDIA T4 Tensor GPU.
	//
	//   - Reference resolution: 1080p
	//
	//   - Reference frame rate: 60 fps
	//
	//   - Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
	//
	//   - Tenancy: Supports 1 concurrent stream session
	StreamClass types.StreamClass

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

Directories

Path Synopsis
internal