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

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

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

Input for SetPlatformApplicationAttributes action.

Constant Summary collapse

SENSITIVE =
[]

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` and `APNS_SANDBOX`, `PlatformCredential` is `private key`. For `GCM` (Firebase Cloud Messaging), `PlatformCredential` is `API key`. For `ADM`, `PlatformCredential` is `client secret`.

  • ‘PlatformPrincipal` – The principal received from the notification service. For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL certificate`. For `GCM` (Firebase Cloud Messaging), there is no `PlatformPrincipal`. For `ADM`, `PlatformPrincipal` is `client id`.

  • ‘EventEndpointCreated` – Topic ARN to which `EndpointCreated` event notifications are sent.

  • ‘EventEndpointDeleted` – Topic ARN to which `EndpointDeleted` event notifications are sent.

  • ‘EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event notifications are sent.

  • ‘EventDeliveryFailure` – Topic ARN to which `DeliveryFailure` event notifications are 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>)


1750
1751
1752
1753
1754
1755
# File 'lib/aws-sdk-sns/types.rb', line 1750

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

#platform_application_arnString

PlatformApplicationArn for SetPlatformApplicationAttributes action.

Returns:

  • (String)


1750
1751
1752
1753
1754
1755
# File 'lib/aws-sdk-sns/types.rb', line 1750

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