AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginRegisterDevice and EndRegisterDevice.

Namespace: Amazon.CognitoSync
Assembly: AWSSDK.CognitoSync.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<RegisterDeviceResponse> RegisterDeviceAsync(
         RegisterDeviceRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CognitoSync.Model.RegisterDeviceRequest

Container for the necessary parameters to execute the RegisterDevice service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the RegisterDevice service method, as returned by CognitoSync.

Exceptions

ExceptionCondition
InternalErrorException Indicates an internal service error.
InvalidConfigurationException
InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
ResourceNotFoundException Thrown if the resource doesn't exist.
TooManyRequestsException Thrown if the request is throttled.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also