File Coverage

blib/lib/Paws/CognitoSync/SubscribeToDataset.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CognitoSync::SubscribeToDataset;
3 1     1   588 use Moose;
  1         3  
  1         7  
4             has DatasetName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DatasetName' , required => 1);
5             has DeviceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DeviceId' , required => 1);
6             has IdentityId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'IdentityId' , required => 1);
7             has IdentityPoolId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'IdentityPoolId' , required => 1);
8              
9 1     1   8818 use MooseX::ClassAttribute;
  1         4  
  1         13  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'SubscribeToDataset');
12             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}');
13             class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoSync::SubscribeToDatasetResponse');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::CognitoSync::SubscribeToDataset - Arguments for method SubscribeToDataset on Paws::CognitoSync
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method SubscribeToDataset on the
27             Amazon Cognito Sync service. Use the attributes of this class
28             as arguments to method SubscribeToDataset.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SubscribeToDataset.
31              
32             As an example:
33              
34             $service_obj->SubscribeToDataset(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 B<REQUIRED> DatasetName => Str
42              
43             The name of the dataset to subcribe to.
44              
45              
46              
47             =head2 B<REQUIRED> DeviceId => Str
48              
49             The unique ID generated for this device by Cognito.
50              
51              
52              
53             =head2 B<REQUIRED> IdentityId => Str
54              
55             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. The ID of the pool to which the identity belongs.
64              
65              
66              
67              
68             =head1 SEE ALSO
69              
70             This class forms part of L<Paws>, documenting arguments for method SubscribeToDataset in L<Paws::CognitoSync>
71              
72             =head1 BUGS and CONTRIBUTIONS
73              
74             The source code is located here: https://github.com/pplu/aws-sdk-perl
75              
76             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
77              
78             =cut
79