doc.go 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
  2. // Package cognitosync provides the client and types for making API
  3. // requests to Amazon Cognito Sync.
  4. //
  5. // Amazon Cognito Sync provides an AWS service and client library that enable
  6. // cross-device syncing of application-related user data. High-level client
  7. // libraries are available for both iOS and Android. You can use these libraries
  8. // to persist data locally so that it's available even if the device is offline.
  9. // Developer credentials don't need to be stored on the mobile device to access
  10. // the service. You can use Amazon Cognito to obtain a normalized user ID and
  11. // credentials. User data is persisted in a dataset that can store up to 1 MB
  12. // of key-value pairs, and you can have up to 20 datasets per user identity.
  13. //
  14. // With Amazon Cognito Sync, the data stored for each identity is accessible
  15. // only to credentials assigned to that identity. In order to use the Cognito
  16. // Sync service, you need to make API calls using credentials retrieved with
  17. // Amazon Cognito Identity service (http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html).
  18. //
  19. // If you want to use Cognito Sync in an Android or iOS application, you will
  20. // probably want to make API calls via the AWS Mobile SDK. To learn more, see
  21. // the Developer Guide for Android (http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html)
  22. // and the Developer Guide for iOS (http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html).
  23. //
  24. // See https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30 for more information on this service.
  25. //
  26. // See cognitosync package documentation for more information.
  27. // https://docs.aws.amazon.com/sdk-for-go/api/service/cognitosync/
  28. //
  29. // Using the Client
  30. //
  31. // To contact Amazon Cognito Sync with the SDK use the New function to create
  32. // a new service client. With that client you can make API requests to the service.
  33. // These clients are safe to use concurrently.
  34. //
  35. // See the SDK's documentation for more information on how to use the SDK.
  36. // https://docs.aws.amazon.com/sdk-for-go/api/
  37. //
  38. // See aws.Config documentation for more information on configuring SDK clients.
  39. // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
  40. //
  41. // See the Amazon Cognito Sync client CognitoSync for more
  42. // information on creating client for this service.
  43. // https://docs.aws.amazon.com/sdk-for-go/api/service/cognitosync/#New
  44. package cognitosync