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

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.

Usage example
client = boto3.client("mobile")

try:
    do_something(client)
except (
    client.AccountActionRequiredException,
    client.BadRequestException,
    client.ClientError,
    client.InternalFailureException,
    client.LimitExceededException,
    client.NotFoundException,
    client.ServiceUnavailableException,
    client.TooManyRequestsException,
    client.UnauthorizedException,
) as e:
    print(e)
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

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

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

Method definition
def create_project(
    self,
    *,
    name: str = ...,
    region: str = ...,
    contents: Union[str, bytes, IO[Any], StreamingBody] = ...,
    snapshotId: str = ...,
) -> CreateProjectResultTypeDef:  # (1)
    ...
  1. See CreateProjectResultTypeDef
Usage example with kwargs
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

Method definition
def delete_project(
    self,
    *,
    projectId: str,
) -> DeleteProjectResultTypeDef:  # (1)
    ...
  1. See DeleteProjectResultTypeDef
Usage example with kwargs
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

Method definition
def describe_bundle(
    self,
    *,
    bundleId: str,
) -> DescribeBundleResultTypeDef:  # (1)
    ...
  1. See DescribeBundleResultTypeDef
Usage example with kwargs
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

Method definition
def describe_project(
    self,
    *,
    projectId: str,
    syncFromResources: bool = ...,
) -> DescribeProjectResultTypeDef:  # (1)
    ...
  1. See DescribeProjectResultTypeDef
Usage example with kwargs
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

Method definition
def export_bundle(
    self,
    *,
    bundleId: str,
    projectId: str = ...,
    platform: PlatformType = ...,  # (1)
) -> ExportBundleResultTypeDef:  # (2)
    ...
  1. See PlatformType
  2. See ExportBundleResultTypeDef
Usage example with kwargs
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

Method definition
def export_project(
    self,
    *,
    projectId: str,
) -> ExportProjectResultTypeDef:  # (1)
    ...
  1. See ExportProjectResultTypeDef
Usage example with kwargs
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

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

Method definition
def list_bundles(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBundlesResultTypeDef:  # (1)
    ...
  1. See ListBundlesResultTypeDef
Usage example with kwargs
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

Method definition
def list_projects(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListProjectsResultTypeDef:  # (1)
    ...
  1. See ListProjectsResultTypeDef
Usage example with kwargs
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

Method definition
def update_project(
    self,
    *,
    projectId: str,
    contents: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> UpdateProjectResultTypeDef:  # (1)
    ...
  1. See UpdateProjectResultTypeDef
Usage example with kwargs
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.