GameLiftStreamsClient#
Index > GameLiftStreams > GameLiftStreamsClient
Auto-generated documentation for GameLiftStreams type annotations stubs module mypy-boto3-gameliftstreams.
GameLiftStreamsClient#
Type annotations and code completion for boto3.client("gameliftstreams")
.
boto3 documentation
# GameLiftStreamsClient usage example
from boto3.session import Session
from mypy_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 mypy_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)
...
- See
Sequence[LocationConfigurationTypeDef]
- See AddStreamGroupLocationsOutputTypeDef
# add_stream_group_locations method usage example with argument unpacking
kwargs: AddStreamGroupLocationsInputTypeDef = { # (1)
"Identifier": ...,
"LocationConfigurations": ...,
}
parent.add_stream_group_locations(**kwargs)
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,
*,
ApplicationIdentifiers: Sequence[str],
Identifier: str,
) -> AssociateApplicationsOutputTypeDef: # (1)
...
# associate_applications method usage example with argument unpacking
kwargs: AssociateApplicationsInputTypeDef = { # (1)
"ApplicationIdentifiers": ...,
"Identifier": ...,
}
parent.associate_applications(**kwargs)
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,
*,
ApplicationSourceUri: str,
Description: str,
ExecutablePath: str,
RuntimeEnvironment: RuntimeEnvironmentTypeDef, # (1)
ApplicationLogOutputUri: str = ...,
ApplicationLogPaths: Sequence[str] = ...,
ClientToken: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateApplicationOutputTypeDef: # (2)
...
# create_application method usage example with argument unpacking
kwargs: CreateApplicationInputTypeDef = { # (1)
"ApplicationSourceUri": ...,
"Description": ...,
"ExecutablePath": ...,
"RuntimeEnvironment": ...,
}
parent.create_application(**kwargs)
create_stream_group#
Manage how Amazon GameLift Streams streams your applications by using a stream group.
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)
ClientToken: str = ...,
DefaultApplicationIdentifier: str = ...,
LocationConfigurations: Sequence[LocationConfigurationTypeDef] = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateStreamGroupOutputTypeDef: # (3)
...
- See StreamClassType
- See
Sequence[LocationConfigurationTypeDef]
- See CreateStreamGroupOutputTypeDef
# create_stream_group method usage example with argument unpacking
kwargs: CreateStreamGroupInputTypeDef = { # (1)
"Description": ...,
"StreamClass": ...,
}
parent.create_stream_group(**kwargs)
create_stream_session_connection#
Allows clients to reconnect to a recently disconnected stream session without losing any data from the last 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,
SignalRequest: str,
StreamSessionIdentifier: str,
ClientToken: str = ...,
) -> CreateStreamSessionConnectionOutputTypeDef: # (1)
...
# create_stream_session_connection method usage example with argument unpacking
kwargs: CreateStreamSessionConnectionInputTypeDef = { # (1)
"Identifier": ...,
"SignalRequest": ...,
"StreamSessionIdentifier": ...,
}
parent.create_stream_session_connection(**kwargs)
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)
...
# delete_application method usage example with argument unpacking
kwargs: DeleteApplicationInputTypeDef = { # (1)
"Identifier": ...,
}
parent.delete_application(**kwargs)
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)
...
# delete_stream_group method usage example with argument unpacking
kwargs: DeleteStreamGroupInputTypeDef = { # (1)
"Identifier": ...,
}
parent.delete_stream_group(**kwargs)
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,
*,
ApplicationIdentifiers: Sequence[str],
Identifier: str,
) -> DisassociateApplicationsOutputTypeDef: # (1)
...
# disassociate_applications method usage example with argument unpacking
kwargs: DisassociateApplicationsInputTypeDef = { # (1)
"ApplicationIdentifiers": ...,
"Identifier": ...,
}
parent.disassociate_applications(**kwargs)
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,
OutputUri: str,
StreamSessionIdentifier: str,
) -> Dict[str, Any]:
...
# export_stream_session_files method usage example with argument unpacking
kwargs: ExportStreamSessionFilesInputTypeDef = { # (1)
"Identifier": ...,
"OutputUri": ...,
"StreamSessionIdentifier": ...,
}
parent.export_stream_session_files(**kwargs)
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)
...
# get_application method usage example with argument unpacking
kwargs: GetApplicationInputTypeDef = { # (1)
"Identifier": ...,
}
parent.get_application(**kwargs)
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)
...
# get_stream_group method usage example with argument unpacking
kwargs: GetStreamGroupInputTypeDef = { # (1)
"Identifier": ...,
}
parent.get_stream_group(**kwargs)
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)
...
# get_stream_session method usage example with argument unpacking
kwargs: GetStreamSessionInputTypeDef = { # (1)
"Identifier": ...,
"StreamSessionIdentifier": ...,
}
parent.get_stream_session(**kwargs)
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,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListApplicationsOutputTypeDef: # (1)
...
# list_applications method usage example with argument unpacking
kwargs: ListApplicationsInputTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_applications(**kwargs)
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,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListStreamGroupsOutputTypeDef: # (1)
...
# list_stream_groups method usage example with argument unpacking
kwargs: ListStreamGroupsInputTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_stream_groups(**kwargs)
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,
ExportFilesStatus: ExportFilesStatusType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
Status: StreamSessionStatusType = ..., # (2)
) -> ListStreamSessionsOutputTypeDef: # (3)
...
# list_stream_sessions method usage example with argument unpacking
kwargs: ListStreamSessionsInputTypeDef = { # (1)
"Identifier": ...,
}
parent.list_stream_sessions(**kwargs)
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,
*,
ExportFilesStatus: ExportFilesStatusType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
Status: StreamSessionStatusType = ..., # (2)
) -> ListStreamSessionsByAccountOutputTypeDef: # (3)
...
# list_stream_sessions_by_account method usage example with argument unpacking
kwargs: ListStreamSessionsByAccountInputTypeDef = { # (1)
"ExportFilesStatus": ...,
}
parent.list_stream_sessions_by_account(**kwargs)
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)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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)
...
# remove_stream_group_locations method usage example with argument unpacking
kwargs: RemoveStreamGroupLocationsInputTypeDef = { # (1)
"Identifier": ...,
"Locations": ...,
}
parent.remove_stream_group_locations(**kwargs)
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,
*,
ApplicationIdentifier: str,
Identifier: str,
Protocol: ProtocolType, # (1)
SignalRequest: str,
AdditionalEnvironmentVariables: Mapping[str, str] = ...,
AdditionalLaunchArgs: Sequence[str] = ...,
ClientToken: str = ...,
ConnectionTimeoutSeconds: int = ...,
Description: str = ...,
Locations: Sequence[str] = ...,
SessionLengthSeconds: int = ...,
UserId: str = ...,
) -> StartStreamSessionOutputTypeDef: # (2)
...
# start_stream_session method usage example with argument unpacking
kwargs: StartStreamSessionInputTypeDef = { # (1)
"ApplicationIdentifier": ...,
"Identifier": ...,
"Protocol": ...,
"SignalRequest": ...,
}
parent.start_stream_session(**kwargs)
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)
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)
...
# terminate_stream_session method usage example with argument unpacking
kwargs: TerminateStreamSessionInputTypeDef = { # (1)
"Identifier": ...,
"StreamSessionIdentifier": ...,
}
parent.terminate_stream_session(**kwargs)
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)
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,
ApplicationLogOutputUri: str = ...,
ApplicationLogPaths: Sequence[str] = ...,
Description: str = ...,
) -> UpdateApplicationOutputTypeDef: # (1)
...
# update_application method usage example with argument unpacking
kwargs: UpdateApplicationInputTypeDef = { # (1)
"Identifier": ...,
}
parent.update_application(**kwargs)
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,
Description: str = ...,
LocationConfigurations: Sequence[LocationConfigurationTypeDef] = ..., # (1)
) -> UpdateStreamGroupOutputTypeDef: # (2)
...
- See
Sequence[LocationConfigurationTypeDef]
- See UpdateStreamGroupOutputTypeDef
# update_stream_group method usage example with argument unpacking
kwargs: UpdateStreamGroupInputTypeDef = { # (1)
"Identifier": ...,
}
parent.update_stream_group(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("gameliftstreams").get_paginator
method with overloads.
client.get_paginator("list_applications")
-> ListApplicationsPaginatorclient.get_paginator("list_stream_groups")
-> ListStreamGroupsPaginatorclient.get_paginator("list_stream_sessions_by_account")
-> ListStreamSessionsByAccountPaginatorclient.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")
-> ApplicationDeletedWaiterclient.get_waiter("application_ready")
-> ApplicationReadyWaiterclient.get_waiter("stream_group_active")
-> StreamGroupActiveWaiterclient.get_waiter("stream_group_deleted")
-> StreamGroupDeletedWaiterclient.get_waiter("stream_session_active")
-> StreamSessionActiveWaiter