2017/09/01 - AWS Mobile - 9 new api methods
Changes AWS Mobile Hub is an integrated experience designed to help developers build, test, configure and release cloud-based applications for mobile devices using Amazon Web Services. AWS Mobile Hub provides a console and API for developers, allowing them to quickly select desired features and integrate them into mobile applications. Features include NoSQL Database, Cloud Logic, Messaging and Analytics. With AWS Mobile Hub, you pay only for the underlying services that Mobile Hub provisions based on the features you choose in the Mobile Hub console.
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
client.export_project(
projectId='string'
)
string
[REQUIRED]
Unique project identifier.
dict
Response Syntax
{
'downloadUrl': 'string',
'shareUrl': 'string',
'snapshotId': 'string'
}
Response Structure
(dict) --
Result structure used for requests to export project configuration details.
downloadUrl (string) --
URL which can be used to download the exported project configuation file(s).
shareUrl (string) --
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.
snapshotId (string) --
Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL.
Lists projects in AWS Mobile Hub.
See also: AWS API Documentation
Request Syntax
client.list_projects(
maxResults=123,
nextToken='string'
)
integer
Maximum number of records to list in a single response.
string
Pagination token. Set to null to start listing projects from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more projects.
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.
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
client.export_bundle(
bundleId='string',
projectId='string',
platform='OSX'|'WINDOWS'|'LINUX'|'OBJC'|'SWIFT'|'ANDROID'|'JAVASCRIPT'
)
string
[REQUIRED]
Unique bundle identifier.
string
Unique project identifier.
string
Developer desktop or target application platform.
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.
Gets details about a project in AWS Mobile Hub.
See also: AWS API Documentation
Request Syntax
client.describe_project(
projectId='string',
syncFromResources=True|False
)
string
[REQUIRED]
Unique project identifier.
boolean
If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub project.
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.
Delets a project in AWS Mobile Hub.
See also: AWS API Documentation
Request Syntax
client.delete_project(
projectId='string'
)
string
[REQUIRED]
Unique project identifier.
dict
Response Syntax
{
'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
(dict) --
Result structure used in response to request to delete a project.
deletedResources (list) --
Resources which were deleted.
(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.
orphanedResources (list) --
Resources which were not deleted, due to a risk of losing potentially important data or files.
(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.
List all available bundles.
See also: AWS API Documentation
Request Syntax
client.list_bundles(
maxResults=123,
nextToken='string'
)
integer
Maximum number of records to list in a single response.
string
Pagination token. Set to null to start listing bundles from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more bundles.
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.
Get the bundle details for the requested bundle id.
See also: AWS API Documentation
Request Syntax
client.describe_bundle(
bundleId='string'
)
string
[REQUIRED]
Unique bundle identifier.
dict
Response Syntax
{
'details': {
'bundleId': 'string',
'title': 'string',
'version': 'string',
'description': 'string',
'iconUrl': 'string',
'availablePlatforms': [
'OSX'|'WINDOWS'|'LINUX'|'OBJC'|'SWIFT'|'ANDROID'|'JAVASCRIPT',
]
}
}
Response Structure
(dict) --
Result structure contains the details of the bundle.
details (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.
Creates an AWS Mobile Hub project.
See also: AWS API Documentation
Request Syntax
client.create_project(
name='string',
region='string',
contents=b'bytes'|file,
snapshotId='string'
)
string
Name of the project.
string
Default region where project resources should be created.
bytes or seekable file-like object
ZIP or YAML file which contains configuration settings to be used when creating the project. This may be the contents of the file downloaded from the URL provided in an export project operation.
string
Unique identifier for an exported snapshot of project configuration. This snapshot identifier is included in the share URL when a project is exported.
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.
Update an existing project.
See also: AWS API Documentation
Request Syntax
client.update_project(
contents=b'bytes'|file,
projectId='string'
)
bytes or seekable file-like object
ZIP or YAML file which contains project configuration to be updated. This should be the contents of the file downloaded from the URL provided in an export project operation.
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.