Paws::SNS::Subscribe - Arguments for method Subscribe on Paws::SNS
This class represents the parameters used for calling the method Subscribe on the Amazon Simple Notification Service service. Use the attributes of this class as arguments to method Subscribe.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to Subscribe.
my $sns = Paws->service('SNS'); my $SubscribeResponse = $sns->Subscribe( Protocol => 'Myprotocol', TopicArn => 'MytopicARN', Attributes => { 'MyattributeName' => 'MyattributeValue', }, # OPTIONAL Endpoint => 'Myendpoint', # OPTIONAL ReturnSubscriptionArn => 1, # OPTIONAL ); # Results: my $SubscriptionArn = $SubscribeResponse->SubscriptionArn; # Returns a L<Paws::SNS::SubscribeResponse> object.
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/Subscribe
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the Subscribe action uses:
Subscribe
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DeliveryPolicy
FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicy
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.
RawMessageDelivery
true
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.
RedrivePolicy
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
SubscriptionRoleArn
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.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http protocol, the (public) endpoint is a URL beginning with http://.
http
http://
For the https protocol, the (public) endpoint is a URL beginning with https://.
https
https://
For the email protocol, the endpoint is an email address.
email
For the email-json protocol, the endpoint is an email address.
email-json
For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
sms
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
sqs
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
application
For the lambda protocol, the endpoint is the ARN of an Lambda function.
lambda
For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
firehose
The protocol that you want to use. Supported protocols include:
http – delivery of JSON-encoded message via HTTP POST
https – delivery of JSON-encoded message via HTTPS POST
email – delivery of message via SMTP
email-json – delivery of JSON-encoded message via SMTP
sms – delivery of message via SMS
sqs – delivery of JSON-encoded message to an Amazon SQS queue
application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
lambda – delivery of JSON-encoded message to an Lambda function
firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
pending subscription
ConfirmSubscription
The default value is false.
false
The ARN of the topic you want to subscribe to.
This class forms part of Paws, documenting arguments for method Subscribe in Paws::SNS
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
To install Paws, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws
CPAN shell
perl -MCPAN -e shell install Paws
For more information on module installation, please visit the detailed CPAN module installation guide.