/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SNS::SetSubscriptionAttributes

NAME

Paws::SNS::SetSubscriptionAttributes - Arguments for method SetSubscriptionAttributes on Paws::SNS

DESCRIPTION

This class represents the parameters used for calling the method SetSubscriptionAttributes on the Amazon Simple Notification Service service. Use the attributes of this class as arguments to method SetSubscriptionAttributes.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetSubscriptionAttributes.

SYNOPSIS

my $sns = Paws->service('SNS');
$sns->SetSubscriptionAttributes(
  AttributeName   => 'MyattributeName',
  SubscriptionArn => 'MysubscriptionARN',
  AttributeValue  => 'MyattributeValue',    # OPTIONAL
);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/sns/SetSubscriptionAttributes

ATTRIBUTES

REQUIRED AttributeName => Str

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.

  • 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 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 (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in the Amazon SNS Developer Guide.

AttributeValue => Str

The new value for the attribute in JSON format.

REQUIRED SubscriptionArn => Str

The ARN of the subscription to modify.

SEE ALSO

This class forms part of Paws, documenting arguments for method SetSubscriptionAttributes in Paws::SNS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues