Table of Contents
Mobile.Client¶A low-level client representing AWS Mobile
AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources.
client = session.create_client('mobile')
These are the available methods:
can_paginate()close()create_project()delete_project()describe_bundle()describe_project()export_bundle()export_project()get_paginator()get_waiter()list_bundles()list_projects()update_project()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_project(**kwargs)¶Creates an AWS Mobile Hub project.
See also: AWS API Documentation
Request Syntax
response = client.create_project(
name='string',
region='string',
contents=b'bytes'|file,
snapshotId='string'
)
dict
Response Syntax
{
'details': {
'name': 'string',
'projectId': 'string',
'region': 'string',
'state': 'NORMAL'|'SYNCING'|'IMPORTING',
'createdDate': datetime(2015, 1, 1),
'lastUpdatedDate': datetime(2015, 1, 1),
'consoleUrl': 'string',
'resources': [
{
'type': 'string',
'name': 'string',
'arn': 'string',
'feature': 'string',
'attributes': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
Result structure used in response to a request to create a project.
details (dict) --
Detailed information about the created AWS Mobile Hub project.
name (string) --
Name of the project.
projectId (string) --
Unique project identifier.
region (string) --
Default region to use for AWS resource creation in the AWS Mobile Hub project.
state (string) --
Synchronization state for a project.
createdDate (datetime) --
Date the project was created.
lastUpdatedDate (datetime) --
Date of the last modification of the project.
consoleUrl (string) --
Website URL for this project in the AWS Mobile Hub console.
resources (list) --
List of AWS resources associated with a project.
(dict) --
Information about an instance of an AWS resource associated with a project.
type (string) --
Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).
name (string) --
Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).
arn (string) --
AWS resource name which uniquely identifies the resource in AWS systems.
feature (string) --
Identifies which feature in AWS Mobile Hub is associated with this AWS resource.
attributes (dict) --
Key-value attribute pairs.
(string) --
Key part of key-value attribute pairs.
(string) --
Value part of key-value attribute pairs.
Exceptions
Mobile.Client.exceptions.InternalFailureExceptionMobile.Client.exceptions.ServiceUnavailableExceptionMobile.Client.exceptions.UnauthorizedExceptionMobile.Client.exceptions.TooManyRequestsExceptionMobile.Client.exceptions.BadRequestExceptionMobile.Client.exceptions.NotFoundExceptionMobile.Client.exceptions.LimitExceededExceptiondelete_project(**kwargs)¶Delets a project in AWS Mobile Hub.
See also: AWS API Documentation
Request Syntax
response = client.delete_project(
projectId='string'
)
[REQUIRED]
Unique project identifier.
{
'deletedResources': [
{
'type': 'string',
'name': 'string',
'arn': 'string',
'feature': 'string',
'attributes': {
'string': 'string'
}
},
],
'orphanedResources': [
{
'type': 'string',
'name': 'string',
'arn': 'string',
'feature': 'string',
'attributes': {
'string': 'string'
}
},
]
}
Response Structure
Result structure used in response to request to delete a project.
Resources which were deleted.
Information about an instance of an AWS resource associated with a project.
Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).
Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).
AWS resource name which uniquely identifies the resource in AWS systems.
Identifies which feature in AWS Mobile Hub is associated with this AWS resource.
Key-value attribute pairs.
Key part of key-value attribute pairs.
Value part of key-value attribute pairs.
Resources which were not deleted, due to a risk of losing potentially important data or files.
Information about an instance of an AWS resource associated with a project.
Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).
Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).
AWS resource name which uniquely identifies the resource in AWS systems.
Identifies which feature in AWS Mobile Hub is associated with this AWS resource.
Key-value attribute pairs.
Key part of key-value attribute pairs.
Value part of key-value attribute pairs.
Exceptions
describe_bundle(**kwargs)¶Get the bundle details for the requested bundle id.
See also: AWS API Documentation
Request Syntax
response = client.describe_bundle(
bundleId='string'
)
[REQUIRED]
Unique bundle identifier.
{
'details': {
'bundleId': 'string',
'title': 'string',
'version': 'string',
'description': 'string',
'iconUrl': 'string',
'availablePlatforms': [
'OSX'|'WINDOWS'|'LINUX'|'OBJC'|'SWIFT'|'ANDROID'|'JAVASCRIPT',
]
}
}
Response Structure
Result structure contains the details of the bundle.
The details of the bundle.
Unique bundle identifier.
Title of the download bundle.
Version of the download bundle.
Description of the download bundle.
Icon for the download bundle.
Developer desktop or mobile app or website platforms.
Developer desktop or target mobile app or website platform.
Exceptions
describe_project(**kwargs)¶Gets details about a project in AWS Mobile Hub.
See also: AWS API Documentation
Request Syntax
response = client.describe_project(
projectId='string',
syncFromResources=True|False
)
[REQUIRED]
Unique project identifier.
dict
Response Syntax
{
'details': {
'name': 'string',
'projectId': 'string',
'region': 'string',
'state': 'NORMAL'|'SYNCING'|'IMPORTING',
'createdDate': datetime(2015, 1, 1),
'lastUpdatedDate': datetime(2015, 1, 1),
'consoleUrl': 'string',
'resources': [
{
'type': 'string',
'name': 'string',
'arn': 'string',
'feature': 'string',
'attributes': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
Result structure used for requests of project details.
details (dict) --
Detailed information about an AWS Mobile Hub project.
name (string) --
Name of the project.
projectId (string) --
Unique project identifier.
region (string) --
Default region to use for AWS resource creation in the AWS Mobile Hub project.
state (string) --
Synchronization state for a project.
createdDate (datetime) --
Date the project was created.
lastUpdatedDate (datetime) --
Date of the last modification of the project.
consoleUrl (string) --
Website URL for this project in the AWS Mobile Hub console.
resources (list) --
List of AWS resources associated with a project.
(dict) --
Information about an instance of an AWS resource associated with a project.
type (string) --
Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).
name (string) --
Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).
arn (string) --
AWS resource name which uniquely identifies the resource in AWS systems.
feature (string) --
Identifies which feature in AWS Mobile Hub is associated with this AWS resource.
attributes (dict) --
Key-value attribute pairs.
(string) --
Key part of key-value attribute pairs.
(string) --
Value part of key-value attribute pairs.
Exceptions
export_bundle(**kwargs)¶Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.
See also: AWS API Documentation
Request Syntax
response = client.export_bundle(
bundleId='string',
projectId='string',
platform='OSX'|'WINDOWS'|'LINUX'|'OBJC'|'SWIFT'|'ANDROID'|'JAVASCRIPT'
)
[REQUIRED]
Unique bundle identifier.
dict
Response Syntax
{
'downloadUrl': 'string'
}
Response Structure
(dict) --
Result structure which contains link to download custom-generated SDK and tool packages used to integrate mobile web or app clients with backed AWS resources.
downloadUrl (string) --
URL which contains the custom-generated SDK and tool packages used to integrate the client mobile app or web app with the AWS resources created by the AWS Mobile Hub project.
Exceptions
export_project(**kwargs)¶Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account.
See also: AWS API Documentation
Request Syntax
response = client.export_project(
projectId='string'
)
[REQUIRED]
Unique project identifier.
{
'downloadUrl': 'string',
'shareUrl': 'string',
'snapshotId': 'string'
}
Response Structure
Result structure used for requests to export project configuration details.
URL which can be used to download the exported project configuation file(s).
URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again.
Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL.
Exceptions
get_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_bundles(**kwargs)¶List all available bundles.
See also: AWS API Documentation
Request Syntax
response = client.list_bundles(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'bundleList': [
{
'bundleId': 'string',
'title': 'string',
'version': 'string',
'description': 'string',
'iconUrl': 'string',
'availablePlatforms': [
'OSX'|'WINDOWS'|'LINUX'|'OBJC'|'SWIFT'|'ANDROID'|'JAVASCRIPT',
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Result structure contains a list of all available bundles with details.
bundleList (list) --
A list of bundles.
(dict) --
The details of the bundle.
bundleId (string) --
Unique bundle identifier.
title (string) --
Title of the download bundle.
version (string) --
Version of the download bundle.
description (string) --
Description of the download bundle.
iconUrl (string) --
Icon for the download bundle.
availablePlatforms (list) --
Developer desktop or mobile app or website platforms.
(string) --
Developer desktop or target mobile app or website platform.
nextToken (string) --
Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
Exceptions
list_projects(**kwargs)¶Lists projects in AWS Mobile Hub.
See also: AWS API Documentation
Request Syntax
response = client.list_projects(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'projects': [
{
'name': 'string',
'projectId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Result structure used for requests to list projects in AWS Mobile Hub.
projects (list) --
List of projects.
(dict) --
Summary information about an AWS Mobile Hub project.
name (string) --
Name of the project.
projectId (string) --
Unique project identifier.
nextToken (string) --
Pagination token. Set to null to start listing records from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more entries.
Exceptions
update_project(**kwargs)¶Update an existing project.
See also: AWS API Documentation
Request Syntax
response = client.update_project(
contents=b'bytes'|file,
projectId='string'
)
[REQUIRED]
Unique project identifier.
dict
Response Syntax
{
'details': {
'name': 'string',
'projectId': 'string',
'region': 'string',
'state': 'NORMAL'|'SYNCING'|'IMPORTING',
'createdDate': datetime(2015, 1, 1),
'lastUpdatedDate': datetime(2015, 1, 1),
'consoleUrl': 'string',
'resources': [
{
'type': 'string',
'name': 'string',
'arn': 'string',
'feature': 'string',
'attributes': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
Result structure used for requests to updated project configuration.
details (dict) --
Detailed information about the updated AWS Mobile Hub project.
name (string) --
Name of the project.
projectId (string) --
Unique project identifier.
region (string) --
Default region to use for AWS resource creation in the AWS Mobile Hub project.
state (string) --
Synchronization state for a project.
createdDate (datetime) --
Date the project was created.
lastUpdatedDate (datetime) --
Date of the last modification of the project.
consoleUrl (string) --
Website URL for this project in the AWS Mobile Hub console.
resources (list) --
List of AWS resources associated with a project.
(dict) --
Information about an instance of an AWS resource associated with a project.
type (string) --
Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).
name (string) --
Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).
arn (string) --
AWS resource name which uniquely identifies the resource in AWS systems.
feature (string) --
Identifies which feature in AWS Mobile Hub is associated with this AWS resource.
attributes (dict) --
Key-value attribute pairs.
(string) --
Key part of key-value attribute pairs.
(string) --
Value part of key-value attribute pairs.
Exceptions
Mobile.Client.exceptions.InternalFailureExceptionMobile.Client.exceptions.ServiceUnavailableExceptionMobile.Client.exceptions.UnauthorizedExceptionMobile.Client.exceptions.TooManyRequestsExceptionMobile.Client.exceptions.BadRequestExceptionMobile.Client.exceptions.NotFoundExceptionMobile.Client.exceptions.AccountActionRequiredExceptionMobile.Client.exceptions.LimitExceededExceptionClient exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Mobile.Client.exceptions.AccountActionRequiredExceptionMobile.Client.exceptions.BadRequestExceptionMobile.Client.exceptions.InternalFailureExceptionMobile.Client.exceptions.LimitExceededExceptionMobile.Client.exceptions.NotFoundExceptionMobile.Client.exceptions.ServiceUnavailableExceptionMobile.Client.exceptions.TooManyRequestsExceptionMobile.Client.exceptions.UnauthorizedExceptionMobile.Client.exceptions.AccountActionRequiredException¶Account Action is required in order to continue the request.
Example
try:
...
except client.exceptions.AccountActionRequiredException as e:
print(e.response)
response¶The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Account Action is required in order to continue the request.
message (string) --
The Exception Error Message.
Error (dict) -- Normalized access to common exception attributes.
Mobile.Client.exceptions.BadRequestException¶The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.
Example
try:
...
except client.exceptions.BadRequestException as e:
print(e.response)
response¶The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.
message (string) --
The Exception Error Message.
Error (dict) -- Normalized access to common exception attributes.
Mobile.Client.exceptions.InternalFailureException¶The service has encountered an unexpected error condition which prevents it from servicing the request.
Example
try:
...
except client.exceptions.InternalFailureException as e:
print(e.response)
response¶The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The service has encountered an unexpected error condition which prevents it from servicing the request.
message (string) --
The Exception Error Message.
Error (dict) -- Normalized access to common exception attributes.
Mobile.Client.exceptions.LimitExceededException¶There are too many AWS Mobile Hub projects in the account or the account has exceeded the maximum number of resources in some AWS service. You should create another sub-account using AWS Organizations or remove some resources and retry your request.
Example
try:
...
except client.exceptions.LimitExceededException as e:
print(e.response)
response¶The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'retryAfterSeconds': 'string',
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
There are too many AWS Mobile Hub projects in the account or the account has exceeded the maximum number of resources in some AWS service. You should create another sub-account using AWS Organizations or remove some resources and retry your request.
retryAfterSeconds (string) --
The Exception Error Message.
message (string) --
The Exception Error Message.
Error (dict) -- Normalized access to common exception attributes.
Mobile.Client.exceptions.NotFoundException¶No entity can be found with the specified identifier.
Example
try:
...
except client.exceptions.NotFoundException as e:
print(e.response)
response¶The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
No entity can be found with the specified identifier.
message (string) --
The Exception Error Message.
Error (dict) -- Normalized access to common exception attributes.
The service is temporarily unavailable. The request should be retried after some time delay.
Example
try:
...
except client.exceptions.ServiceUnavailableException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'retryAfterSeconds': 'string',
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The service is temporarily unavailable. The request should be retried after some time delay.
retryAfterSeconds (string) --
The Exception Error Message.
message (string) --
The Exception Error Message.
Error (dict) -- Normalized access to common exception attributes.
Mobile.Client.exceptions.TooManyRequestsException¶Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.
Example
try:
...
except client.exceptions.TooManyRequestsException as e:
print(e.response)
response¶The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'retryAfterSeconds': 'string',
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.
retryAfterSeconds (string) --
The Exception Error Message.
message (string) --
The Exception Error Message.
Error (dict) -- Normalized access to common exception attributes.
Credentials of the caller are insufficient to authorize the request.
Example
try:
...
except client.exceptions.UnauthorizedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Credentials of the caller are insufficient to authorize the request.
message (string) --
The Exception Error Message.
Error (dict) -- Normalized access to common exception attributes.
The available paginators are:
Mobile.Paginator.ListBundles¶paginator = client.get_paginator('list_bundles')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Mobile.Client.list_bundles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'bundleList': [
{
'bundleId': 'string',
'title': 'string',
'version': 'string',
'description': 'string',
'iconUrl': 'string',
'availablePlatforms': [
'OSX'|'WINDOWS'|'LINUX'|'OBJC'|'SWIFT'|'ANDROID'|'JAVASCRIPT',
]
},
],
'NextToken': 'string'
}
Response Structure
Result structure contains a list of all available bundles with details.
A list of bundles.
The details of the bundle.
Unique bundle identifier.
Title of the download bundle.
Version of the download bundle.
Description of the download bundle.
Icon for the download bundle.
Developer desktop or mobile app or website platforms.
Developer desktop or target mobile app or website platform.
A token to resume pagination.
Mobile.Paginator.ListProjects¶paginator = client.get_paginator('list_projects')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Mobile.Client.list_projects().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'projects': [
{
'name': 'string',
'projectId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Result structure used for requests to list projects in AWS Mobile Hub.
List of projects.
Summary information about an AWS Mobile Hub project.
Name of the project.
Unique project identifier.
A token to resume pagination.