Class: Aws::Mobile::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Mobile::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb
Overview
An API client for Mobile. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Mobile::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_project(params = {}) ⇒ Types::CreateProjectResult
Creates an AWS Mobile Hub project.
-
#delete_project(params = {}) ⇒ Types::DeleteProjectResult
Delets a project in AWS Mobile Hub.
-
#describe_bundle(params = {}) ⇒ Types::DescribeBundleResult
Get the bundle details for the requested bundle id.
-
#describe_project(params = {}) ⇒ Types::DescribeProjectResult
Gets details about a project in AWS Mobile Hub.
-
#export_bundle(params = {}) ⇒ Types::ExportBundleResult
Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.
-
#export_project(params = {}) ⇒ Types::ExportProjectResult
Exports project configuration to a snapshot which can be downloaded and shared.
-
#list_bundles(params = {}) ⇒ Types::ListBundlesResult
List all available bundles.
-
#list_projects(params = {}) ⇒ Types::ListProjectsResult
Lists projects in AWS Mobile Hub.
-
#update_project(params = {}) ⇒ Types::UpdateProjectResult
Update an existing project.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
409 410 411 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#create_project(params = {}) ⇒ Types::CreateProjectResult
Creates an AWS Mobile Hub project.
467 468 469 470 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 467 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#delete_project(params = {}) ⇒ Types::DeleteProjectResult
Delets a project in AWS Mobile Hub.
509 510 511 512 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 509 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() end |
#describe_bundle(params = {}) ⇒ Types::DescribeBundleResult
Get the bundle details for the requested bundle id.
543 544 545 546 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 543 def describe_bundle(params = {}, = {}) req = build_request(:describe_bundle, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResult
Gets details about a project in AWS Mobile Hub.
590 591 592 593 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 590 def describe_project(params = {}, = {}) req = build_request(:describe_project, params) req.send_request() end |
#export_bundle(params = {}) ⇒ Types::ExportBundleResult
Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.
628 629 630 631 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 628 def export_bundle(params = {}, = {}) req = build_request(:export_bundle, params) req.send_request() end |
#export_project(params = {}) ⇒ Types::ExportProjectResult
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.
663 664 665 666 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 663 def export_project(params = {}, = {}) req = build_request(:export_project, params) req.send_request() end |
#list_bundles(params = {}) ⇒ Types::ListBundlesResult
List all available bundles.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
708 709 710 711 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 708 def list_bundles(params = {}, = {}) req = build_request(:list_bundles, params) req.send_request() end |
#list_projects(params = {}) ⇒ Types::ListProjectsResult
Lists projects in AWS Mobile Hub.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
748 749 750 751 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 748 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#update_project(params = {}) ⇒ Types::UpdateProjectResult
Update an existing project.
795 796 797 798 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 795 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |