aws-sdk-pinpoint 1.34.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46e0b677503d40c7f89f038339612da1abed36e8
-  data.tar.gz: bb1a99540c1b0cac8f2c53979d336895d03e907c
+  metadata.gz: 22c586f79413e4a62633d28630ddd08cb70fbf3a
+  data.tar.gz: 99067e3afc319b847f66f991d5a29c7e66d7d15e
 SHA512:
-  metadata.gz: 6f1e51b6b7bc4336bd6e97e68b525abd1511427c322f27e5fb69d19d940d425b9d7ddc3e0af4a218fec10db35bafe177fb34fa2a4e4f55c557e61c4662fbbd37
-  data.tar.gz: 8af48b5cb1043001fa7320363a3848b93db1f9186969686d127038442b6f6267d3039ec5224a2c5e3e6ad1b07e1ff61bea1484a174bc2f64d660bed85ae4a6ae
+  metadata.gz: 2402c1771aa229448fb1b2977b058793bb2119e6bd60dac228aa103496e66782472a250a611945971738570d842a18e97b76c3d42de22682914d9e598a574510
+  data.tar.gz: cc8f9821ad74d1fab01b5f5c54484408bcfb1605b106aaada3722f0692593e98e7ae2e17a118ed86473919068405e0ccf46e5004adf4465466438a7ed3c6b0cf

data/lib/aws-sdk-pinpoint.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-pinpoint/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     pinpoint = Aws::Pinpoint::Client.new
+#     resp = pinpoint.create_app(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon Pinpoint all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon Pinpoint are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::Pinpoint::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon Pinpoint API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-pinpoint/customizations'
 # @service
 module Aws::Pinpoint
 
-  GEM_VERSION = '1.34.0'
+  GEM_VERSION = '1.35.0'
 
 end

data/lib/aws-sdk-pinpoint/client.rb

@@ -30,6 +30,16 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:pinpoint)
 
 module Aws::Pinpoint
+  # An API client for Pinpoint.  To construct a client, you need to configure a +:region+ and +:credentials+.
+  #     client = Aws::Pinpoint::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
+  # For details on configuring region and credentials see
+  # the {developer-guide}[https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html].
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -209,16 +219,16 @@ module Aws::Pinpoint
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
     #     safely be set
-    #     per-request on the session yeidled by {#session_for}.
+    #     per-request on the session yielded by {#session_for}.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idble before it is
+    #     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.
     #
@@ -227,7 +237,7 @@ module Aws::Pinpoint
     #     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 yeidled by {#session_for}.
+    #     request on the session yielded by {#session_for}.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -10167,7 +10177,7 @@ module Aws::Pinpoint
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-pinpoint'
-      context[:gem_version] = '1.34.0'
+      context[:gem_version] = '1.35.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-pinpoint/errors.rb

@@ -6,6 +6,39 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Pinpoint
+
+  # When Pinpoint returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::Pinpoint::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all Pinpoint errors using ServiceError:
+  #     begin
+  #       # do stuff
+  #     rescue Aws::Pinpoint::Errors::ServiceError
+  #       # rescues all Pinpoint API errors
+  #     end
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error, including:
+  # *
+  # * #params - The request params
+  # * #operation_name - Name of the API operation invoked
+  # * #http_request
+  # * #http_response
+  # * etc ...
+  #
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {BadRequestException}
+  # * {ForbiddenException}
+  # * {InternalServerErrorException}
+  # * {MethodNotAllowedException}
+  # * {NotFoundException}
+  # * {PayloadTooLargeException}
+  # * {TooManyRequestsException}
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors

data/lib/aws-sdk-pinpoint/resource.rb

@@ -6,6 +6,13 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Pinpoint
+  # This class provides a resource oriented interface for Pinpoint.
+  # To create a resource object:
+  #     resource = Aws::Pinpoint::Resource.new(region: 'us-west-2')
+  # You can supply a client object with custom configuration that will be used for all resource operations.
+  # If you do not pass +:client+, a default client will be constructed.
+  #     client = Aws::Pinpoint::Client.new(region: 'us-west-2')
+  #     resource = Aws::Pinpoint::Resource.new(client: client)
   class Resource
 
     # @param options ({})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-pinpoint
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core