Class: Aws::SNS::Types::GetSubscriptionAttributesResponse

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

Overview

Response for GetSubscriptionAttributes action.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,String>

A map of the subscription’s attributes. Attributes in this map include the following:

  • ‘ConfirmationWasAuthenticated` – `true` if the subscription confirmation request was authenticated.

  • ‘DeliveryPolicy` – The JSON serialization of the subscription’s delivery policy.

  • ‘EffectiveDeliveryPolicy` – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • ‘FilterPolicy` – The filter policy JSON that is assigned to the subscription. For more information, see [Amazon SNS Message Filtering] in the *Amazon SNS Developer Guide*.

  • ‘FilterPolicyScope` – This attribute lets you choose the filtering scope by using one of the following string value types:

    • ‘MessageAttributes` (default) – The filter is applied on the message attributes.

    • ‘MessageBody` – The filter is applied on the message body.

  • ‘Owner` – The Amazon Web Services account ID of the subscription’s owner.

  • ‘PendingConfirmation` – `true` if the subscription hasn’t been confirmed. To confirm a pending subscription, call the ‘ConfirmSubscription` action with a confirmation token.

  • ‘RawMessageDelivery` – `true` if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • ‘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.

  • ‘SubscriptionArn` – The subscription’s ARN.

  • ‘TopicArn` – The topic ARN that the subscription is associated with.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

  • ‘SubscriptionRoleArn` – The ARN of the IAM role that has the following:

    • Permission to write to the Kinesis Data Firehose delivery stream

    • Amazon SNS listed as a trusted entity

    Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see [Fanout to Kinesis Data Firehose delivery streams] in the *Amazon SNS Developer Guide*.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html [2]: docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html

Returns:

  • (Hash<String,String>) 


865
866
867
868
869
 
# File 'lib/aws-sdk-sns/types.rb', line 865

class GetSubscriptionAttributesResponse < Struct.new(
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end