« blib/lib/Paws/CognitoSync/SetIdentityPoolConfigurationResponse.pm
↑ Summary
blib/lib/Paws/CognitoSync/SubscribeToDatasetResponse.pm »
| 1 | |||
| 2 | package Paws::CognitoSync::SubscribeToDataset; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CognitoSync::SubscribeToDataset - Arguments for method SubscribeToDataset on L<Paws::CognitoSync> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method SubscribeToDataset on the | ||
| 26 | L<Amazon Cognito Sync|Paws::CognitoSync> service. Use the attributes of this class | ||
| 27 | as arguments to method SubscribeToDataset. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SubscribeToDataset. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $cognito-sync = Paws->service('CognitoSync'); | ||
| 34 | my $SubscribeToDatasetResponse = $cognito -sync->SubscribeToDataset( | ||
| 35 | DatasetName => 'MyDatasetName', | ||
| 36 | DeviceId => 'MyDeviceId', | ||
| 37 | IdentityId => 'MyIdentityId', | ||
| 38 | IdentityPoolId => 'MyIdentityPoolId', | ||
| 39 | |||
| 40 | ); | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cognito-sync/SubscribeToDataset> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> DatasetName => Str | ||
| 49 | |||
| 50 | The name of the dataset to subcribe to. | ||
| 51 | |||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> DeviceId => Str | ||
| 55 | |||
| 56 | The unique ID generated for this device by Cognito. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> IdentityId => Str | ||
| 61 | |||
| 62 | Unique ID for this identity. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> IdentityPoolId => Str | ||
| 67 | |||
| 68 | A name-spaced GUID (for example, | ||
| 69 | us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon | ||
| 70 | Cognito. The ID of the pool to which the identity belongs. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, documenting arguments for method SubscribeToDataset in L<Paws::CognitoSync> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |