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.
365 366 367 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#create_project(params = {}) ⇒ Types::CreateProjectResult
Creates an AWS Mobile Hub project.
423 424 425 426 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 423 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.
465 466 467 468 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 465 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.
499 500 501 502 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 499 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.
546 547 548 549 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 546 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.
584 585 586 587 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 584 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.
619 620 621 622 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 619 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.
664 665 666 667 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 664 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.
704 705 706 707 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 704 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#update_project(params = {}) ⇒ Types::UpdateProjectResult
Update an existing project.
751 752 753 754 |
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 751 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |