GameLiftStreamsClient

Index > GameLiftStreams > GameLiftStreamsClient

Auto-generated documentation for GameLiftStreams type annotations stubs module types-boto3-gameliftstreams.

GameLiftStreamsClient

Type annotations and code completion for boto3.client("gameliftstreams"). boto3 documentation

# GameLiftStreamsClient usage example

from boto3.session import Session
from types_boto3_gameliftstreams.client import GameLiftStreamsClient

def get_gameliftstreams_client() -> GameLiftStreamsClient:
    return Session().client("gameliftstreams")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("gameliftstreams").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("gameliftstreams")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_gameliftstreams.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("gameliftstreams").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("gameliftstreams").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

add_stream_group_locations

Add locations that can host stream sessions.

Type annotations and code completion for boto3.client("gameliftstreams").add_stream_group_locations method. boto3 documentation

# add_stream_group_locations method definition

def add_stream_group_locations(
    self,
    *,
    Identifier: str,
    LocationConfigurations: Sequence[LocationConfigurationTypeDef],  # (1)
) -> AddStreamGroupLocationsOutputTypeDef:  # (2)
    ...

1. See Sequence[LocationConfigurationTypeDef]
2. See AddStreamGroupLocationsOutputTypeDef

# add_stream_group_locations method usage example with argument unpacking

kwargs: AddStreamGroupLocationsInputTypeDef = {  # (1)
    "Identifier": ...,
    "LocationConfigurations": ...,
}

parent.add_stream_group_locations(**kwargs)

1. See AddStreamGroupLocationsInputTypeDef

associate_applications

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.

Type annotations and code completion for boto3.client("gameliftstreams").associate_applications method. boto3 documentation

# associate_applications method definition

def associate_applications(
    self,
    *,
    Identifier: str,
    ApplicationIdentifiers: Sequence[str],
) -> AssociateApplicationsOutputTypeDef:  # (1)
    ...

1. See AssociateApplicationsOutputTypeDef

# associate_applications method usage example with argument unpacking

kwargs: AssociateApplicationsInputTypeDef = {  # (1)
    "Identifier": ...,
    "ApplicationIdentifiers": ...,
}

parent.associate_applications(**kwargs)

1. See AssociateApplicationsInputTypeDef

create_application

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.

Type annotations and code completion for boto3.client("gameliftstreams").create_application method. boto3 documentation

# create_application method definition

def create_application(
    self,
    *,
    Description: str,
    RuntimeEnvironment: RuntimeEnvironmentTypeDef,  # (1)
    ExecutablePath: str,
    ApplicationSourceUri: str,
    ApplicationLogPaths: Sequence[str] = ...,
    ApplicationLogOutputUri: str = ...,
    Tags: Mapping[str, str] = ...,
    ClientToken: str = ...,
) -> CreateApplicationOutputTypeDef:  # (2)
    ...

1. See RuntimeEnvironmentTypeDef
2. See CreateApplicationOutputTypeDef

# create_application method usage example with argument unpacking

kwargs: CreateApplicationInputTypeDef = {  # (1)
    "Description": ...,
    "RuntimeEnvironment": ...,
    "ExecutablePath": ...,
    "ApplicationSourceUri": ...,
}

parent.create_application(**kwargs)

1. See CreateApplicationInputTypeDef

create_stream_group

Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs.

Type annotations and code completion for boto3.client("gameliftstreams").create_stream_group method. boto3 documentation

# create_stream_group method definition

def create_stream_group(
    self,
    *,
    Description: str,
    StreamClass: StreamClassType,  # (1)
    DefaultApplicationIdentifier: str = ...,
    LocationConfigurations: Sequence[LocationConfigurationTypeDef] = ...,  # (2)
    Tags: Mapping[str, str] = ...,
    ClientToken: str = ...,
) -> CreateStreamGroupOutputTypeDef:  # (3)
    ...

1. See StreamClassType
2. See Sequence[LocationConfigurationTypeDef]
3. See CreateStreamGroupOutputTypeDef

# create_stream_group method usage example with argument unpacking

kwargs: CreateStreamGroupInputTypeDef = {  # (1)
    "Description": ...,
    "StreamClass": ...,
}

parent.create_stream_group(**kwargs)

1. See CreateStreamGroupInputTypeDef

create_stream_session_connection

