Class: Aws::SNS::Types::SetEndpointAttributesInput

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

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

Input for SetEndpointAttributes action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<String,String>

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

  • CustomUserData – 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.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Returns:

  • (Hash<String,String>)


1686
1687
1688
1689
1690
1691
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 1686

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

#endpoint_arnString

EndpointArn used for SetEndpointAttributes action.

Returns:

  • (String)


1686
1687
1688
1689
1690
1691
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 1686

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