/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace SNS { namespace Model { /** *

Input for SetEndpointAttributes action.

See Also:

AWS * API Reference

*/ class SetEndpointAttributesRequest : public SNSRequest { public: AWS_SNS_API SetEndpointAttributesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "SetEndpointAttributes"; } AWS_SNS_API Aws::String SerializePayload() const override; protected: AWS_SNS_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

EndpointArn used for SetEndpointAttributes action.

*/ inline const Aws::String& GetEndpointArn() const{ return m_endpointArn; } /** *

EndpointArn used for SetEndpointAttributes action.

*/ inline bool EndpointArnHasBeenSet() const { return m_endpointArnHasBeenSet; } /** *

EndpointArn used for SetEndpointAttributes action.

*/ inline void SetEndpointArn(const Aws::String& value) { m_endpointArnHasBeenSet = true; m_endpointArn = value; } /** *

EndpointArn used for SetEndpointAttributes action.

*/ inline void SetEndpointArn(Aws::String&& value) { m_endpointArnHasBeenSet = true; m_endpointArn = std::move(value); } /** *

EndpointArn used for SetEndpointAttributes action.

*/ inline void SetEndpointArn(const char* value) { m_endpointArnHasBeenSet = true; m_endpointArn.assign(value); } /** *

EndpointArn used for SetEndpointAttributes action.

*/ inline SetEndpointAttributesRequest& WithEndpointArn(const Aws::String& value) { SetEndpointArn(value); return *this;} /** *

EndpointArn used for SetEndpointAttributes action.

*/ inline SetEndpointAttributesRequest& WithEndpointArn(Aws::String&& value) { SetEndpointArn(std::move(value)); return *this;} /** *

EndpointArn used for SetEndpointAttributes action.

*/ inline SetEndpointAttributesRequest& WithEndpointArn(const char* value) { SetEndpointArn(value); return *this;} /** *

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.

*/ inline const Aws::Map& GetAttributes() const{ return m_attributes; } /** *

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.

*/ inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; } /** *

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.

*/ inline void SetAttributes(const Aws::Map& value) { m_attributesHasBeenSet = true; m_attributes = value; } /** *

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.

*/ inline void SetAttributes(Aws::Map&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); } /** *

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.

*/ inline SetEndpointAttributesRequest& WithAttributes(const Aws::Map& value) { SetAttributes(value); return *this;} /** *

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.

*/ inline SetEndpointAttributesRequest& WithAttributes(Aws::Map&& value) { SetAttributes(std::move(value)); return *this;} /** *

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.

*/ inline SetEndpointAttributesRequest& AddAttributes(const Aws::String& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

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.

*/ inline SetEndpointAttributesRequest& AddAttributes(Aws::String&& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

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.

*/ inline SetEndpointAttributesRequest& AddAttributes(const Aws::String& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline SetEndpointAttributesRequest& AddAttributes(Aws::String&& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), std::move(value)); return *this; } /** *

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.

*/ inline SetEndpointAttributesRequest& AddAttributes(const char* key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline SetEndpointAttributesRequest& AddAttributes(Aws::String&& key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

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.

*/ inline SetEndpointAttributesRequest& AddAttributes(const char* key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } private: Aws::String m_endpointArn; bool m_endpointArnHasBeenSet = false; Aws::Map m_attributes; bool m_attributesHasBeenSet = false; }; } // namespace Model } // namespace SNS } // namespace Aws