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.
385 386 387 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_project(params = {}) ⇒ Types::CreateProjectResult
Creates an AWS Mobile Hub project.
443 444 445 446 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 443 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.
485 486 487 488 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 485 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.
519 520 521 522 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 519 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.
566 567 568 569 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 566 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.
604 605 606 607 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 604 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.
639 640 641 642 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 639 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.
684 685 686 687 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 684 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.
724 725 726 727 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 724 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#update_project(params = {}) ⇒ Types::UpdateProjectResult
Update an existing project.
771 772 773 774 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 771 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |