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

Class: Aws::SNS::Types::SetPlatformApplicationAttributesInput

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 SetPlatformApplicationAttributesInput data as a hash:

{
  platform_application_arn: "String", # required
  attributes: { # required
    "String" => "String",
  },
}

Input for SetPlatformApplicationAttributes action.

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<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:

  • (Hash<String,String>)


1256
1257
1258
1259
1260
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 1256

class SetPlatformApplicationAttributesInput < Struct.new(
  :platform_application_arn,
  :attributes)
  include Aws::Structure
end

#platform_application_arnString

PlatformApplicationArn for SetPlatformApplicationAttributes action.

Returns:

  • (String)


1256
1257
1258
1259
1260
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 1256

class SetPlatformApplicationAttributesInput < Struct.new(
  :platform_application_arn,
  :attributes)
  include Aws::Structure
end