Class: Aws::SNS::Types::SubscribeInput

Inherits:

Struct

• Object
• Struct
• Aws::SNS::Types::SubscribeInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sns/types.rb

Overview

Note:

When making an API call, you may pass SubscribeInput data as a hash:

{
  topic_arn: "topicARN", # required
  protocol: "protocol", # required
  endpoint: "endpoint",
}

Input for Subscribe action.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #endpoint ⇒ String

  The endpoint that you want to receive notifications.

• #protocol ⇒ String

  The protocol you want to use.

• #topic_arn ⇒ String

  The ARN of the topic you want to subscribe to.

Instance Attribute Details

#endpoint ⇒ String

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.

• For the ‘lambda` protocol, the endpoint is the ARN of an AWS Lambda function.

Returns:

• (String)

# File 'lib/aws-sdk-sns/types.rb', line 1505

class SubscribeInput < Struct.new(
  :topic_arn,
  :protocol,
  :endpoint)
  include Aws::Structure
end

#protocol ⇒ String

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.

• ‘lambda` – delivery of JSON-encoded message to an AWS Lambda function.

Returns:

• (String)

# File 'lib/aws-sdk-sns/types.rb', line 1505

class SubscribeInput < Struct.new(
  :topic_arn,
  :protocol,
  :endpoint)
  include Aws::Structure
end

#topic_arn ⇒ String

The ARN of the topic you want to subscribe to.

Returns:

• (String)

# File 'lib/aws-sdk-sns/types.rb', line 1505

class SubscribeInput < Struct.new(
  :topic_arn,
  :protocol,
  :endpoint)
  include Aws::Structure
end