You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SNS::Types::ConfirmSubscriptionInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb

Overview

Note:

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

{
  topic_arn: "topicARN", # required
  token: "token", # required
  authenticate_on_unsubscribe: "authenticateOnUnsubscribe",
}

Input for ConfirmSubscription action.

Instance Attribute Summary collapse

Instance Attribute Details

#authenticate_on_unsubscribeString

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

Returns:

  • (String)


119
120
121
122
123
124
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 119

class ConfirmSubscriptionInput < Struct.new(
  :topic_arn,
  :token,
  :authenticate_on_unsubscribe)
  include Aws::Structure
end

#tokenString

Short-lived token sent to an endpoint during the Subscribe action.

Returns:

  • (String)


119
120
121
122
123
124
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 119

class ConfirmSubscriptionInput < Struct.new(
  :topic_arn,
  :token,
  :authenticate_on_unsubscribe)
  include Aws::Structure
end

#topic_arnString

The ARN of the topic for which you wish to confirm a subscription.

Returns:

  • (String)


119
120
121
122
123
124
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 119

class ConfirmSubscriptionInput < Struct.new(
  :topic_arn,
  :token,
  :authenticate_on_unsubscribe)
  include Aws::Structure
end