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

Inherits:
Struct
  • Object
show all
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",
  attributes: {
    "attributeName" => "attributeValue",
  },
  return_subscription_arn: false,
}

Input for Subscribe action.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,String>

Assigns attributes to the subscription as a map of key-value pairs. You can assign any attribute that is supported by the ‘SetSubscriptionAttributes` action.

Returns:

  • (Hash<String,String>) 


1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/aws-sdk-sns/types.rb', line 1558

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

#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) 


1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/aws-sdk-sns/types.rb', line 1558

class SubscribeInput < Struct.new(
  :topic_arn,
  :protocol,
  :endpoint,
  :attributes,
  :return_subscription_arn)
  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) 


1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/aws-sdk-sns/types.rb', line 1558

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

#return_subscription_arn ⇒ Boolean

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 ‘false`, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of “pending subscription” for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the `ConfirmSubscription` action with a confirmation token.

If you set this parameter to ‘true`, the response includes the ARN in all cases, even if the subscription is not yet confirmed.

The default value is ‘false`.

Returns:

  • (Boolean) 


1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/aws-sdk-sns/types.rb', line 1558

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

#topic_arn ⇒ String

The ARN of the topic you want to subscribe to.

Returns:

  • (String) 


1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/aws-sdk-sns/types.rb', line 1558

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