setEndpointAttributes method

Future<void> setEndpointAttributes({ required Map<String, String> attributes, required String endpointArn, })

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

May throw InvalidParameterException. May throw InternalErrorException. May throw AuthorizationErrorException. May throw NotFoundException.

Parameter 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.

Parameter endpointArn : EndpointArn used for SetEndpointAttributes action.

Implementation

Future<void> setEndpointAttributes({
  required Map<String, String> attributes,
  required String endpointArn,
}) async {
  ArgumentError.checkNotNull(attributes, 'attributes');
  ArgumentError.checkNotNull(endpointArn, 'endpointArn');
  final $request = <String, dynamic>{};
  $request['Attributes'] = attributes;
  $request['EndpointArn'] = endpointArn;
  await _protocol.send(
    $request,
    action: 'SetEndpointAttributes',
    version: '2010-03-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['SetEndpointAttributesInput'],
    shapes: shapes,
  );
}