Class: Aws::SNS::Types::SetSubscriptionAttributesInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb

Overview

Note:

When making an API call, you may pass SetSubscriptionAttributesInput data as a hash:

{
  subscription_arn: "subscriptionARN", # required
  attribute_name: "attributeName", # required
  attribute_value: "attributeValue",
}

Input for SetSubscriptionAttributes action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

Returns:

  • (String)


1851
1852
1853
1854
1855
1856
1857
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 1851

class SetSubscriptionAttributesInput < Struct.new(
  :subscription_arn,
  :attribute_name,
  :attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_valueString

The new value for the attribute in JSON format.

Returns:

  • (String)


1851
1852
1853
1854
1855
1856
1857
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 1851

class SetSubscriptionAttributesInput < Struct.new(
  :subscription_arn,
  :attribute_name,
  :attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_arnString

The ARN of the subscription to modify.

Returns:

  • (String)


1851
1852
1853
1854
1855
1856
1857
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 1851

class SetSubscriptionAttributesInput < Struct.new(
  :subscription_arn,
  :attribute_name,
  :attribute_value)
  SENSITIVE = []
  include Aws::Structure
end