Type annotations for boto3.GameLift 1.14.9 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-gamelift
Type annotations for boto3.GameLift 1.14.9 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for GameLift
service.
python -m pip install boto3-stubs[gamelift]
How to use
Client annotations
GameLiftClient
provides annotations for boto3.client("gamelift")
.
import boto3
from mypy_boto3_gamelift import GameLiftClient
from mypy_boto3_gamelift.paginator import (
DescribeFleetAttributesPaginator,
DescribeFleetCapacityPaginator,
DescribeFleetEventsPaginator,
DescribeFleetUtilizationPaginator,
DescribeGameSessionDetailsPaginator,
DescribeGameSessionQueuesPaginator,
DescribeGameSessionsPaginator,
DescribeInstancesPaginator,
DescribeMatchmakingConfigurationsPaginator,
DescribeMatchmakingRuleSetsPaginator,
DescribePlayerSessionsPaginator,
DescribeScalingPoliciesPaginator,
ListAliasesPaginator,
ListBuildsPaginator,
ListFleetsPaginator,
SearchGameSessionsPaginator,
)
from mypy_boto3_gamelift.type_defs import AliasTypeDef, ...
client: GameLiftClient = boto3.client("gamelift")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: GameLiftClient = session.client("gamelift")
Paginators annotations
mypy_boto3_gamelift.paginator
module contains type annotations for all paginators.
client: GameLiftClient = boto3.client("gamelift")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_fleet_attributes_paginator: DescribeFleetAttributesPaginator = client.get_paginator("describe_fleet_attributes")
describe_fleet_capacity_paginator: DescribeFleetCapacityPaginator = client.get_paginator("describe_fleet_capacity")
describe_fleet_events_paginator: DescribeFleetEventsPaginator = client.get_paginator("describe_fleet_events")
describe_fleet_utilization_paginator: DescribeFleetUtilizationPaginator = client.get_paginator("describe_fleet_utilization")
describe_game_session_details_paginator: DescribeGameSessionDetailsPaginator = client.get_paginator("describe_game_session_details")
describe_game_session_queues_paginator: DescribeGameSessionQueuesPaginator = client.get_paginator("describe_game_session_queues")
describe_game_sessions_paginator: DescribeGameSessionsPaginator = client.get_paginator("describe_game_sessions")
describe_instances_paginator: DescribeInstancesPaginator = client.get_paginator("describe_instances")
describe_matchmaking_configurations_paginator: DescribeMatchmakingConfigurationsPaginator = client.get_paginator("describe_matchmaking_configurations")
describe_matchmaking_rule_sets_paginator: DescribeMatchmakingRuleSetsPaginator = client.get_paginator("describe_matchmaking_rule_sets")
describe_player_sessions_paginator: DescribePlayerSessionsPaginator = client.get_paginator("describe_player_sessions")
describe_scaling_policies_paginator: DescribeScalingPoliciesPaginator = client.get_paginator("describe_scaling_policies")
list_aliases_paginator: ListAliasesPaginator = client.get_paginator("list_aliases")
list_builds_paginator: ListBuildsPaginator = client.get_paginator("list_builds")
list_fleets_paginator: ListFleetsPaginator = client.get_paginator("list_fleets")
search_game_sessions_paginator: SearchGameSessionsPaginator = client.get_paginator("search_game_sessions")
Typed dictionations
mypy_boto3_gamelift.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AliasTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_gamelift
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("gamelift")
session_client = boto3.Session().client("gamelift")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-gamelift-1.14.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c776747b140318075b493af0c0e3bd00dcadf1052b7d577c16ed6ce18050d91d |
|
MD5 | 155717568dd28b87e9141af2e2e553f2 |
|
BLAKE2b-256 | f71ac794104eb5c5dbd3b7634ef6ec1f3800a728ef1671634985d4d2d34214ee |
Hashes for mypy_boto3_gamelift-1.14.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b3dbfd8379ecdab842fdcdbd5d58ddebe0f55f20e9b40e20a907b03fb998b28 |
|
MD5 | 11c2bb8e06455008438093252aa3cf5d |
|
BLAKE2b-256 | 12be0be00a5b2978470a8f76cf1be01c46bd0f1bd3ca6be5192e942fd29787f6 |