« blib/lib/Paws/CognitoSync/RecordPatch.pm
↑ Summary
blib/lib/Paws/CognitoSync/RegisterDeviceResponse.pm »
| 1 | |||
| 2 | package Paws::CognitoSync::RegisterDevice; | ||
| 3 | use Moose; | ||
| 4 | has IdentityId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'IdentityId', required => 1); | ||
| 5 | has IdentityPoolId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'IdentityPoolId', required => 1); | ||
| 6 | has Platform => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Token => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterDevice'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/identitypools/{IdentityPoolId}/identity/{IdentityId}/device'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoSync::RegisterDeviceResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CognitoSync::RegisterDevice - Arguments for method RegisterDevice on L<Paws::CognitoSync> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method RegisterDevice on the | ||
| 26 | L<Amazon Cognito Sync|Paws::CognitoSync> service. Use the attributes of this class | ||
| 27 | as arguments to method RegisterDevice. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterDevice. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $cognito-sync = Paws->service('CognitoSync'); | ||
| 34 | my $RegisterDeviceResponse = $cognito -sync->RegisterDevice( | ||
| 35 | IdentityId => 'MyIdentityId', | ||
| 36 | IdentityPoolId => 'MyIdentityPoolId', | ||
| 37 | Platform => 'APNS', | ||
| 38 | Token => 'MyPushToken', | ||
| 39 | |||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $DeviceId = $RegisterDeviceResponse->DeviceId; | ||
| 44 | |||
| 45 | # Returns a L<Paws::CognitoSync::RegisterDeviceResponse> object. | ||
| 46 | |||
| 47 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cognito-sync/RegisterDevice> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> IdentityId => Str | ||
| 54 | |||
| 55 | The unique ID for this identity. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> IdentityPoolId => Str | ||
| 60 | |||
| 61 | A name-spaced GUID (for example, | ||
| 62 | us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon | ||
| 63 | Cognito. Here, the ID of the pool that the identity belongs to. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> Platform => Str | ||
| 68 | |||
| 69 | The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX). | ||
| 70 | |||
| 71 | Valid values are: C<"APNS">, C<"APNS_SANDBOX">, C<"GCM">, C<"ADM"> | ||
| 72 | |||
| 73 | =head2 B<REQUIRED> Token => Str | ||
| 74 | |||
| 75 | The push token. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method RegisterDevice in L<Paws::CognitoSync> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |