lib/aws-sdk-pinpointemail/client.rb in aws-sdk-pinpointemail-1.5.0 vs lib/aws-sdk-pinpointemail/client.rb in aws-sdk-pinpointemail-1.6.0

- old
+ new

@@ -197,10 +197,53 @@ # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # + # @option options [URI::HTTP,String] :http_proxy A proxy to send + # 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 + # `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}. + # + # @option options [Float] :http_idle_timeout (5) The number of + # seconds a connection is allowed to sit idble before it is + # considered stale. Stale connections are closed and removed + # from the pool before making a request. + # + # @option options [Float] :http_continue_timeout (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 yeidled by {#session_for}. + # + # @option options [Boolean] :http_wire_trace (false) When `true`, + # HTTP debug output will be sent to the `:logger`. + # + # @option options [Boolean] :ssl_verify_peer (true) When `true`, + # SSL peer certificates are verified when establishing a + # connection. + # + # @option options [String] :ssl_ca_bundle 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. + # + # @option options [String] :ssl_ca_directory 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. + # def initialize(*args) super end # @!group API Operations @@ -230,10 +273,14 @@ # # @option params [Types::SendingOptions] :sending_options # An object that defines whether or not Amazon Pinpoint can send email # that you send using the configuration set. # + # @option params [Array<Types::Tag>] :tags + # An object that defines the tags (keys and values) that you want to + # associate with the configuration set. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.create_configuration_set({ @@ -249,10 +296,16 @@ # last_fresh_start: Time.now, # }, # sending_options: { # sending_enabled: false, # }, + # tags: [ + # { + # key: "TagKey", # required + # value: "TagValue", # required + # }, + # ], # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateConfigurationSet AWS API Documentation # # @overload create_configuration_set(params = {}) @@ -332,16 +385,26 @@ # Pinpoint sends it using only the IP addresses in the associated pool. # # @option params [required, String] :pool_name # The name of the dedicated IP pool. # + # @option params [Array<Types::Tag>] :tags + # An object that defines the tags (keys and values) that you want to + # associate with the pool. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.create_dedicated_ip_pool({ # pool_name: "PoolName", # required + # tags: [ + # { + # key: "TagKey", # required + # value: "TagValue", # required + # }, + # ], # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateDedicatedIpPool AWS API Documentation # # @overload create_dedicated_ip_pool(params = {}) @@ -371,10 +434,14 @@ # # @option params [required, Types::EmailContent] :content # The HTML body of the message that you sent when you performed the # predictive inbox placement test. # + # @option params [Array<Types::Tag>] :tags + # An object that defines the tags (keys and values) that you want to + # associate with the predictive inbox placement test. + # # @return [Types::CreateDeliverabilityTestReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDeliverabilityTestReportResponse#report_id #report_id} => String # * {Types::CreateDeliverabilityTestReportResponse#deliverability_test_status #deliverability_test_status} => String # @@ -402,10 +469,16 @@ # }, # raw: { # data: "data", # required # }, # }, + # tags: [ + # { + # key: "TagKey", # required + # value: "TagValue", # required + # }, + # ], # }) # # @example Response structure # # resp.report_id #=> String @@ -440,20 +513,30 @@ # complete the domain verification process. # # @option params [required, String] :email_identity # The email address or domain that you want to verify. # + # @option params [Array<Types::Tag>] :tags + # An object that defines the tags (keys and values) that you want to + # associate with the email identity. + # # @return [Types::CreateEmailIdentityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateEmailIdentityResponse#identity_type #identity_type} => String # * {Types::CreateEmailIdentityResponse#verified_for_sending_status #verified_for_sending_status} => Boolean # * {Types::CreateEmailIdentityResponse#dkim_attributes #dkim_attributes} => Types::DkimAttributes # # @example Request syntax with placeholder values # # resp = client.create_email_identity({ # email_identity: "Identity", # required + # tags: [ + # { + # key: "TagKey", # required + # value: "TagValue", # required + # }, + # ], # }) # # @example Response structure # # resp.identity_type #=> String, one of "EMAIL_ADDRESS", "DOMAIN", "MANAGED_DOMAIN" @@ -1191,10 +1274,46 @@ def list_email_identities(params = {}, options = {}) req = build_request(:list_email_identities, params) req.send_request(options) end + # Retrieve a list of the tags (keys and values) that are associated with + # a specific resource. A *tag* is a label that you optionally define and + # associate with a resource in Amazon Pinpoint. Each tag consists of a + # required *tag key* and an optional associated *tag value*. A tag key + # is a general label that acts as a category for more specific tag + # values. A tag value acts as a descriptor within a tag key. + # + # @option params [required, String] :resource_arn + # The Amazon Resource Name (ARN) of the resource that you want to + # retrieve tag information for. + # + # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt; + # + # @example Request syntax with placeholder values + # + # resp = client.list_tags_for_resource({ + # resource_arn: "AmazonResourceName", # required + # }) + # + # @example Response structure + # + # resp.tags #=> Array + # resp.tags[0].key #=> String + # resp.tags[0].value #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListTagsForResource AWS API Documentation + # + # @overload list_tags_for_resource(params = {}) + # @param [Hash] params ({}) + def list_tags_for_resource(params = {}, options = {}) + req = build_request(:list_tags_for_resource, params) + req.send_request(options) + end + # Enable or disable the automatic warm-up feature for dedicated IP # addresses. # # @option params [Boolean] :auto_warmup_enabled # Enables or disables the automatic warm-up feature for dedicated IP @@ -1693,10 +1812,89 @@ def send_email(params = {}, options = {}) req = build_request(:send_email, params) req.send_request(options) end + # Add one or more tags (keys and values) to one or more specified + # resources. A *tag* is a label that you optionally define and associate + # with a resource in Amazon Pinpoint. Tags can help you categorize and + # manage resources in different ways, such as by purpose, owner, + # environment, or other criteria. A resource can have as many as 50 + # tags. + # + # Each tag consists of a required *tag key* and an associated *tag + # value*, both of which you define. A tag key is a general label that + # acts as a category for more specific tag values. A tag value acts as a + # descriptor within a tag key. + # + # @option params [required, String] :resource_arn + # The Amazon Resource Name (ARN) of the resource that you want to add + # one or more tags to. + # + # @option params [required, Array<Types::Tag>] :tags + # A list of the tags that you want to add to the resource. A tag + # consists of a required tag key (`Key`) and an associated tag value + # (`Value`). The maximum length of a tag key is 128 characters. The + # maximum length of a tag value is 256 characters. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.tag_resource({ + # resource_arn: "AmazonResourceName", # required + # tags: [ # required + # { + # key: "TagKey", # required + # value: "TagValue", # required + # }, + # ], + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/TagResource AWS API Documentation + # + # @overload tag_resource(params = {}) + # @param [Hash] params ({}) + def tag_resource(params = {}, options = {}) + req = build_request(:tag_resource, params) + req.send_request(options) + end + + # Remove one or more tags (keys and values) from a specified resource. + # + # @option params [required, String] :resource_arn + # The Amazon Resource Name (ARN) of the resource that you want to remove + # one or more tags from. + # + # @option params [required, Array<String>] :tag_keys + # The tags (tag keys) that you want to remove from the resource. When + # you specify a tag key, the action removes both that key and its + # associated tag value. + # + # To remove more than one tag from the resource, append the `TagKeys` + # parameter and argument for each additional tag to remove, separated by + # an ampersand. For example: + # `/v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2` + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.untag_resource({ + # resource_arn: "AmazonResourceName", # required + # tag_keys: ["TagKey"], # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/UntagResource AWS API Documentation + # + # @overload untag_resource(params = {}) + # @param [Hash] params ({}) + def untag_resource(params = {}, options = {}) + req = build_request(:untag_resource, params) + req.send_request(options) + end + # Update the configuration of an event destination for a configuration # set. # # In Amazon Pinpoint, *events* include message sends, deliveries, opens, # clicks, bounces, and complaints. *Event destinations* are places that @@ -1767,10 +1965,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-pinpointemail' - context[:gem_version] = '1.5.0' + context[:gem_version] = '1.6.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated