You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoSync::Types::RegisterDeviceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb

Overview

Note:

When making an API call, you may pass RegisterDeviceRequest data as a hash:

{
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  platform: "APNS", # required, accepts APNS, APNS_SANDBOX, GCM, ADM
  token: "PushToken", # required
}

A request to RegisterDevice.

Instance Attribute Summary collapse

Instance Attribute Details

#identity_idString

The unique ID for this identity.

Returns:

  • (String)


916
917
918
919
920
921
922
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 916

class RegisterDeviceRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :platform,
  :token)
  include Aws::Structure
end

#identity_pool_idString

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.

Returns:

  • (String)


916
917
918
919
920
921
922
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 916

class RegisterDeviceRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :platform,
  :token)
  include Aws::Structure
end

#platformString

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

Returns:

  • (String)


916
917
918
919
920
921
922
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 916

class RegisterDeviceRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :platform,
  :token)
  include Aws::Structure
end

#tokenString

The push token.

Returns:

  • (String)


916
917
918
919
920
921
922
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 916

class RegisterDeviceRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :platform,
  :token)
  include Aws::Structure
end