MobileClient#
Auto-generated documentation for Mobile type annotations stubs module types-aiobotocore-mobile.
MobileClient#
Type annotations and code completion for session.client("mobile")
boto3 documentation
# MobileClient usage example
from aioboto3.session import Session
from types_aiobotocore_mobile.client import MobileClient
session = Session()
async with session.client("mobile") as client:
client: MobileClient
Exceptions#
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("mobile").exceptions
structure.
# MobileClient.exceptions usage example
async with session.client("mobile") as client:
try:
do_something(client)
except (
client.exceptions.AccountActionRequiredException,
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.InternalFailureException,
client.exceptions.LimitExceededException,
client.exceptions.NotFoundException,
client.exceptions.ServiceUnavailableException,
client.exceptions.TooManyRequestsException,
client.exceptions.UnauthorizedException,
) as e:
print(e)
# MobileClient.exceptions type checking example
from types_aiobotocore_mobile.client import Exceptions
def handle_error(exc: Exceptions.AccountActionRequiredException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.client("mobile").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.client("mobile").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_project#
Creates an AWS Mobile Hub project.
Type annotations and code completion for session.client("mobile").create_project
method.
boto3 documentation
# create_project method definition
await def create_project(
self,
*,
name: str = ...,
region: str = ...,
contents: Union[str, bytes, IO[Any], StreamingBody] = ...,
snapshotId: str = ...,
) -> CreateProjectResultTypeDef: # (1)
...
# create_project method usage example with argument unpacking
kwargs: CreateProjectRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_project(**kwargs)
delete_project#
Delets a project in AWS Mobile Hub.
Type annotations and code completion for session.client("mobile").delete_project
method.
boto3 documentation
# delete_project method definition
await def delete_project(
self,
*,
projectId: str,
) -> DeleteProjectResultTypeDef: # (1)
...
# delete_project method usage example with argument unpacking
kwargs: DeleteProjectRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.delete_project(**kwargs)
describe_bundle#
Get the bundle details for the requested bundle id.
Type annotations and code completion for session.client("mobile").describe_bundle
method.
boto3 documentation
# describe_bundle method definition
await def describe_bundle(
self,
*,
bundleId: str,
) -> DescribeBundleResultTypeDef: # (1)
...
# describe_bundle method usage example with argument unpacking
kwargs: DescribeBundleRequestRequestTypeDef = { # (1)
"bundleId": ...,
}
parent.describe_bundle(**kwargs)
describe_project#
Gets details about a project in AWS Mobile Hub.
Type annotations and code completion for session.client("mobile").describe_project
method.
boto3 documentation
# describe_project method definition
await def describe_project(
self,
*,
projectId: str,
syncFromResources: bool = ...,
) -> DescribeProjectResultTypeDef: # (1)
...
# describe_project method usage example with argument unpacking
kwargs: DescribeProjectRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.describe_project(**kwargs)
export_bundle#
Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.
Type annotations and code completion for session.client("mobile").export_bundle
method.
boto3 documentation
# export_bundle method definition
await def export_bundle(
self,
*,
bundleId: str,
projectId: str = ...,
platform: PlatformType = ..., # (1)
) -> ExportBundleResultTypeDef: # (2)
...
# export_bundle method usage example with argument unpacking
kwargs: ExportBundleRequestRequestTypeDef = { # (1)
"bundleId": ...,
}
parent.export_bundle(**kwargs)
export_project#
Exports project configuration to a snapshot which can be downloaded and shared.
Type annotations and code completion for session.client("mobile").export_project
method.
boto3 documentation
# export_project method definition
await def export_project(
self,
*,
projectId: str,
) -> ExportProjectResultTypeDef: # (1)
...
# export_project method usage example with argument unpacking
kwargs: ExportProjectRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.export_project(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("mobile").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_bundles#
List all available bundles.
Type annotations and code completion for session.client("mobile").list_bundles
method.
boto3 documentation
# list_bundles method definition
await def list_bundles(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListBundlesResultTypeDef: # (1)
...
# list_bundles method usage example with argument unpacking
kwargs: ListBundlesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_bundles(**kwargs)
list_projects#
Lists projects in AWS Mobile Hub.
Type annotations and code completion for session.client("mobile").list_projects
method.
boto3 documentation
# list_projects method definition
await def list_projects(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListProjectsResultTypeDef: # (1)
...
# list_projects method usage example with argument unpacking
kwargs: ListProjectsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_projects(**kwargs)
update_project#
Update an existing project.
Type annotations and code completion for session.client("mobile").update_project
method.
boto3 documentation
# update_project method definition
await def update_project(
self,
*,
projectId: str,
contents: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> UpdateProjectResultTypeDef: # (1)
...
# update_project method usage example with argument unpacking
kwargs: UpdateProjectRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.update_project(**kwargs)
__aenter__#
Type annotations and code completion for session.client("mobile").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> MobileClient:
...
__aexit__#
Type annotations and code completion for session.client("mobile").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.client("mobile").get_paginator
method with overloads.
client.get_paginator("list_bundles")
-> ListBundlesPaginatorclient.get_paginator("list_projects")
-> ListProjectsPaginator