« blib/lib/Paws/CognitoSync/UnsubscribeFromDatasetResponse.pm
↑ Summary
blib/lib/Paws/CognitoSync/UpdateRecordsResponse.pm »
| 1 | |||
| 2 | package Paws::CognitoSync::UpdateRecords; | ||
| 3 | use Moose; | ||
| 4 | has ClientContext => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-Client-Context'); | ||
| 5 | has DatasetName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DatasetName', required => 1); | ||
| 6 | has DeviceId => (is => 'ro', isa => 'Str'); | ||
| 7 | has IdentityId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'IdentityId', required => 1); | ||
| 8 | has IdentityPoolId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'IdentityPoolId', required => 1); | ||
| 9 | has RecordPatches => (is => 'ro', isa => 'ArrayRef[Paws::CognitoSync::RecordPatch]'); | ||
| 10 | has SyncSessionToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateRecords'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoSync::UpdateRecordsResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::CognitoSync::UpdateRecords - Arguments for method UpdateRecords on L<Paws::CognitoSync> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method UpdateRecords on the | ||
| 29 | L<Amazon Cognito Sync|Paws::CognitoSync> service. Use the attributes of this class | ||
| 30 | as arguments to method UpdateRecords. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateRecords. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $cognito-sync = Paws->service('CognitoSync'); | ||
| 37 | my $UpdateRecordsResponse = $cognito -sync->UpdateRecords( | ||
| 38 | DatasetName => 'MyDatasetName', | ||
| 39 | IdentityId => 'MyIdentityId', | ||
| 40 | IdentityPoolId => 'MyIdentityPoolId', | ||
| 41 | SyncSessionToken => 'MySyncSessionToken', | ||
| 42 | ClientContext => 'MyClientContext', # OPTIONAL | ||
| 43 | DeviceId => 'MyDeviceId', # OPTIONAL | ||
| 44 | RecordPatches => [ | ||
| 45 | { | ||
| 46 | Key => 'MyRecordKey', # min: 1, max: 1024 | ||
| 47 | Op => 'replace', # values: replace, remove | ||
| 48 | SyncCount => 1, | ||
| 49 | DeviceLastModifiedDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 50 | Value => 'MyRecordValue', # max: 1048575; OPTIONAL | ||
| 51 | }, | ||
| 52 | ... | ||
| 53 | ], # OPTIONAL | ||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $Records = $UpdateRecordsResponse->Records; | ||
| 58 | |||
| 59 | # Returns a L<Paws::CognitoSync::UpdateRecordsResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cognito-sync/UpdateRecords> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 ClientContext => Str | ||
| 68 | |||
| 69 | Intended to supply a device ID that will populate the lastModifiedBy | ||
| 70 | field referenced in other methods. The ClientContext field is not yet | ||
| 71 | implemented. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> DatasetName => Str | ||
| 76 | |||
| 77 | A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, | ||
| 78 | '_' (underscore), '-' (dash), and '.' (dot). | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 DeviceId => Str | ||
| 83 | |||
| 84 | The unique ID generated for this device by Cognito. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> IdentityId => Str | ||
| 89 | |||
| 90 | A name-spaced GUID (for example, | ||
| 91 | us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon | ||
| 92 | Cognito. GUID generation is unique within a region. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> IdentityPoolId => Str | ||
| 97 | |||
| 98 | A name-spaced GUID (for example, | ||
| 99 | us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon | ||
| 100 | Cognito. GUID generation is unique within a region. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 RecordPatches => ArrayRef[L<Paws::CognitoSync::RecordPatch>] | ||
| 105 | |||
| 106 | A list of patch operations. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> SyncSessionToken => Str | ||
| 111 | |||
| 112 | The SyncSessionToken returned by a previous call to ListRecords for | ||
| 113 | this dataset and identity. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method UpdateRecords in L<Paws::CognitoSync> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |