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

Class: Aws::SNS::PlatformApplication

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn, options = {}) ⇒ PlatformApplication #initialize(options = {}) ⇒ PlatformApplication

Returns a new instance of PlatformApplication

Overloads:



19
20
21
22
23
24
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @arn = extract_arn(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#arnString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 29

def arn
  @arn
end

#attributesHash<String,String>

Attributes include the following:

  • EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.

  • EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.

  • EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.

  • EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

Returns:

  • (Hash<String,String>)


48
49
50
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 48

def attributes
  data.attributes
end

#clientClient

Returns:



55
56
57
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 55

def client
  @client
end

#create_platform_endpoint(options = {}) ⇒ PlatformEndpoint

Examples:

Request syntax with placeholder values


platformendpoint = platform_application.create_platform_endpoint({
  token: "String", # required
  custom_user_data: "String",
  attributes: {
    "String" => "String",
  },
})

Parameters:

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

    ({})

Options Hash (options):

  • :token (required, String)

    Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

  • :custom_user_data (String)

    Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • :attributes (Hash<String,String>)

    For a list of attributes, see SetEndpointAttributes.

Returns:



116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 116

def create_platform_endpoint(options = {})
  options = options.merge(platform_application_arn: @arn)
  resp = @client.create_platform_endpoint(options)
  PlatformEndpoint.new(
    arn: resp.data.endpoint_arn,
    client: @client
  )
end

#dataTypes::GetPlatformApplicationAttributesResponse



75
76
77
78
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 75

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



83
84
85
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 83

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


platform_application.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


130
131
132
133
134
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 130

def delete(options = {})
  options = options.merge(platform_application_arn: @arn)
  resp = @client.delete_platform_application(options)
  resp.data
end

#endpoints(options = {}) ⇒ PlatformEndpoint::Collection

Examples:

Request syntax with placeholder values


platform_application.endpoints()

Parameters:

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

    ({})

Returns:



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 193

def endpoints(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(platform_application_arn: @arn)
    resp = @client.list_endpoints_by_platform_application(options)
    resp.each_page do |page|
      batch = []
      page.data.endpoints.each do |e|
        batch << PlatformEndpoint.new(
          arn: e.endpoint_arn,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  PlatformEndpoint::Collection.new(batches)
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::SNS::PlatformApplication. Returns self making it possible to chain methods.

platform_application.reload.data

Returns:

  • (self)


65
66
67
68
69
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 65

def load
  resp = @client.get_platform_application_attributes(platform_application_arn: @arn)
  @data = resp.data
  self
end

#set_attributes(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


platform_application.set_attributes({
  attributes: { # required
    "String" => "String",
  },
})

Parameters:

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

    ({})

Options Hash (options):

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

    A map of the platform application attributes. Attributes in this map include the following:

    • PlatformCredential -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret".

    • PlatformPrincipal -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id".

    • EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.

    • EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.

    • EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.

    • EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

    • SuccessFeedbackRoleArn -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

    • FailureFeedbackRoleArn -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

    • SuccessFeedbackSampleRate -- Sample rate percentage (0-100) of successfully delivered messages.

Returns:

  • (EmptyStructure)


180
181
182
183
184
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_application.rb', line 180

def set_attributes(options = {})
  options = options.merge(platform_application_arn: @arn)
  resp = @client.set_platform_application_attributes(options)
  resp.data
end