NAME

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

DESCRIPTION

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 shouln't make instances of this class. Each attribute should be used as a named argument in the call to Subscribe.

As an example:

$service_obj->Subscribe(Att1 => $value1, Att2 => $value2, ...);

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.

ATTRIBUTES

Endpoint => Str

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the endpoint is an URL beginning with "http://"

  • For the https protocol, the endpoint is a URL beginning with "https://"

  • For the email protocol, the endpoint is an email address

  • For the email-json protocol, the endpoint is an email address

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

REQUIRED Protocol => Str

The protocol 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.

REQUIRED TopicArn => Str

The ARN of the topic you want to subscribe to.

SEE ALSO

This class forms part of Paws, documenting arguments for method Subscribe 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