Enables clients to reconnect to a stream session while preserving all session state and data in the disconnected session.

Type annotations and code completion for boto3.client("gameliftstreams").create_stream_session_connection method. boto3 documentation

# create_stream_session_connection method definition

def create_stream_session_connection(
    self,
    *,
    Identifier: str,
    StreamSessionIdentifier: str,
    SignalRequest: str,
    ClientToken: str = ...,
) -> CreateStreamSessionConnectionOutputTypeDef:  # (1)
    ...

1. See CreateStreamSessionConnectionOutputTypeDef

# create_stream_session_connection method usage example with argument unpacking

kwargs: CreateStreamSessionConnectionInputTypeDef = {  # (1)
    "Identifier": ...,
    "StreamSessionIdentifier": ...,
    "SignalRequest": ...,
}

parent.create_stream_session_connection(**kwargs)

1. See CreateStreamSessionConnectionInputTypeDef

delete_application

Permanently deletes an Amazon GameLift Streams application resource.

Type annotations and code completion for boto3.client("gameliftstreams").delete_application method. boto3 documentation

# delete_application method definition

def delete_application(
    self,
    *,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationInputTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_application(**kwargs)

1. See DeleteApplicationInputTypeDef

delete_stream_group

Permanently deletes all compute resources and information related to a stream group.

Type annotations and code completion for boto3.client("gameliftstreams").delete_stream_group method. boto3 documentation

# delete_stream_group method definition

def delete_stream_group(
    self,
    *,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_stream_group method usage example with argument unpacking

kwargs: DeleteStreamGroupInputTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_stream_group(**kwargs)

1. See DeleteStreamGroupInputTypeDef

disassociate_applications

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.

Type annotations and code completion for boto3.client("gameliftstreams").disassociate_applications method. boto3 documentation

# disassociate_applications method definition

def disassociate_applications(
    self,
    *,
    Identifier: str,
    ApplicationIdentifiers: Sequence[str],
) -> DisassociateApplicationsOutputTypeDef:  # (1)
    ...

1. See DisassociateApplicationsOutputTypeDef

# disassociate_applications method usage example with argument unpacking

kwargs: DisassociateApplicationsInputTypeDef = {  # (1)
    "Identifier": ...,
    "ApplicationIdentifiers": ...,
}

parent.disassociate_applications(**kwargs)

1. See DisassociateApplicationsInputTypeDef

export_stream_session_files

Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application.

Type annotations and code completion for boto3.client("gameliftstreams").export_stream_session_files method. boto3 documentation

# export_stream_session_files method definition

def export_stream_session_files(
    self,
    *,
    Identifier: str,
    StreamSessionIdentifier: str,
    OutputUri: str,
) -> Dict[str, Any]:
    ...

# export_stream_session_files method usage example with argument unpacking

kwargs: ExportStreamSessionFilesInputTypeDef = {  # (1)
    "Identifier": ...,
    "StreamSessionIdentifier": ...,
    "OutputUri": ...,
}

parent.export_stream_session_files(**kwargs)

1. See ExportStreamSessionFilesInputTypeDef

get_application

Retrieves properties for an Amazon GameLift Streams application resource.

Type annotations and code completion for boto3.client("gameliftstreams").get_application method. boto3 documentation

# get_application method definition

def get_application(
    self,
    *,
    Identifier: str,
) -> GetApplicationOutputTypeDef:  # (1)
    ...

1. See GetApplicationOutputTypeDef

# get_application method usage example with argument unpacking

kwargs: GetApplicationInputTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_application(**kwargs)

1. See GetApplicationInputTypeDef

get_stream_group

Retrieves properties for a Amazon GameLift Streams stream group resource.

Type annotations and code completion for boto3.client("gameliftstreams").get_stream_group method. boto3 documentation

# get_stream_group method definition

def get_stream_group(
    self,
    *,
    Identifier: str,
) -> GetStreamGroupOutputTypeDef:  # (1)
    ...

1. See GetStreamGroupOutputTypeDef

# get_stream_group method usage example with argument unpacking

kwargs: GetStreamGroupInputTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_stream_group(**kwargs)

1. See GetStreamGroupInputTypeDef

get_stream_session

Retrieves properties for a Amazon GameLift Streams stream session resource.

Type annotations and code completion for boto3.client("gameliftstreams").get_stream_session method. boto3 documentation

# get_stream_session method definition

def get_stream_session(
    self,
    *,
    Identifier: str,
    StreamSessionIdentifier: str,
) -> GetStreamSessionOutputTypeDef:  # (1)
    ...

1. See GetStreamSessionOutputTypeDef

# get_stream_session method usage example with argument unpacking

kwargs: GetStreamSessionInputTypeDef = {  # (1)
    "Identifier": ...,
    "StreamSessionIdentifier": ...,
}

parent.get_stream_session(**kwargs)

1. See GetStreamSessionInputTypeDef

list_applications

Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use.

Type annotations and code completion for boto3.client("gameliftstreams").list_applications method. boto3 documentation

# list_applications method definition

def list_applications(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListApplicationsOutputTypeDef:  # (1)
    ...

1. See ListApplicationsOutputTypeDef

# list_applications method usage example with argument unpacking

kwargs: ListApplicationsInputTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_applications(**kwargs)

1. See ListApplicationsInputTypeDef

list_stream_groups

Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use.

Type annotations and code completion for boto3.client("gameliftstreams").list_stream_groups method. boto3 documentation

# list_stream_groups method definition

def list_stream_groups(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStreamGroupsOutputTypeDef:  # (1)
    ...

1. See ListStreamGroupsOutputTypeDef

# list_stream_groups method usage example with argument unpacking

kwargs: ListStreamGroupsInputTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_stream_groups(**kwargs)

1. See ListStreamGroupsInputTypeDef

list_stream_sessions

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

Type annotations and code completion for boto3.client("gameliftstreams").list_stream_sessions method. boto3 documentation

# list_stream_sessions method definition

def list_stream_sessions(
    self,
    *,
    Identifier: str,
    Status: StreamSessionStatusType = ...,  # (1)
    ExportFilesStatus: ExportFilesStatusType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStreamSessionsOutputTypeDef:  # (3)
    ...

1. See StreamSessionStatusType
2. See ExportFilesStatusType
3. See ListStreamSessionsOutputTypeDef

# list_stream_sessions method usage example with argument unpacking

kwargs: ListStreamSessionsInputTypeDef = {  # (1)
    "Identifier": ...,
}

parent.list_stream_sessions(**kwargs)

1. See ListStreamSessionsInputTypeDef

list_stream_sessions_by_account

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

Type annotations and code completion for boto3.client("gameliftstreams").list_stream_sessions_by_account method. boto3 documentation

# list_stream_sessions_by_account method definition

def list_stream_sessions_by_account(
    self,
    *,
    Status: StreamSessionStatusType = ...,  # (1)
    ExportFilesStatus: ExportFilesStatusType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStreamSessionsByAccountOutputTypeDef:  # (3)
    ...

1. See StreamSessionStatusType
2. See ExportFilesStatusType
3. See ListStreamSessionsByAccountOutputTypeDef

# list_stream_sessions_by_account method usage example with argument unpacking

kwargs: ListStreamSessionsByAccountInputTypeDef = {  # (1)
    "Status": ...,
}

parent.list_stream_sessions_by_account(**kwargs)

1. See ListStreamSessionsByAccountInputTypeDef

list_tags_for_resource

Retrieves all tags assigned to a Amazon GameLift Streams resource.

Type annotations and code completion for boto3.client("gameliftstreams").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

remove_stream_group_locations

Removes a set of remote locations from this stream group.

Type annotations and code completion for boto3.client("gameliftstreams").remove_stream_group_locations method. boto3 documentation

# remove_stream_group_locations method definition

def remove_stream_group_locations(
    self,
    *,
    Identifier: str,
    Locations: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# remove_stream_group_locations method usage example with argument unpacking

kwargs: RemoveStreamGroupLocationsInputTypeDef = {  # (1)
    "Identifier": ...,
    "Locations": ...,
}

parent.remove_stream_group_locations(**kwargs)

1. See RemoveStreamGroupLocationsInputTypeDef

start_stream_session

This action initiates a new stream session and outputs connection information that clients can use to access the stream.

Type annotations and code completion for boto3.client("gameliftstreams").start_stream_session method. boto3 documentation

# start_stream_session method definition

def start_stream_session(
    self,
    *,
    Identifier: str,
    Protocol: ProtocolType,  # (1)
    SignalRequest: str,
    ApplicationIdentifier: str,
    ClientToken: str = ...,
    Description: str = ...,
    UserId: str = ...,
    Locations: Sequence[str] = ...,
    ConnectionTimeoutSeconds: int = ...,
    SessionLengthSeconds: int = ...,
    AdditionalLaunchArgs: Sequence[str] = ...,
    AdditionalEnvironmentVariables: Mapping[str, str] = ...,
) -> StartStreamSessionOutputTypeDef:  # (2)
    ...

1. See ProtocolType
2. See StartStreamSessionOutputTypeDef

# start_stream_session method usage example with argument unpacking

kwargs: StartStreamSessionInputTypeDef = {  # (1)
    "Identifier": ...,
    "Protocol": ...,
    "SignalRequest": ...,
    "ApplicationIdentifier": ...,
}

parent.start_stream_session(**kwargs)

1. See StartStreamSessionInputTypeDef

tag_resource

Assigns one or more tags to a Amazon GameLift Streams resource.

Type annotations and code completion for boto3.client("gameliftstreams").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

terminate_stream_session

Permanently terminates an active stream session.

Type annotations and code completion for boto3.client("gameliftstreams").terminate_stream_session method. boto3 documentation

# terminate_stream_session method definition

def terminate_stream_session(
    self,
    *,
    Identifier: str,
    StreamSessionIdentifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# terminate_stream_session method usage example with argument unpacking

kwargs: TerminateStreamSessionInputTypeDef = {  # (1)
    "Identifier": ...,
    "StreamSessionIdentifier": ...,
}

parent.terminate_stream_session(**kwargs)

1. See TerminateStreamSessionInputTypeDef

untag_resource

Removes one or more tags from a Amazon GameLift Streams resource.

Type annotations and code completion for boto3.client("gameliftstreams").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_application

Updates the mutable configuration settings for a Amazon GameLift Streams application resource.

Type annotations and code completion for boto3.client("gameliftstreams").update_application method. boto3 documentation

# update_application method definition

def update_application(
    self,
    *,
    Identifier: str,
    Description: str = ...,
    ApplicationLogPaths: Sequence[str] = ...,
    ApplicationLogOutputUri: str = ...,
) -> UpdateApplicationOutputTypeDef:  # (1)
    ...

1. See UpdateApplicationOutputTypeDef

# update_application method usage example with argument unpacking

kwargs: UpdateApplicationInputTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_application(**kwargs)

1. See UpdateApplicationInputTypeDef

update_stream_group

Updates the configuration settings for an Amazon GameLift Streams stream group resource.

Type annotations and code completion for boto3.client("gameliftstreams").update_stream_group method. boto3 documentation

# update_stream_group method definition

def update_stream_group(
    self,
    *,
    Identifier: str,
    LocationConfigurations: Sequence[LocationConfigurationTypeDef] = ...,  # (1)
    Description: str = ...,
    DefaultApplicationIdentifier: str = ...,
) -> UpdateStreamGroupOutputTypeDef:  # (2)
    ...

1. See Sequence[LocationConfigurationTypeDef]
2. See UpdateStreamGroupOutputTypeDef

# update_stream_group method usage example with argument unpacking

kwargs: UpdateStreamGroupInputTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_stream_group(**kwargs)

1. See UpdateStreamGroupInputTypeDef

get_paginator

Type annotations and code completion for boto3.client("gameliftstreams").get_paginator method with overloads.

• client.get_paginator("list_applications") -> ListApplicationsPaginator
• client.get_paginator("list_stream_groups") -> ListStreamGroupsPaginator
• client.get_paginator("list_stream_sessions_by_account") -> ListStreamSessionsByAccountPaginator
• client.get_paginator("list_stream_sessions") -> ListStreamSessionsPaginator

get_waiter

Type annotations and code completion for boto3.client("gameliftstreams").get_waiter method with overloads.

• client.get_waiter("application_deleted") -> ApplicationDeletedWaiter
• client.get_waiter("application_ready") -> ApplicationReadyWaiter
• client.get_waiter("stream_group_active") -> StreamGroupActiveWaiter
• client.get_waiter("stream_group_deleted") -> StreamGroupDeletedWaiter
• client.get_waiter("stream_session_active") -> StreamSessionActiveWaiter