Class: Aws::Mobile::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



344
345
346
 
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 344

def initialize(*args)
  super
end

Instance Method Details

#create_project(params = {}) ⇒ Types::CreateProjectResult

Creates an AWS Mobile Hub project.

Examples:

Request syntax with placeholder values


resp = client.create_project({
  name: "ProjectName",
  region: "ProjectRegion",
  contents: "data",
  snapshot_id: "SnapshotId",
})

Response structure


resp.details.name #=> String
resp.details.project_id #=> String
resp.details.region #=> String
resp.details.state #=> String, one of "NORMAL", "SYNCING", "IMPORTING"
resp.details.created_date #=> Time
resp.details.last_updated_date #=> Time
resp.details.console_url #=> String
resp.details.resources #=> Array
resp.details.resources[0].type #=> String
resp.details.resources[0].name #=> String
resp.details.resources[0].arn #=> String
resp.details.resources[0].feature #=> String
resp.details.resources[0].attributes #=> Hash
resp.details.resources[0].attributes["AttributeKey"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (String) —

    Name of the project.

  • :region (String) —

    Default region where project resources should be created.

  • :contents (String, StringIO, File) —

    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.

  • :snapshot_id (String) —

    Unique identifier for an exported snapshot of project configuration. This snapshot identifier is included in the share URL when a project is exported.

Returns:

See Also:



402
403
404
405
 
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 402

def create_project(params = {}, options = {})
  req = build_request(:create_project, params)
  req.send_request(options)
end

#delete_project(params = {}) ⇒ Types::DeleteProjectResult

Delets a project in AWS Mobile Hub.

Examples:

Request syntax with placeholder values


resp = client.delete_project({
  project_id: "ProjectId", # required
})

Response structure


resp.deleted_resources #=> Array
resp.deleted_resources[0].type #=> String
resp.deleted_resources[0].name #=> String
resp.deleted_resources[0].arn #=> String
resp.deleted_resources[0].feature #=> String
resp.deleted_resources[0].attributes #=> Hash
resp.deleted_resources[0].attributes["AttributeKey"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.orphaned_resources #=> Array
resp.orphaned_resources[0].type #=> String
resp.orphaned_resources[0].name #=> String
resp.orphaned_resources[0].arn #=> String
resp.orphaned_resources[0].feature #=> String
resp.orphaned_resources[0].attributes #=> Hash
resp.orphaned_resources[0].attributes["AttributeKey"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    Unique project identifier.

Returns:

See Also:



444
445
446
447
 
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 444

def delete_project(params = {}, options = {})
  req = build_request(:delete_project, params)
  req.send_request(options)
end

#describe_bundle(params = {}) ⇒ Types::DescribeBundleResult

Get the bundle details for the requested bundle id.

Examples:

Request syntax with placeholder values


resp = client.describe_bundle({
  bundle_id: "BundleId", # required
})

Response structure


resp.details.bundle_id #=> String
resp.details.title #=> String
resp.details.version #=> String
resp.details.description #=> String
resp.details.icon_url #=> String
resp.details.available_platforms #=> Array
resp.details.available_platforms[0] #=> String, one of "OSX", "WINDOWS", "LINUX", "OBJC", "SWIFT", "ANDROID", "JAVASCRIPT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bundle_id (required, String) —

    Unique bundle identifier.

Returns:

See Also:



478
479
480
481
 
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 478

def describe_bundle(params = {}, options = {})
  req = build_request(:describe_bundle, params)
  req.send_request(options)
end

#describe_project(params = {}) ⇒ Types::DescribeProjectResult

Gets details about a project in AWS Mobile Hub.

Examples:

Request syntax with placeholder values


resp = client.describe_project({
  project_id: "ProjectId", # required
  sync_from_resources: false,
})

Response structure


resp.details.name #=> String
resp.details.project_id #=> String
resp.details.region #=> String
resp.details.state #=> String, one of "NORMAL", "SYNCING", "IMPORTING"
resp.details.created_date #=> Time
resp.details.last_updated_date #=> Time
resp.details.console_url #=> String
resp.details.resources #=> Array
resp.details.resources[0].type #=> String
resp.details.resources[0].name #=> String
resp.details.resources[0].arn #=> String
resp.details.resources[0].feature #=> String
resp.details.resources[0].attributes #=> Hash
resp.details.resources[0].attributes["AttributeKey"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    Unique project identifier.

  • :sync_from_resources (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.

Returns:

See Also:



525
526
527
528
 
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 525

def describe_project(params = {}, options = {})
  req = build_request(:describe_project, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.export_bundle({
  bundle_id: "BundleId", # required
  project_id: "ProjectId",
  platform: "OSX", # accepts OSX, WINDOWS, LINUX, OBJC, SWIFT, ANDROID, JAVASCRIPT
})

Response structure


resp.download_url #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bundle_id (required, String) —

    Unique bundle identifier.

  • :project_id (String) —

    Unique project identifier.

  • :platform (String) —

    Developer desktop or target application platform.

Returns:

See Also:



563
564
565
566
 
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 563

def export_bundle(params = {}, options = {})
  req = build_request(:export_bundle, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.export_project({
  project_id: "ProjectId", # required
})

Response structure


resp.download_url #=> String
resp.share_url #=> String
resp.snapshot_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    Unique project identifier.

Returns:

See Also:



598
599
600
601
 
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 598

def export_project(params = {}, options = {})
  req = build_request(:export_project, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_bundles({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.bundle_list #=> Array
resp.bundle_list[0].bundle_id #=> String
resp.bundle_list[0].title #=> String
resp.bundle_list[0].version #=> String
resp.bundle_list[0].description #=> String
resp.bundle_list[0].icon_url #=> String
resp.bundle_list[0].available_platforms #=> Array
resp.bundle_list[0].available_platforms[0] #=> String, one of "OSX", "WINDOWS", "LINUX", "OBJC", "SWIFT", "ANDROID", "JAVASCRIPT"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of records to list in a single response.

  • :next_token (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.

Returns:

See Also:



643
644
645
646
 
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 643

def list_bundles(params = {}, options = {})
  req = build_request(:list_bundles, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_projects({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.projects #=> Array
resp.projects[0].name #=> String
resp.projects[0].project_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of records to list in a single response.

  • :next_token (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.

Returns:

See Also:



683
684
685
686
 
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 683

def list_projects(params = {}, options = {})
  req = build_request(:list_projects, params)
  req.send_request(options)
end

#update_project(params = {}) ⇒ Types::UpdateProjectResult

Update an existing project.

Examples:

Request syntax with placeholder values


resp = client.update_project({
  contents: "data",
  project_id: "ProjectId", # required
})

Response structure


resp.details.name #=> String
resp.details.project_id #=> String
resp.details.region #=> String
resp.details.state #=> String, one of "NORMAL", "SYNCING", "IMPORTING"
resp.details.created_date #=> Time
resp.details.last_updated_date #=> Time
resp.details.console_url #=> String
resp.details.resources #=> Array
resp.details.resources[0].type #=> String
resp.details.resources[0].name #=> String
resp.details.resources[0].arn #=> String
resp.details.resources[0].feature #=> String
resp.details.resources[0].attributes #=> Hash
resp.details.resources[0].attributes["AttributeKey"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contents (String, StringIO, File) —

    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.

  • :project_id (required, String) —

    Unique project identifier.

Returns:

See Also:



730
731
732
733
 
# File 'gems/aws-sdk-mobile/lib/aws-sdk-mobile/client.rb', line 730

def update_project(params = {}, options = {})
  req = build_request(:update_project, params)
  req.send_request(options)
end