Skip to content

MobileClient#

Index > Mobile > MobileClient

Auto-generated documentation for Mobile type annotations stubs module mypy-boto3-mobile.

MobileClient#

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

# MobileClient usage example

from boto3.session import Session
from mypy_boto3_mobile.client import MobileClient

def get_mobile_client() -> MobileClient:
    return Session().client("mobile")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("mobile")

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)
# Exceptions.exceptions type checking example

from mypy_boto3_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 boto3.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 boto3.client("mobile").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_project#

Creates an AWS Mobile Hub project.

Type annotations and code completion for boto3.client("mobile").create_project method. boto3 documentation

# create_project method definition

def create_project(
    self,
    *,
    name: str = ...,
    region: str = ...,
    contents: Union[str, bytes, IO[Any], StreamingBody] = ...,
    snapshotId: str = ...,
) -> CreateProjectResultTypeDef:  # (1)
    ...
  1. See CreateProjectResultTypeDef
# create_project method usage example with argument unpacking

kwargs: CreateProjectRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_project(**kwargs)
  1. See CreateProjectRequestRequestTypeDef

delete_project#

Delets a project in AWS Mobile Hub.

Type annotations and code completion for boto3.client("mobile").delete_project method. boto3 documentation

# delete_project method definition

def delete_project(
    self,
    *,
    projectId: str,
) -> DeleteProjectResultTypeDef:  # (1)
    ...
  1. See DeleteProjectResultTypeDef
# delete_project method usage example with argument unpacking

kwargs: DeleteProjectRequestRequestTypeDef = {  # (1)
    "projectId": ...,
}

parent.delete_project(**kwargs)
  1. See DeleteProjectRequestRequestTypeDef

describe_bundle#

Get the bundle details for the requested bundle id.

Type annotations and code completion for boto3.client("mobile").describe_bundle method. boto3 documentation

# describe_bundle method definition

def describe_bundle(
    self,
    *,
    bundleId: str,
) -> DescribeBundleResultTypeDef:  # (1)
    ...
  1. See DescribeBundleResultTypeDef
# describe_bundle method usage example with argument unpacking

kwargs: DescribeBundleRequestRequestTypeDef = {  # (1)
    "bundleId": ...,
}

parent.describe_bundle(**kwargs)
  1. See DescribeBundleRequestRequestTypeDef

describe_project#

Gets details about a project in AWS Mobile Hub.

Type annotations and code completion for boto3.client("mobile").describe_project method. boto3 documentation

# describe_project method definition

def describe_project(
    self,
    *,
    projectId: str,
    syncFromResources: bool = ...,
) -> DescribeProjectResultTypeDef:  # (1)
    ...
  1. See DescribeProjectResultTypeDef
# describe_project method usage example with argument unpacking

kwargs: DescribeProjectRequestRequestTypeDef = {  # (1)
    "projectId": ...,
}

parent.describe_project(**kwargs)
  1. See DescribeProjectRequestRequestTypeDef

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 boto3.client("mobile").export_bundle method. boto3 documentation

# export_bundle method definition

def export_bundle(
    self,
    *,
    bundleId: str,
    projectId: str = ...,
    platform: PlatformType = ...,  # (1)
) -> ExportBundleResultTypeDef:  # (2)
    ...
  1. See PlatformType
  2. See ExportBundleResultTypeDef
# export_bundle method usage example with argument unpacking

kwargs: ExportBundleRequestRequestTypeDef = {  # (1)
    "bundleId": ...,
}

parent.export_bundle(**kwargs)
  1. See ExportBundleRequestRequestTypeDef

export_project#

Exports project configuration to a snapshot which can be downloaded and shared.

Type annotations and code completion for boto3.client("mobile").export_project method. boto3 documentation

# export_project method definition

def export_project(
    self,
    *,
    projectId: str,
) -> ExportProjectResultTypeDef:  # (1)
    ...
  1. See ExportProjectResultTypeDef
# export_project method usage example with argument unpacking

kwargs: ExportProjectRequestRequestTypeDef = {  # (1)
    "projectId": ...,
}

parent.export_project(**kwargs)
  1. See ExportProjectRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("mobile").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:
    ...

list_bundles#

List all available bundles.

Type annotations and code completion for boto3.client("mobile").list_bundles method. boto3 documentation

# list_bundles method definition

def list_bundles(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBundlesResultTypeDef:  # (1)
    ...
  1. See ListBundlesResultTypeDef
# list_bundles method usage example with argument unpacking

kwargs: ListBundlesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_bundles(**kwargs)
  1. See ListBundlesRequestRequestTypeDef

list_projects#

Lists projects in AWS Mobile Hub.

Type annotations and code completion for boto3.client("mobile").list_projects method. boto3 documentation

# list_projects method definition

def list_projects(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListProjectsResultTypeDef:  # (1)
    ...
  1. See ListProjectsResultTypeDef
# list_projects method usage example with argument unpacking

kwargs: ListProjectsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_projects(**kwargs)
  1. See ListProjectsRequestRequestTypeDef

update_project#

Update an existing project.

Type annotations and code completion for boto3.client("mobile").update_project method. boto3 documentation

# update_project method definition

def update_project(
    self,
    *,
    projectId: str,
    contents: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> UpdateProjectResultTypeDef:  # (1)
    ...
  1. See UpdateProjectResultTypeDef
# update_project method usage example with argument unpacking

kwargs: UpdateProjectRequestRequestTypeDef = {  # (1)
    "projectId": ...,
}

parent.update_project(**kwargs)
  1. See UpdateProjectRequestRequestTypeDef

get_paginator#

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