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

Class: Aws::SNS::Resource

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

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Resource

Returns a new instance of Resource

Parameters:

  • options ({}) (defaults to: {})

Options Hash (options):



13
14
15
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 13

def initialize(options = {})
  @client = options[:client] || Client.new(options)
end

Instance Method Details

#clientClient

Returns:



18
19
20
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 18

def client
  @client
end

#create_platform_application(options = {}) ⇒ PlatformApplication

Examples:

Request syntax with placeholder values


platformapplication = sns.create_platform_application({
  name: "String", # required
  platform: "String", # required
  attributes: { # required
    "String" => "String",
  },
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :name (required, String)

    Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

  • :platform (required, String)

    The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

  • :attributes (required, Hash<String,String>)

    For a list of attributes, see SetPlatformApplicationAttributes

Returns:



49
50
51
52
53
54
55
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 49

def create_platform_application(options = {})
  resp = @client.create_platform_application(options)
  PlatformApplication.new(
    arn: resp.data.platform_application_arn,
    client: @client
  )
end

#create_topic(options = {}) ⇒ Topic

Examples:

Request syntax with placeholder values


topic = sns.create_topic({
  name: "topicName", # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :name (required, String)

    The name of the topic you want to create.

    Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

Returns:



70
71
72
73
74
75
76
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 70

def create_topic(options = {})
  resp = @client.create_topic(options)
  Topic.new(
    arn: resp.data.topic_arn,
    client: @client
  )
end

#platform_application(arn) ⇒ PlatformApplication

Parameters:

  • arn (String)

Returns:



82
83
84
85
86
87
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 82

def platform_application(arn)
  PlatformApplication.new(
    arn: arn,
    client: @client
  )
end

#platform_applications(options = {}) ⇒ PlatformApplication::Collection

Examples:

Request syntax with placeholder values


sns.platform_applications()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 94

def platform_applications(options = {})
  batches = Enumerator.new do |y|
    resp = @client.list_platform_applications(options)
    resp.each_page do |page|
      batch = []
      page.data.platform_applications.each do |p|
        batch << PlatformApplication.new(
          arn: p.platform_application_arn,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  PlatformApplication::Collection.new(batches)
end

#platform_endpoint(arn) ⇒ PlatformEndpoint

Parameters:

  • arn (String)

Returns:



113
114
115
116
117
118
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 113

def platform_endpoint(arn)
  PlatformEndpoint.new(
    arn: arn,
    client: @client
  )
end

#subscription(arn) ⇒ Subscription

Parameters:

  • arn (String)

Returns:



122
123
124
125
126
127
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 122

def subscription(arn)
  Subscription.new(
    arn: arn,
    client: @client
  )
end

#subscriptions(options = {}) ⇒ Subscription::Collection

Examples:

Request syntax with placeholder values


sns.subscriptions()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 134

def subscriptions(options = {})
  batches = Enumerator.new do |y|
    resp = @client.list_subscriptions(options)
    resp.each_page do |page|
      batch = []
      page.data.subscriptions.each do |s|
        batch << Subscription.new(
          arn: s.subscription_arn,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Subscription::Collection.new(batches)
end

#topic(arn) ⇒ Topic

Parameters:

  • arn (String)

Returns:



153
154
155
156
157
158
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 153

def topic(arn)
  Topic.new(
    arn: arn,
    client: @client
  )
end

#topics(options = {}) ⇒ Topic::Collection

Examples:

Request syntax with placeholder values


sns.topics()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 165

def topics(options = {})
  batches = Enumerator.new do |y|
    resp = @client.list_topics(options)
    resp.each_page do |page|
      batch = []
      page.data.topics.each do |t|
        batch << Topic.new(
          arn: t.topic_arn,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Topic::Collection.new(batches)
end