123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794 |
- // THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
- // Package cognitosync provides a client for Amazon Cognito Sync.
- package cognitosync
- import (
- "time"
- "github.com/aws/aws-sdk-go/aws/awsutil"
- "github.com/aws/aws-sdk-go/aws/request"
- )
- const opBulkPublish = "BulkPublish"
- // BulkPublishRequest generates a request for the BulkPublish operation.
- func (c *CognitoSync) BulkPublishRequest(input *BulkPublishInput) (req *request.Request, output *BulkPublishOutput) {
- op := &request.Operation{
- Name: opBulkPublish,
- HTTPMethod: "POST",
- HTTPPath: "/identitypools/{IdentityPoolId}/bulkpublish",
- }
- if input == nil {
- input = &BulkPublishInput{}
- }
- req = c.newRequest(op, input, output)
- output = &BulkPublishOutput{}
- req.Data = output
- return
- }
- // Initiates a bulk publish of all existing datasets for an Identity Pool to
- // the configured stream. Customers are limited to one successful bulk publish
- // per 24 hours. Bulk publish is an asynchronous request, customers can see
- // the status of the request via the GetBulkPublishDetails operation.
- //
- // This API can only be called with developer credentials. You cannot call
- // this API with the temporary user credentials provided by Cognito Identity.
- func (c *CognitoSync) BulkPublish(input *BulkPublishInput) (*BulkPublishOutput, error) {
- req, out := c.BulkPublishRequest(input)
- err := req.Send()
- return out, err
- }
- const opDeleteDataset = "DeleteDataset"
- // DeleteDatasetRequest generates a request for the DeleteDataset operation.
- func (c *CognitoSync) DeleteDatasetRequest(input *DeleteDatasetInput) (req *request.Request, output *DeleteDatasetOutput) {
- op := &request.Operation{
- Name: opDeleteDataset,
- HTTPMethod: "DELETE",
- HTTPPath: "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
- }
- if input == nil {
- input = &DeleteDatasetInput{}
- }
- req = c.newRequest(op, input, output)
- output = &DeleteDatasetOutput{}
- req.Data = output
- return
- }
- // Deletes the specific dataset. The dataset will be deleted permanently, and
- // the action can't be undone. Datasets that this dataset was merged with will
- // no longer report the merge. Any subsequent operation on this dataset will
- // result in a ResourceNotFoundException.
- //
- // This API can be called with temporary user credentials provided by Cognito
- // Identity or with developer credentials.
- func (c *CognitoSync) DeleteDataset(input *DeleteDatasetInput) (*DeleteDatasetOutput, error) {
- req, out := c.DeleteDatasetRequest(input)
- err := req.Send()
- return out, err
- }
- const opDescribeDataset = "DescribeDataset"
- // DescribeDatasetRequest generates a request for the DescribeDataset operation.
- func (c *CognitoSync) DescribeDatasetRequest(input *DescribeDatasetInput) (req *request.Request, output *DescribeDatasetOutput) {
- op := &request.Operation{
- Name: opDescribeDataset,
- HTTPMethod: "GET",
- HTTPPath: "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
- }
- if input == nil {
- input = &DescribeDatasetInput{}
- }
- req = c.newRequest(op, input, output)
- output = &DescribeDatasetOutput{}
- req.Data = output
- return
- }
- // Gets meta data about a dataset by identity and dataset name. With Amazon
- // Cognito Sync, each identity has access only to its own data. Thus, the credentials
- // used to make this API call need to have access to the identity data.
- //
- // This API can be called with temporary user credentials provided by Cognito
- // Identity or with developer credentials. You should use Cognito Identity credentials
- // to make this API call.
- func (c *CognitoSync) DescribeDataset(input *DescribeDatasetInput) (*DescribeDatasetOutput, error) {
- req, out := c.DescribeDatasetRequest(input)
- err := req.Send()
- return out, err
- }
- const opDescribeIdentityPoolUsage = "DescribeIdentityPoolUsage"
- // DescribeIdentityPoolUsageRequest generates a request for the DescribeIdentityPoolUsage operation.
- func (c *CognitoSync) DescribeIdentityPoolUsageRequest(input *DescribeIdentityPoolUsageInput) (req *request.Request, output *DescribeIdentityPoolUsageOutput) {
- op := &request.Operation{
- Name: opDescribeIdentityPoolUsage,
- HTTPMethod: "GET",
- HTTPPath: "/identitypools/{IdentityPoolId}",
- }
- if input == nil {
- input = &DescribeIdentityPoolUsageInput{}
- }
- req = c.newRequest(op, input, output)
- output = &DescribeIdentityPoolUsageOutput{}
- req.Data = output
- return
- }
- // Gets usage details (for example, data storage) about a particular identity
- // pool.
- //
- // This API can only be called with developer credentials. You cannot call
- // this API with the temporary user credentials provided by Cognito Identity.
- func (c *CognitoSync) DescribeIdentityPoolUsage(input *DescribeIdentityPoolUsageInput) (*DescribeIdentityPoolUsageOutput, error) {
- req, out := c.DescribeIdentityPoolUsageRequest(input)
- err := req.Send()
- return out, err
- }
- const opDescribeIdentityUsage = "DescribeIdentityUsage"
- // DescribeIdentityUsageRequest generates a request for the DescribeIdentityUsage operation.
- func (c *CognitoSync) DescribeIdentityUsageRequest(input *DescribeIdentityUsageInput) (req *request.Request, output *DescribeIdentityUsageOutput) {
- op := &request.Operation{
- Name: opDescribeIdentityUsage,
- HTTPMethod: "GET",
- HTTPPath: "/identitypools/{IdentityPoolId}/identities/{IdentityId}",
- }
- if input == nil {
- input = &DescribeIdentityUsageInput{}
- }
- req = c.newRequest(op, input, output)
- output = &DescribeIdentityUsageOutput{}
- req.Data = output
- return
- }
- // Gets usage information for an identity, including number of datasets and
- // data usage.
- //
- // This API can be called with temporary user credentials provided by Cognito
- // Identity or with developer credentials.
- func (c *CognitoSync) DescribeIdentityUsage(input *DescribeIdentityUsageInput) (*DescribeIdentityUsageOutput, error) {
- req, out := c.DescribeIdentityUsageRequest(input)
- err := req.Send()
- return out, err
- }
- const opGetBulkPublishDetails = "GetBulkPublishDetails"
- // GetBulkPublishDetailsRequest generates a request for the GetBulkPublishDetails operation.
- func (c *CognitoSync) GetBulkPublishDetailsRequest(input *GetBulkPublishDetailsInput) (req *request.Request, output *GetBulkPublishDetailsOutput) {
- op := &request.Operation{
- Name: opGetBulkPublishDetails,
- HTTPMethod: "POST",
- HTTPPath: "/identitypools/{IdentityPoolId}/getBulkPublishDetails",
- }
- if input == nil {
- input = &GetBulkPublishDetailsInput{}
- }
- req = c.newRequest(op, input, output)
- output = &GetBulkPublishDetailsOutput{}
- req.Data = output
- return
- }
- // Get the status of the last BulkPublish operation for an identity pool.
- //
- // This API can only be called with developer credentials. You cannot call
- // this API with the temporary user credentials provided by Cognito Identity.
- func (c *CognitoSync) GetBulkPublishDetails(input *GetBulkPublishDetailsInput) (*GetBulkPublishDetailsOutput, error) {
- req, out := c.GetBulkPublishDetailsRequest(input)
- err := req.Send()
- return out, err
- }
- const opGetCognitoEvents = "GetCognitoEvents"
- // GetCognitoEventsRequest generates a request for the GetCognitoEvents operation.
- func (c *CognitoSync) GetCognitoEventsRequest(input *GetCognitoEventsInput) (req *request.Request, output *GetCognitoEventsOutput) {
- op := &request.Operation{
- Name: opGetCognitoEvents,
- HTTPMethod: "GET",
- HTTPPath: "/identitypools/{IdentityPoolId}/events",
- }
- if input == nil {
- input = &GetCognitoEventsInput{}
- }
- req = c.newRequest(op, input, output)
- output = &GetCognitoEventsOutput{}
- req.Data = output
- return
- }
- // Gets the events and the corresponding Lambda functions associated with an
- // identity pool.
- //
- // This API can only be called with developer credentials. You cannot call
- // this API with the temporary user credentials provided by Cognito Identity.
- func (c *CognitoSync) GetCognitoEvents(input *GetCognitoEventsInput) (*GetCognitoEventsOutput, error) {
- req, out := c.GetCognitoEventsRequest(input)
- err := req.Send()
- return out, err
- }
- const opGetIdentityPoolConfiguration = "GetIdentityPoolConfiguration"
- // GetIdentityPoolConfigurationRequest generates a request for the GetIdentityPoolConfiguration operation.
- func (c *CognitoSync) GetIdentityPoolConfigurationRequest(input *GetIdentityPoolConfigurationInput) (req *request.Request, output *GetIdentityPoolConfigurationOutput) {
- op := &request.Operation{
- Name: opGetIdentityPoolConfiguration,
- HTTPMethod: "GET",
- HTTPPath: "/identitypools/{IdentityPoolId}/configuration",
- }
- if input == nil {
- input = &GetIdentityPoolConfigurationInput{}
- }
- req = c.newRequest(op, input, output)
- output = &GetIdentityPoolConfigurationOutput{}
- req.Data = output
- return
- }
- // Gets the configuration settings of an identity pool.
- //
- // This API can only be called with developer credentials. You cannot call
- // this API with the temporary user credentials provided by Cognito Identity.
- func (c *CognitoSync) GetIdentityPoolConfiguration(input *GetIdentityPoolConfigurationInput) (*GetIdentityPoolConfigurationOutput, error) {
- req, out := c.GetIdentityPoolConfigurationRequest(input)
- err := req.Send()
- return out, err
- }
- const opListDatasets = "ListDatasets"
- // ListDatasetsRequest generates a request for the ListDatasets operation.
- func (c *CognitoSync) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput) {
- op := &request.Operation{
- Name: opListDatasets,
- HTTPMethod: "GET",
- HTTPPath: "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets",
- }
- if input == nil {
- input = &ListDatasetsInput{}
- }
- req = c.newRequest(op, input, output)
- output = &ListDatasetsOutput{}
- req.Data = output
- return
- }
- // Lists datasets for an identity. With Amazon Cognito Sync, each identity has
- // access only to its own data. Thus, the credentials used to make this API
- // call need to have access to the identity data.
- //
- // ListDatasets can be called with temporary user credentials provided by Cognito
- // Identity or with developer credentials. You should use the Cognito Identity
- // credentials to make this API call.
- func (c *CognitoSync) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error) {
- req, out := c.ListDatasetsRequest(input)
- err := req.Send()
- return out, err
- }
- const opListIdentityPoolUsage = "ListIdentityPoolUsage"
- // ListIdentityPoolUsageRequest generates a request for the ListIdentityPoolUsage operation.
- func (c *CognitoSync) ListIdentityPoolUsageRequest(input *ListIdentityPoolUsageInput) (req *request.Request, output *ListIdentityPoolUsageOutput) {
- op := &request.Operation{
- Name: opListIdentityPoolUsage,
- HTTPMethod: "GET",
- HTTPPath: "/identitypools",
- }
- if input == nil {
- input = &ListIdentityPoolUsageInput{}
- }
- req = c.newRequest(op, input, output)
- output = &ListIdentityPoolUsageOutput{}
- req.Data = output
- return
- }
- // Gets a list of identity pools registered with Cognito.
- //
- // ListIdentityPoolUsage can only be called with developer credentials. You
- // cannot make this API call with the temporary user credentials provided by
- // Cognito Identity.
- func (c *CognitoSync) ListIdentityPoolUsage(input *ListIdentityPoolUsageInput) (*ListIdentityPoolUsageOutput, error) {
- req, out := c.ListIdentityPoolUsageRequest(input)
- err := req.Send()
- return out, err
- }
- const opListRecords = "ListRecords"
- // ListRecordsRequest generates a request for the ListRecords operation.
- func (c *CognitoSync) ListRecordsRequest(input *ListRecordsInput) (req *request.Request, output *ListRecordsOutput) {
- op := &request.Operation{
- Name: opListRecords,
- HTTPMethod: "GET",
- HTTPPath: "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records",
- }
- if input == nil {
- input = &ListRecordsInput{}
- }
- req = c.newRequest(op, input, output)
- output = &ListRecordsOutput{}
- req.Data = output
- return
- }
- // Gets paginated records, optionally changed after a particular sync count
- // for a dataset and identity. With Amazon Cognito Sync, each identity has access
- // only to its own data. Thus, the credentials used to make this API call need
- // to have access to the identity data.
- //
- // ListRecords can be called with temporary user credentials provided by Cognito
- // Identity or with developer credentials. You should use Cognito Identity credentials
- // to make this API call.
- func (c *CognitoSync) ListRecords(input *ListRecordsInput) (*ListRecordsOutput, error) {
- req, out := c.ListRecordsRequest(input)
- err := req.Send()
- return out, err
- }
- const opRegisterDevice = "RegisterDevice"
- // RegisterDeviceRequest generates a request for the RegisterDevice operation.
- func (c *CognitoSync) RegisterDeviceRequest(input *RegisterDeviceInput) (req *request.Request, output *RegisterDeviceOutput) {
- op := &request.Operation{
- Name: opRegisterDevice,
- HTTPMethod: "POST",
- HTTPPath: "/identitypools/{IdentityPoolId}/identity/{IdentityId}/device",
- }
- if input == nil {
- input = &RegisterDeviceInput{}
- }
- req = c.newRequest(op, input, output)
- output = &RegisterDeviceOutput{}
- req.Data = output
- return
- }
- // Registers a device to receive push sync notifications.
- //
- // This API can only be called with temporary credentials provided by Cognito
- // Identity. You cannot call this API with developer credentials.
- func (c *CognitoSync) RegisterDevice(input *RegisterDeviceInput) (*RegisterDeviceOutput, error) {
- req, out := c.RegisterDeviceRequest(input)
- err := req.Send()
- return out, err
- }
- const opSetCognitoEvents = "SetCognitoEvents"
- // SetCognitoEventsRequest generates a request for the SetCognitoEvents operation.
- func (c *CognitoSync) SetCognitoEventsRequest(input *SetCognitoEventsInput) (req *request.Request, output *SetCognitoEventsOutput) {
- op := &request.Operation{
- Name: opSetCognitoEvents,
- HTTPMethod: "POST",
- HTTPPath: "/identitypools/{IdentityPoolId}/events",
- }
- if input == nil {
- input = &SetCognitoEventsInput{}
- }
- req = c.newRequest(op, input, output)
- output = &SetCognitoEventsOutput{}
- req.Data = output
- return
- }
- // Sets the AWS Lambda function for a given event type for an identity pool.
- // This request only updates the key/value pair specified. Other key/values
- // pairs are not updated. To remove a key value pair, pass a empty value for
- // the particular key.
- //
- // This API can only be called with developer credentials. You cannot call
- // this API with the temporary user credentials provided by Cognito Identity.
- func (c *CognitoSync) SetCognitoEvents(input *SetCognitoEventsInput) (*SetCognitoEventsOutput, error) {
- req, out := c.SetCognitoEventsRequest(input)
- err := req.Send()
- return out, err
- }
- const opSetIdentityPoolConfiguration = "SetIdentityPoolConfiguration"
- // SetIdentityPoolConfigurationRequest generates a request for the SetIdentityPoolConfiguration operation.
- func (c *CognitoSync) SetIdentityPoolConfigurationRequest(input *SetIdentityPoolConfigurationInput) (req *request.Request, output *SetIdentityPoolConfigurationOutput) {
- op := &request.Operation{
- Name: opSetIdentityPoolConfiguration,
- HTTPMethod: "POST",
- HTTPPath: "/identitypools/{IdentityPoolId}/configuration",
- }
- if input == nil {
- input = &SetIdentityPoolConfigurationInput{}
- }
- req = c.newRequest(op, input, output)
- output = &SetIdentityPoolConfigurationOutput{}
- req.Data = output
- return
- }
- // Sets the necessary configuration for push sync.
- //
- // This API can only be called with developer credentials. You cannot call
- // this API with the temporary user credentials provided by Cognito Identity.
- func (c *CognitoSync) SetIdentityPoolConfiguration(input *SetIdentityPoolConfigurationInput) (*SetIdentityPoolConfigurationOutput, error) {
- req, out := c.SetIdentityPoolConfigurationRequest(input)
- err := req.Send()
- return out, err
- }
- const opSubscribeToDataset = "SubscribeToDataset"
- // SubscribeToDatasetRequest generates a request for the SubscribeToDataset operation.
- func (c *CognitoSync) SubscribeToDatasetRequest(input *SubscribeToDatasetInput) (req *request.Request, output *SubscribeToDatasetOutput) {
- op := &request.Operation{
- Name: opSubscribeToDataset,
- HTTPMethod: "POST",
- HTTPPath: "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}",
- }
- if input == nil {
- input = &SubscribeToDatasetInput{}
- }
- req = c.newRequest(op, input, output)
- output = &SubscribeToDatasetOutput{}
- req.Data = output
- return
- }
- // Subscribes to receive notifications when a dataset is modified by another
- // device.
- //
- // This API can only be called with temporary credentials provided by Cognito
- // Identity. You cannot call this API with developer credentials.
- func (c *CognitoSync) SubscribeToDataset(input *SubscribeToDatasetInput) (*SubscribeToDatasetOutput, error) {
- req, out := c.SubscribeToDatasetRequest(input)
- err := req.Send()
- return out, err
- }
- const opUnsubscribeFromDataset = "UnsubscribeFromDataset"
- // UnsubscribeFromDatasetRequest generates a request for the UnsubscribeFromDataset operation.
- func (c *CognitoSync) UnsubscribeFromDatasetRequest(input *UnsubscribeFromDatasetInput) (req *request.Request, output *UnsubscribeFromDatasetOutput) {
- op := &request.Operation{
- Name: opUnsubscribeFromDataset,
- HTTPMethod: "DELETE",
- HTTPPath: "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}",
- }
- if input == nil {
- input = &UnsubscribeFromDatasetInput{}
- }
- req = c.newRequest(op, input, output)
- output = &UnsubscribeFromDatasetOutput{}
- req.Data = output
- return
- }
- // Unsubscribes from receiving notifications when a dataset is modified by another
- // device.
- //
- // This API can only be called with temporary credentials provided by Cognito
- // Identity. You cannot call this API with developer credentials.
- func (c *CognitoSync) UnsubscribeFromDataset(input *UnsubscribeFromDatasetInput) (*UnsubscribeFromDatasetOutput, error) {
- req, out := c.UnsubscribeFromDatasetRequest(input)
- err := req.Send()
- return out, err
- }
- const opUpdateRecords = "UpdateRecords"
- // UpdateRecordsRequest generates a request for the UpdateRecords operation.
- func (c *CognitoSync) UpdateRecordsRequest(input *UpdateRecordsInput) (req *request.Request, output *UpdateRecordsOutput) {
- op := &request.Operation{
- Name: opUpdateRecords,
- HTTPMethod: "POST",
- HTTPPath: "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
- }
- if input == nil {
- input = &UpdateRecordsInput{}
- }
- req = c.newRequest(op, input, output)
- output = &UpdateRecordsOutput{}
- req.Data = output
- return
- }
- // Posts updates to records and adds and deletes records for a dataset and user.
- //
- // The sync count in the record patch is your last known sync count for that
- // record. The server will reject an UpdateRecords request with a ResourceConflictException
- // if you try to patch a record with a new value but a stale sync count.
- //
- // For example, if the sync count on the server is 5 for a key called highScore
- // and you try and submit a new highScore with sync count of 4, the request
- // will be rejected. To obtain the current sync count for a record, call ListRecords.
- // On a successful update of the record, the response returns the new sync count
- // for that record. You should present that sync count the next time you try
- // to update that same record. When the record does not exist, specify the sync
- // count as 0.
- //
- // This API can be called with temporary user credentials provided by Cognito
- // Identity or with developer credentials.
- func (c *CognitoSync) UpdateRecords(input *UpdateRecordsInput) (*UpdateRecordsOutput, error) {
- req, out := c.UpdateRecordsRequest(input)
- err := req.Send()
- return out, err
- }
- // The input for the BulkPublish operation.
- type BulkPublishInput struct {
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataBulkPublishInput `json:"-" xml:"-"`
- }
- type metadataBulkPublishInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s BulkPublishInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s BulkPublishInput) GoString() string {
- return s.String()
- }
- // The output for the BulkPublish operation.
- type BulkPublishOutput struct {
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `type:"string"`
- metadataBulkPublishOutput `json:"-" xml:"-"`
- }
- type metadataBulkPublishOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s BulkPublishOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s BulkPublishOutput) GoString() string {
- return s.String()
- }
- // Configuration options for configure Cognito streams.
- type CognitoStreams struct {
- // The ARN of the role Amazon Cognito can assume in order to publish to the
- // stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke
- // PutRecord on your Cognito stream.
- RoleArn *string `type:"string"`
- // The name of the Cognito stream to receive updates. This stream must be in
- // the developers account and in the same region as the identity pool.
- StreamName *string `type:"string"`
- // Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates
- // to identity pool is enabled.
- //
- // DISABLED - Streaming of updates to identity pool is disabled. Bulk publish
- // will also fail if StreamingStatus is DISABLED.
- StreamingStatus *string `type:"string" enum:"StreamingStatus"`
- metadataCognitoStreams `json:"-" xml:"-"`
- }
- type metadataCognitoStreams struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s CognitoStreams) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s CognitoStreams) GoString() string {
- return s.String()
- }
- // A collection of data for an identity pool. An identity pool can have multiple
- // datasets. A dataset is per identity and can be general or associated with
- // a particular entity in an application (like a saved game). Datasets are automatically
- // created if they don't exist. Data is synced by dataset, and a dataset can
- // hold up to 1MB of key-value pairs.
- type Dataset struct {
- // Date on which the dataset was created.
- CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"`
- // Total size in bytes of the records in this dataset.
- DataStorage *int64 `type:"long"`
- // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
- // (underscore), '-' (dash), and '.' (dot).
- DatasetName *string `type:"string"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityId *string `type:"string"`
- // The device that made the last change to this dataset.
- LastModifiedBy *string `type:"string"`
- // Date when the dataset was last modified.
- LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
- // Number of records in this dataset.
- NumRecords *int64 `type:"long"`
- metadataDataset `json:"-" xml:"-"`
- }
- type metadataDataset struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s Dataset) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s Dataset) GoString() string {
- return s.String()
- }
- // A request to delete the specific dataset.
- type DeleteDatasetInput struct {
- // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
- // (underscore), '-' (dash), and '.' (dot).
- DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataDeleteDatasetInput `json:"-" xml:"-"`
- }
- type metadataDeleteDatasetInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s DeleteDatasetInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DeleteDatasetInput) GoString() string {
- return s.String()
- }
- // Response to a successful DeleteDataset request.
- type DeleteDatasetOutput struct {
- // A collection of data for an identity pool. An identity pool can have multiple
- // datasets. A dataset is per identity and can be general or associated with
- // a particular entity in an application (like a saved game). Datasets are automatically
- // created if they don't exist. Data is synced by dataset, and a dataset can
- // hold up to 1MB of key-value pairs.
- Dataset *Dataset `type:"structure"`
- metadataDeleteDatasetOutput `json:"-" xml:"-"`
- }
- type metadataDeleteDatasetOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s DeleteDatasetOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DeleteDatasetOutput) GoString() string {
- return s.String()
- }
- // A request for meta data about a dataset (creation date, number of records,
- // size) by owner and dataset name.
- type DescribeDatasetInput struct {
- // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
- // (underscore), '-' (dash), and '.' (dot).
- DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataDescribeDatasetInput `json:"-" xml:"-"`
- }
- type metadataDescribeDatasetInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s DescribeDatasetInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeDatasetInput) GoString() string {
- return s.String()
- }
- // Response to a successful DescribeDataset request.
- type DescribeDatasetOutput struct {
- // Meta data for a collection of data for an identity. An identity can have
- // multiple datasets. A dataset can be general or associated with a particular
- // entity in an application (like a saved game). Datasets are automatically
- // created if they don't exist. Data is synced by dataset, and a dataset can
- // hold up to 1MB of key-value pairs.
- Dataset *Dataset `type:"structure"`
- metadataDescribeDatasetOutput `json:"-" xml:"-"`
- }
- type metadataDescribeDatasetOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s DescribeDatasetOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeDatasetOutput) GoString() string {
- return s.String()
- }
- // A request for usage information about the identity pool.
- type DescribeIdentityPoolUsageInput struct {
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataDescribeIdentityPoolUsageInput `json:"-" xml:"-"`
- }
- type metadataDescribeIdentityPoolUsageInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s DescribeIdentityPoolUsageInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeIdentityPoolUsageInput) GoString() string {
- return s.String()
- }
- // Response to a successful DescribeIdentityPoolUsage request.
- type DescribeIdentityPoolUsageOutput struct {
- // Information about the usage of the identity pool.
- IdentityPoolUsage *IdentityPoolUsage `type:"structure"`
- metadataDescribeIdentityPoolUsageOutput `json:"-" xml:"-"`
- }
- type metadataDescribeIdentityPoolUsageOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s DescribeIdentityPoolUsageOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeIdentityPoolUsageOutput) GoString() string {
- return s.String()
- }
- // A request for information about the usage of an identity pool.
- type DescribeIdentityUsageInput struct {
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataDescribeIdentityUsageInput `json:"-" xml:"-"`
- }
- type metadataDescribeIdentityUsageInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s DescribeIdentityUsageInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeIdentityUsageInput) GoString() string {
- return s.String()
- }
- // The response to a successful DescribeIdentityUsage request.
- type DescribeIdentityUsageOutput struct {
- // Usage information for the identity.
- IdentityUsage *IdentityUsage `type:"structure"`
- metadataDescribeIdentityUsageOutput `json:"-" xml:"-"`
- }
- type metadataDescribeIdentityUsageOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s DescribeIdentityUsageOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeIdentityUsageOutput) GoString() string {
- return s.String()
- }
- // The input for the GetBulkPublishDetails operation.
- type GetBulkPublishDetailsInput struct {
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataGetBulkPublishDetailsInput `json:"-" xml:"-"`
- }
- type metadataGetBulkPublishDetailsInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s GetBulkPublishDetailsInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s GetBulkPublishDetailsInput) GoString() string {
- return s.String()
- }
- // The output for the GetBulkPublishDetails operation.
- type GetBulkPublishDetailsOutput struct {
- // If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation
- // completed.
- BulkPublishCompleteTime *time.Time `type:"timestamp" timestampFormat:"unix"`
- // The date/time at which the last bulk publish was initiated.
- BulkPublishStartTime *time.Time `type:"timestamp" timestampFormat:"unix"`
- // Status of the last bulk publish operation, valid values are: NOT_STARTED
- // - No bulk publish has been requested for this identity pool
- //
- // IN_PROGRESS - Data is being published to the configured stream
- //
- // SUCCEEDED - All data for the identity pool has been published to the configured
- // stream
- //
- // FAILED - Some portion of the data has failed to publish, check FailureMessage
- // for the cause.
- BulkPublishStatus *string `type:"string" enum:"BulkPublishStatus"`
- // If BulkPublishStatus is FAILED this field will contain the error message
- // that caused the bulk publish to fail.
- FailureMessage *string `type:"string"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `type:"string"`
- metadataGetBulkPublishDetailsOutput `json:"-" xml:"-"`
- }
- type metadataGetBulkPublishDetailsOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s GetBulkPublishDetailsOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s GetBulkPublishDetailsOutput) GoString() string {
- return s.String()
- }
- // A request for a list of the configured Cognito Events
- type GetCognitoEventsInput struct {
- // The Cognito Identity Pool ID for the request
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataGetCognitoEventsInput `json:"-" xml:"-"`
- }
- type metadataGetCognitoEventsInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s GetCognitoEventsInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s GetCognitoEventsInput) GoString() string {
- return s.String()
- }
- // The response from the GetCognitoEvents request
- type GetCognitoEventsOutput struct {
- // The Cognito Events returned from the GetCognitoEvents request
- Events map[string]*string `type:"map"`
- metadataGetCognitoEventsOutput `json:"-" xml:"-"`
- }
- type metadataGetCognitoEventsOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s GetCognitoEventsOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s GetCognitoEventsOutput) GoString() string {
- return s.String()
- }
- // The input for the GetIdentityPoolConfiguration operation.
- type GetIdentityPoolConfigurationInput struct {
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. This is the ID of the pool for which to return
- // a configuration.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataGetIdentityPoolConfigurationInput `json:"-" xml:"-"`
- }
- type metadataGetIdentityPoolConfigurationInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s GetIdentityPoolConfigurationInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s GetIdentityPoolConfigurationInput) GoString() string {
- return s.String()
- }
- // The output for the GetIdentityPoolConfiguration operation.
- type GetIdentityPoolConfigurationOutput struct {
- // Options to apply to this identity pool for Amazon Cognito streams.
- CognitoStreams *CognitoStreams `type:"structure"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito.
- IdentityPoolId *string `type:"string"`
- // Options to apply to this identity pool for push synchronization.
- PushSync *PushSync `type:"structure"`
- metadataGetIdentityPoolConfigurationOutput `json:"-" xml:"-"`
- }
- type metadataGetIdentityPoolConfigurationOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s GetIdentityPoolConfigurationOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s GetIdentityPoolConfigurationOutput) GoString() string {
- return s.String()
- }
- // Usage information for the identity pool.
- type IdentityPoolUsage struct {
- // Data storage information for the identity pool.
- DataStorage *int64 `type:"long"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `type:"string"`
- // Date on which the identity pool was last modified.
- LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
- // Number of sync sessions for the identity pool.
- SyncSessionsCount *int64 `type:"long"`
- metadataIdentityPoolUsage `json:"-" xml:"-"`
- }
- type metadataIdentityPoolUsage struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s IdentityPoolUsage) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s IdentityPoolUsage) GoString() string {
- return s.String()
- }
- // Usage information for the identity.
- type IdentityUsage struct {
- // Total data storage for this identity.
- DataStorage *int64 `type:"long"`
- // Number of datasets for the identity.
- DatasetCount *int64 `type:"integer"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityId *string `type:"string"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `type:"string"`
- // Date on which the identity was last modified.
- LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
- metadataIdentityUsage `json:"-" xml:"-"`
- }
- type metadataIdentityUsage struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s IdentityUsage) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s IdentityUsage) GoString() string {
- return s.String()
- }
- // Request for a list of datasets for an identity.
- type ListDatasetsInput struct {
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- // The maximum number of results to be returned.
- MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`
- // A pagination token for obtaining the next page of results.
- NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
- metadataListDatasetsInput `json:"-" xml:"-"`
- }
- type metadataListDatasetsInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s ListDatasetsInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListDatasetsInput) GoString() string {
- return s.String()
- }
- // Returned for a successful ListDatasets request.
- type ListDatasetsOutput struct {
- // Number of datasets returned.
- Count *int64 `type:"integer"`
- // A set of datasets.
- Datasets []*Dataset `type:"list"`
- // A pagination token for obtaining the next page of results.
- NextToken *string `type:"string"`
- metadataListDatasetsOutput `json:"-" xml:"-"`
- }
- type metadataListDatasetsOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s ListDatasetsOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListDatasetsOutput) GoString() string {
- return s.String()
- }
- // A request for usage information on an identity pool.
- type ListIdentityPoolUsageInput struct {
- // The maximum number of results to be returned.
- MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`
- // A pagination token for obtaining the next page of results.
- NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
- metadataListIdentityPoolUsageInput `json:"-" xml:"-"`
- }
- type metadataListIdentityPoolUsageInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s ListIdentityPoolUsageInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListIdentityPoolUsageInput) GoString() string {
- return s.String()
- }
- // Returned for a successful ListIdentityPoolUsage request.
- type ListIdentityPoolUsageOutput struct {
- // Total number of identities for the identity pool.
- Count *int64 `type:"integer"`
- // Usage information for the identity pools.
- IdentityPoolUsages []*IdentityPoolUsage `type:"list"`
- // The maximum number of results to be returned.
- MaxResults *int64 `type:"integer"`
- // A pagination token for obtaining the next page of results.
- NextToken *string `type:"string"`
- metadataListIdentityPoolUsageOutput `json:"-" xml:"-"`
- }
- type metadataListIdentityPoolUsageOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s ListIdentityPoolUsageOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListIdentityPoolUsageOutput) GoString() string {
- return s.String()
- }
- // A request for a list of records.
- type ListRecordsInput struct {
- // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
- // (underscore), '-' (dash), and '.' (dot).
- DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- // The last server sync count for this record.
- LastSyncCount *int64 `location:"querystring" locationName:"lastSyncCount" type:"long"`
- // The maximum number of results to be returned.
- MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`
- // A pagination token for obtaining the next page of results.
- NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
- // A token containing a session ID, identity ID, and expiration.
- SyncSessionToken *string `location:"querystring" locationName:"syncSessionToken" type:"string"`
- metadataListRecordsInput `json:"-" xml:"-"`
- }
- type metadataListRecordsInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s ListRecordsInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListRecordsInput) GoString() string {
- return s.String()
- }
- // Returned for a successful ListRecordsRequest.
- type ListRecordsOutput struct {
- // Total number of records.
- Count *int64 `type:"integer"`
- // A boolean value specifying whether to delete the dataset locally.
- DatasetDeletedAfterRequestedSyncCount *bool `type:"boolean"`
- // Indicates whether the dataset exists.
- DatasetExists *bool `type:"boolean"`
- // Server sync count for this dataset.
- DatasetSyncCount *int64 `type:"long"`
- // The user/device that made the last change to this record.
- LastModifiedBy *string `type:"string"`
- // Names of merged datasets.
- MergedDatasetNames []*string `type:"list"`
- // A pagination token for obtaining the next page of results.
- NextToken *string `type:"string"`
- // A list of all records.
- Records []*Record `type:"list"`
- // A token containing a session ID, identity ID, and expiration.
- SyncSessionToken *string `type:"string"`
- metadataListRecordsOutput `json:"-" xml:"-"`
- }
- type metadataListRecordsOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s ListRecordsOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListRecordsOutput) GoString() string {
- return s.String()
- }
- // Configuration options to be applied to the identity pool.
- type PushSync struct {
- // List of SNS platform application ARNs that could be used by clients.
- ApplicationArns []*string `type:"list"`
- // A role configured to allow Cognito to call SNS on behalf of the developer.
- RoleArn *string `type:"string"`
- metadataPushSync `json:"-" xml:"-"`
- }
- type metadataPushSync struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s PushSync) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s PushSync) GoString() string {
- return s.String()
- }
- // The basic data structure of a dataset.
- type Record struct {
- // The last modified date of the client device.
- DeviceLastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
- // The key for the record.
- Key *string `type:"string"`
- // The user/device that made the last change to this record.
- LastModifiedBy *string `type:"string"`
- // The date on which the record was last modified.
- LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
- // The server sync count for this record.
- SyncCount *int64 `type:"long"`
- // The value for the record.
- Value *string `type:"string"`
- metadataRecord `json:"-" xml:"-"`
- }
- type metadataRecord struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s Record) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s Record) GoString() string {
- return s.String()
- }
- // An update operation for a record.
- type RecordPatch struct {
- // The last modified date of the client device.
- DeviceLastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
- // The key associated with the record patch.
- Key *string `type:"string" required:"true"`
- // An operation, either replace or remove.
- Op *string `type:"string" required:"true" enum:"Operation"`
- // Last known server sync count for this record. Set to 0 if unknown.
- SyncCount *int64 `type:"long" required:"true"`
- // The value associated with the record patch.
- Value *string `type:"string"`
- metadataRecordPatch `json:"-" xml:"-"`
- }
- type metadataRecordPatch struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s RecordPatch) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s RecordPatch) GoString() string {
- return s.String()
- }
- // A request to RegisterDevice.
- type RegisterDeviceInput struct {
- // The unique ID for this identity.
- IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
- // 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.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- // The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
- Platform *string `type:"string" required:"true" enum:"Platform"`
- // The push token.
- Token *string `type:"string" required:"true"`
- metadataRegisterDeviceInput `json:"-" xml:"-"`
- }
- type metadataRegisterDeviceInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s RegisterDeviceInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s RegisterDeviceInput) GoString() string {
- return s.String()
- }
- // Response to a RegisterDevice request.
- type RegisterDeviceOutput struct {
- // The unique ID generated for this device by Cognito.
- DeviceId *string `type:"string"`
- metadataRegisterDeviceOutput `json:"-" xml:"-"`
- }
- type metadataRegisterDeviceOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s RegisterDeviceOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s RegisterDeviceOutput) GoString() string {
- return s.String()
- }
- // A request to configure Cognito Events"
- //
- // "
- type SetCognitoEventsInput struct {
- // The events to configure
- Events map[string]*string `type:"map" required:"true"`
- // The Cognito Identity Pool to use when configuring Cognito Events
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataSetCognitoEventsInput `json:"-" xml:"-"`
- }
- type metadataSetCognitoEventsInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s SetCognitoEventsInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s SetCognitoEventsInput) GoString() string {
- return s.String()
- }
- type SetCognitoEventsOutput struct {
- metadataSetCognitoEventsOutput `json:"-" xml:"-"`
- }
- type metadataSetCognitoEventsOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s SetCognitoEventsOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s SetCognitoEventsOutput) GoString() string {
- return s.String()
- }
- // The input for the SetIdentityPoolConfiguration operation.
- type SetIdentityPoolConfigurationInput struct {
- // Options to apply to this identity pool for Amazon Cognito streams.
- CognitoStreams *CognitoStreams `type:"structure"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. This is the ID of the pool to modify.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- // Options to apply to this identity pool for push synchronization.
- PushSync *PushSync `type:"structure"`
- metadataSetIdentityPoolConfigurationInput `json:"-" xml:"-"`
- }
- type metadataSetIdentityPoolConfigurationInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s SetIdentityPoolConfigurationInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s SetIdentityPoolConfigurationInput) GoString() string {
- return s.String()
- }
- // The output for the SetIdentityPoolConfiguration operation
- type SetIdentityPoolConfigurationOutput struct {
- // Options to apply to this identity pool for Amazon Cognito streams.
- CognitoStreams *CognitoStreams `type:"structure"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito.
- IdentityPoolId *string `type:"string"`
- // Options to apply to this identity pool for push synchronization.
- PushSync *PushSync `type:"structure"`
- metadataSetIdentityPoolConfigurationOutput `json:"-" xml:"-"`
- }
- type metadataSetIdentityPoolConfigurationOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s SetIdentityPoolConfigurationOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s SetIdentityPoolConfigurationOutput) GoString() string {
- return s.String()
- }
- // A request to SubscribeToDatasetRequest.
- type SubscribeToDatasetInput struct {
- // The name of the dataset to subcribe to.
- DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
- // The unique ID generated for this device by Cognito.
- DeviceId *string `location:"uri" locationName:"DeviceId" type:"string" required:"true"`
- // Unique ID for this identity.
- IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. The ID of the pool to which the identity belongs.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataSubscribeToDatasetInput `json:"-" xml:"-"`
- }
- type metadataSubscribeToDatasetInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s SubscribeToDatasetInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s SubscribeToDatasetInput) GoString() string {
- return s.String()
- }
- // Response to a SubscribeToDataset request.
- type SubscribeToDatasetOutput struct {
- metadataSubscribeToDatasetOutput `json:"-" xml:"-"`
- }
- type metadataSubscribeToDatasetOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s SubscribeToDatasetOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s SubscribeToDatasetOutput) GoString() string {
- return s.String()
- }
- // A request to UnsubscribeFromDataset.
- type UnsubscribeFromDatasetInput struct {
- // The name of the dataset from which to unsubcribe.
- DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
- // The unique ID generated for this device by Cognito.
- DeviceId *string `location:"uri" locationName:"DeviceId" type:"string" required:"true"`
- // Unique ID for this identity.
- IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. The ID of the pool to which this identity belongs.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- metadataUnsubscribeFromDatasetInput `json:"-" xml:"-"`
- }
- type metadataUnsubscribeFromDatasetInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s UnsubscribeFromDatasetInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s UnsubscribeFromDatasetInput) GoString() string {
- return s.String()
- }
- // Response to an UnsubscribeFromDataset request.
- type UnsubscribeFromDatasetOutput struct {
- metadataUnsubscribeFromDatasetOutput `json:"-" xml:"-"`
- }
- type metadataUnsubscribeFromDatasetOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s UnsubscribeFromDatasetOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s UnsubscribeFromDatasetOutput) GoString() string {
- return s.String()
- }
- // A request to post updates to records or add and delete records for a dataset
- // and user.
- type UpdateRecordsInput struct {
- // Intended to supply a device ID that will populate the lastModifiedBy field
- // referenced in other methods. The ClientContext field is not yet implemented.
- ClientContext *string `location:"header" locationName:"x-amz-Client-Context" type:"string"`
- // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
- // (underscore), '-' (dash), and '.' (dot).
- DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
- // The unique ID generated for this device by Cognito.
- DeviceId *string `type:"string"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
- // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
- // created by Amazon Cognito. GUID generation is unique within a region.
- IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
- // A list of patch operations.
- RecordPatches []*RecordPatch `type:"list"`
- // The SyncSessionToken returned by a previous call to ListRecords for this
- // dataset and identity.
- SyncSessionToken *string `type:"string" required:"true"`
- metadataUpdateRecordsInput `json:"-" xml:"-"`
- }
- type metadataUpdateRecordsInput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s UpdateRecordsInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s UpdateRecordsInput) GoString() string {
- return s.String()
- }
- // Returned for a successful UpdateRecordsRequest.
- type UpdateRecordsOutput struct {
- // A list of records that have been updated.
- Records []*Record `type:"list"`
- metadataUpdateRecordsOutput `json:"-" xml:"-"`
- }
- type metadataUpdateRecordsOutput struct {
- SDKShapeTraits bool `type:"structure"`
- }
- // String returns the string representation
- func (s UpdateRecordsOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s UpdateRecordsOutput) GoString() string {
- return s.String()
- }
- const (
- // @enum BulkPublishStatus
- BulkPublishStatusNotStarted = "NOT_STARTED"
- // @enum BulkPublishStatus
- BulkPublishStatusInProgress = "IN_PROGRESS"
- // @enum BulkPublishStatus
- BulkPublishStatusFailed = "FAILED"
- // @enum BulkPublishStatus
- BulkPublishStatusSucceeded = "SUCCEEDED"
- )
- const (
- // @enum Operation
- OperationReplace = "replace"
- // @enum Operation
- OperationRemove = "remove"
- )
- const (
- // @enum Platform
- PlatformApns = "APNS"
- // @enum Platform
- PlatformApnsSandbox = "APNS_SANDBOX"
- // @enum Platform
- PlatformGcm = "GCM"
- // @enum Platform
- PlatformAdm = "ADM"
- )
- const (
- // @enum StreamingStatus
- StreamingStatusEnabled = "ENABLED"
- // @enum StreamingStatus
- StreamingStatusDisabled = "DISABLED"
- )
|