subscription_attributes
Creates, updates, deletes, gets or lists a subscription_attributes resource.
Overview
| Name | subscription_attributes |
| Type | Resource |
| Id | aws.sns.subscription_attributes |
Fields
The following fields are returned by SELECT queries:
- get_subscription_attributes
| Name | Datatype | Description |
|---|---|---|
attributes | 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 Data Firehose delivery stream subscriptions: SubscriptionRoleArn – The ARN of the IAM role that has the following: Permission to write to the Firehose delivery stream Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_subscription_attributes | select | SubscriptionArn, region | Returns all of the properties of a subscription. | |
set_subscription_attributes | update | SubscriptionArn, AttributeName, region | AttributeValue | Allows a subscription owner to set an attribute of the subscription to a new value. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
AttributeName | string | A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this 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. 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. 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. The following attribute applies only to Amazon Data Firehose delivery stream subscriptions: SubscriptionRoleArn – The ARN of the IAM role that has the following: Permission to write to the Firehose delivery stream Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide. |
SubscriptionArn | string | The ARN of the subscription to modify. |
region | string | AWS region (default: us-east-1) |
AttributeValue | string | The new value for the attribute in JSON format. |
SELECT examples
- get_subscription_attributes
Returns all of the properties of a subscription.
SELECT
attributes
FROM aws.sns.subscription_attributes
WHERE SubscriptionArn = '{{ SubscriptionArn }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- set_subscription_attributes
Allows a subscription owner to set an attribute of the subscription to a new value.
UPDATE aws.sns.subscription_attributes
SET
-- No updatable properties
WHERE
SubscriptionArn = '{{ SubscriptionArn }}' --required
AND AttributeName = '{{ AttributeName }}' --required
AND region = '{{ region }}' --required
AND AttributeValue = '{{ AttributeValue}}';