Documentation

Overview

    Package cognitosync provides the API client, operations, and parameter types for Amazon Cognito Sync.

    Amazon Cognito Sync Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity. With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service (https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html). If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android (https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html) and the Developer Guide for iOS (https://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html).

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2014-06-30"
    View Source
    const ServiceID = "Cognito Sync"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type BulkPublishInput

          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.
          	//
          	// This member is required.
          	IdentityPoolId *string
          }

            The input for the BulkPublish operation.

            type BulkPublishOutput

            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
            
            	// Metadata pertaining to the operation's result.
            	ResultMetadata middleware.Metadata
            }

              The output for the BulkPublish operation.

              type Client

              type Client struct {
              	// contains filtered or unexported fields
              }

                Client provides the API client to make operations call for Amazon Cognito Sync.

                func New

                func New(options Options, optFns ...func(*Options)) *Client

                  New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

                  func NewFromConfig

                  func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                    NewFromConfig returns a new client from the provided config.

                    func (*Client) BulkPublish

                    func (c *Client) BulkPublish(ctx context.Context, params *BulkPublishInput, optFns ...func(*Options)) (*BulkPublishOutput, error)

                      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 (*Client) DeleteDataset

                      func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error)

                        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 (*Client) DescribeDataset

                        func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error)

                          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 (*Client) DescribeIdentityPoolUsage

                          func (c *Client) DescribeIdentityPoolUsage(ctx context.Context, params *DescribeIdentityPoolUsageInput, optFns ...func(*Options)) (*DescribeIdentityPoolUsageOutput, error)

                            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 (*Client) DescribeIdentityUsage

                            func (c *Client) DescribeIdentityUsage(ctx context.Context, params *DescribeIdentityUsageInput, optFns ...func(*Options)) (*DescribeIdentityUsageOutput, error)

                              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 (*Client) GetBulkPublishDetails

                              func (c *Client) GetBulkPublishDetails(ctx context.Context, params *GetBulkPublishDetailsInput, optFns ...func(*Options)) (*GetBulkPublishDetailsOutput, error)

                                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 (*Client) GetCognitoEvents

                                func (c *Client) GetCognitoEvents(ctx context.Context, params *GetCognitoEventsInput, optFns ...func(*Options)) (*GetCognitoEventsOutput, error)

                                  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 (*Client) GetIdentityPoolConfiguration

                                  func (c *Client) GetIdentityPoolConfiguration(ctx context.Context, params *GetIdentityPoolConfigurationInput, optFns ...func(*Options)) (*GetIdentityPoolConfigurationOutput, error)

                                    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 (*Client) ListDatasets

                                    func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error)

                                      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 (*Client) ListIdentityPoolUsage

                                      func (c *Client) ListIdentityPoolUsage(ctx context.Context, params *ListIdentityPoolUsageInput, optFns ...func(*Options)) (*ListIdentityPoolUsageOutput, error)

                                        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 (*Client) ListRecords

                                        func (c *Client) ListRecords(ctx context.Context, params *ListRecordsInput, optFns ...func(*Options)) (*ListRecordsOutput, error)

                                          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 (*Client) RegisterDevice

                                          func (c *Client) RegisterDevice(ctx context.Context, params *RegisterDeviceInput, optFns ...func(*Options)) (*RegisterDeviceOutput, error)

                                            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 (*Client) SetCognitoEvents

                                            func (c *Client) SetCognitoEvents(ctx context.Context, params *SetCognitoEventsInput, optFns ...func(*Options)) (*SetCognitoEventsOutput, error)

                                              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 (*Client) SetIdentityPoolConfiguration

                                              func (c *Client) SetIdentityPoolConfiguration(ctx context.Context, params *SetIdentityPoolConfigurationInput, optFns ...func(*Options)) (*SetIdentityPoolConfigurationOutput, error)

                                                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 (*Client) SubscribeToDataset

                                                func (c *Client) SubscribeToDataset(ctx context.Context, params *SubscribeToDatasetInput, optFns ...func(*Options)) (*SubscribeToDatasetOutput, error)

                                                  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 (*Client) UnsubscribeFromDataset

                                                  func (c *Client) UnsubscribeFromDataset(ctx context.Context, params *UnsubscribeFromDatasetInput, optFns ...func(*Options)) (*UnsubscribeFromDatasetOutput, error)

                                                    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 (*Client) UpdateRecords

                                                    func (c *Client) UpdateRecords(ctx context.Context, params *UpdateRecordsInput, optFns ...func(*Options)) (*UpdateRecordsOutput, error)

                                                      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.

                                                      type DeleteDatasetInput

                                                      type DeleteDatasetInput struct {
                                                      
                                                      	// A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
                                                      	// (underscore), '-' (dash), and '.' (dot).
                                                      	//
                                                      	// This member is required.
                                                      	DatasetName *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.
                                                      	//
                                                      	// This member is required.
                                                      	IdentityId *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.
                                                      	//
                                                      	// This member is required.
                                                      	IdentityPoolId *string
                                                      }

                                                        A request to delete the specific dataset.

                                                        type DeleteDatasetOutput

                                                        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 *types.Dataset
                                                        
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                          Response to a successful DeleteDataset request.

                                                          type DescribeDatasetInput

                                                          type DescribeDatasetInput struct {
                                                          
                                                          	// A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
                                                          	// (underscore), '-' (dash), and '.' (dot).
                                                          	//
                                                          	// This member is required.
                                                          	DatasetName *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.
                                                          	//
                                                          	// This member is required.
                                                          	IdentityId *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.
                                                          	//
                                                          	// This member is required.
                                                          	IdentityPoolId *string
                                                          }

                                                            A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.

                                                            type DescribeDatasetOutput

                                                            type DescribeDatasetOutput struct {
                                                            
                                                            	// Metadata 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 *types.Dataset
                                                            
                                                            	// Metadata pertaining to the operation's result.
                                                            	ResultMetadata middleware.Metadata
                                                            }

                                                              Response to a successful DescribeDataset request.

                                                              type DescribeIdentityPoolUsageInput

                                                              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.
                                                              	//
                                                              	// This member is required.
                                                              	IdentityPoolId *string
                                                              }

                                                                A request for usage information about the identity pool.

                                                                type DescribeIdentityPoolUsageOutput

                                                                type DescribeIdentityPoolUsageOutput struct {
                                                                
                                                                	// Information about the usage of the identity pool.
                                                                	IdentityPoolUsage *types.IdentityPoolUsage
                                                                
                                                                	// Metadata pertaining to the operation's result.
                                                                	ResultMetadata middleware.Metadata
                                                                }

                                                                  Response to a successful DescribeIdentityPoolUsage request.

                                                                  type DescribeIdentityUsageInput

                                                                  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.
                                                                  	//
                                                                  	// This member is required.
                                                                  	IdentityId *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.
                                                                  	//
                                                                  	// This member is required.
                                                                  	IdentityPoolId *string
                                                                  }

                                                                    A request for information about the usage of an identity pool.

                                                                    type DescribeIdentityUsageOutput

                                                                    type DescribeIdentityUsageOutput struct {
                                                                    
                                                                    	// Usage information for the identity.
                                                                    	IdentityUsage *types.IdentityUsage
                                                                    
                                                                    	// Metadata pertaining to the operation's result.
                                                                    	ResultMetadata middleware.Metadata
                                                                    }

                                                                      The response to a successful DescribeIdentityUsage request.

                                                                      type EndpointResolver

                                                                      type EndpointResolver interface {
                                                                      	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                                                      }

                                                                        EndpointResolver interface for resolving service endpoints.

                                                                        func EndpointResolverFromURL

                                                                        func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                                                          EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                                                          type EndpointResolverFunc

                                                                          type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                                                            EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                                                            func (EndpointResolverFunc) ResolveEndpoint

                                                                            func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                                                            type EndpointResolverOptions

                                                                            type EndpointResolverOptions = internalendpoints.Options

                                                                              EndpointResolverOptions is the service endpoint resolver options

                                                                              type GetBulkPublishDetailsInput

                                                                              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.
                                                                              	//
                                                                              	// This member is required.
                                                                              	IdentityPoolId *string
                                                                              }

                                                                                The input for the GetBulkPublishDetails operation.

                                                                                type GetBulkPublishDetailsOutput

                                                                                type GetBulkPublishDetailsOutput struct {
                                                                                
                                                                                	// If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation
                                                                                	// completed.
                                                                                	BulkPublishCompleteTime *time.Time
                                                                                
                                                                                	// The date/time at which the last bulk publish was initiated.
                                                                                	BulkPublishStartTime *time.Time
                                                                                
                                                                                	// 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 types.BulkPublishStatus
                                                                                
                                                                                	// If BulkPublishStatus is FAILED this field will contain the error message that
                                                                                	// caused the bulk publish to fail.
                                                                                	FailureMessage *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
                                                                                
                                                                                	// Metadata pertaining to the operation's result.
                                                                                	ResultMetadata middleware.Metadata
                                                                                }

                                                                                  The output for the GetBulkPublishDetails operation.

                                                                                  type GetCognitoEventsInput

                                                                                  type GetCognitoEventsInput struct {
                                                                                  
                                                                                  	// The Cognito Identity Pool ID for the request
                                                                                  	//
                                                                                  	// This member is required.
                                                                                  	IdentityPoolId *string
                                                                                  }

                                                                                    A request for a list of the configured Cognito Events

                                                                                    type GetCognitoEventsOutput

                                                                                    type GetCognitoEventsOutput struct {
                                                                                    
                                                                                    	// The Cognito Events returned from the GetCognitoEvents request
                                                                                    	Events map[string]string
                                                                                    
                                                                                    	// Metadata pertaining to the operation's result.
                                                                                    	ResultMetadata middleware.Metadata
                                                                                    }

                                                                                      The response from the GetCognitoEvents request

                                                                                      type GetIdentityPoolConfigurationInput

                                                                                      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.
                                                                                      	//
                                                                                      	// This member is required.
                                                                                      	IdentityPoolId *string
                                                                                      }

                                                                                        The input for the GetIdentityPoolConfiguration operation.

                                                                                        type GetIdentityPoolConfigurationOutput

                                                                                        type GetIdentityPoolConfigurationOutput struct {
                                                                                        
                                                                                        	// Options to apply to this identity pool for Amazon Cognito streams.
                                                                                        	CognitoStreams *types.CognitoStreams
                                                                                        
                                                                                        	// A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
                                                                                        	// created by Amazon Cognito.
                                                                                        	IdentityPoolId *string
                                                                                        
                                                                                        	// Options to apply to this identity pool for push synchronization.
                                                                                        	PushSync *types.PushSync
                                                                                        
                                                                                        	// Metadata pertaining to the operation's result.
                                                                                        	ResultMetadata middleware.Metadata
                                                                                        }

                                                                                          The output for the GetIdentityPoolConfiguration operation.

                                                                                          type HTTPClient

                                                                                          type HTTPClient interface {
                                                                                          	Do(*http.Request) (*http.Response, error)
                                                                                          }

                                                                                          type HTTPSignerV4

                                                                                          type HTTPSignerV4 interface {
                                                                                          	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                                                                          }

                                                                                          type ListDatasetsInput

                                                                                          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.
                                                                                          	//
                                                                                          	// This member is required.
                                                                                          	IdentityId *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.
                                                                                          	//
                                                                                          	// This member is required.
                                                                                          	IdentityPoolId *string
                                                                                          
                                                                                          	// The maximum number of results to be returned.
                                                                                          	MaxResults *string
                                                                                          
                                                                                          	// A pagination token for obtaining the next page of results.
                                                                                          	NextToken *string
                                                                                          }

                                                                                            Request for a list of datasets for an identity.

                                                                                            type ListDatasetsOutput

                                                                                            type ListDatasetsOutput struct {
                                                                                            
                                                                                            	// Number of datasets returned.
                                                                                            	Count int32
                                                                                            
                                                                                            	// A set of datasets.
                                                                                            	Datasets []types.Dataset
                                                                                            
                                                                                            	// A pagination token for obtaining the next page of results.
                                                                                            	NextToken *string
                                                                                            
                                                                                            	// Metadata pertaining to the operation's result.
                                                                                            	ResultMetadata middleware.Metadata
                                                                                            }

                                                                                              Returned for a successful ListDatasets request.

                                                                                              type ListIdentityPoolUsageInput

                                                                                              type ListIdentityPoolUsageInput struct {
                                                                                              
                                                                                              	// The maximum number of results to be returned.
                                                                                              	MaxResults int32
                                                                                              
                                                                                              	// A pagination token for obtaining the next page of results.
                                                                                              	NextToken *string
                                                                                              }

                                                                                                A request for usage information on an identity pool.

                                                                                                type ListIdentityPoolUsageOutput

                                                                                                type ListIdentityPoolUsageOutput struct {
                                                                                                
                                                                                                	// Total number of identities for the identity pool.
                                                                                                	Count int32
                                                                                                
                                                                                                	// Usage information for the identity pools.
                                                                                                	IdentityPoolUsages []types.IdentityPoolUsage
                                                                                                
                                                                                                	// The maximum number of results to be returned.
                                                                                                	MaxResults int32
                                                                                                
                                                                                                	// A pagination token for obtaining the next page of results.
                                                                                                	NextToken *string
                                                                                                
                                                                                                	// Metadata pertaining to the operation's result.
                                                                                                	ResultMetadata middleware.Metadata
                                                                                                }

                                                                                                  Returned for a successful ListIdentityPoolUsage request.

                                                                                                  type ListRecordsInput

                                                                                                  type ListRecordsInput struct {
                                                                                                  
                                                                                                  	// A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
                                                                                                  	// (underscore), '-' (dash), and '.' (dot).
                                                                                                  	//
                                                                                                  	// This member is required.
                                                                                                  	DatasetName *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.
                                                                                                  	//
                                                                                                  	// This member is required.
                                                                                                  	IdentityId *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.
                                                                                                  	//
                                                                                                  	// This member is required.
                                                                                                  	IdentityPoolId *string
                                                                                                  
                                                                                                  	// The last server sync count for this record.
                                                                                                  	LastSyncCount *int64
                                                                                                  
                                                                                                  	// The maximum number of results to be returned.
                                                                                                  	MaxResults int32
                                                                                                  
                                                                                                  	// A pagination token for obtaining the next page of results.
                                                                                                  	NextToken *string
                                                                                                  
                                                                                                  	// A token containing a session ID, identity ID, and expiration.
                                                                                                  	SyncSessionToken *string
                                                                                                  }

                                                                                                    A request for a list of records.

                                                                                                    type ListRecordsOutput

                                                                                                    type ListRecordsOutput struct {
                                                                                                    
                                                                                                    	// Total number of records.
                                                                                                    	Count int32
                                                                                                    
                                                                                                    	// A boolean value specifying whether to delete the dataset locally.
                                                                                                    	DatasetDeletedAfterRequestedSyncCount bool
                                                                                                    
                                                                                                    	// Indicates whether the dataset exists.
                                                                                                    	DatasetExists bool
                                                                                                    
                                                                                                    	// Server sync count for this dataset.
                                                                                                    	DatasetSyncCount *int64
                                                                                                    
                                                                                                    	// The user/device that made the last change to this record.
                                                                                                    	LastModifiedBy *string
                                                                                                    
                                                                                                    	// Names of merged datasets.
                                                                                                    	MergedDatasetNames []string
                                                                                                    
                                                                                                    	// A pagination token for obtaining the next page of results.
                                                                                                    	NextToken *string
                                                                                                    
                                                                                                    	// A list of all records.
                                                                                                    	Records []types.Record
                                                                                                    
                                                                                                    	// A token containing a session ID, identity ID, and expiration.
                                                                                                    	SyncSessionToken *string
                                                                                                    
                                                                                                    	// Metadata pertaining to the operation's result.
                                                                                                    	ResultMetadata middleware.Metadata
                                                                                                    }

                                                                                                      Returned for a successful ListRecordsRequest.

                                                                                                      type Options

                                                                                                      type Options struct {
                                                                                                      	// Set of options to modify how an operation is invoked. These apply to all
                                                                                                      	// operations invoked for this client. Use functional options on operation call to
                                                                                                      	// modify this list for per operation behavior.
                                                                                                      	APIOptions []func(*middleware.Stack) error
                                                                                                      
                                                                                                      	// Configures the events that will be sent to the configured logger.
                                                                                                      	ClientLogMode aws.ClientLogMode
                                                                                                      
                                                                                                      	// The credentials object to use when signing requests.
                                                                                                      	Credentials aws.CredentialsProvider
                                                                                                      
                                                                                                      	// The endpoint options to be used when attempting to resolve an endpoint.
                                                                                                      	EndpointOptions EndpointResolverOptions
                                                                                                      
                                                                                                      	// The service endpoint resolver.
                                                                                                      	EndpointResolver EndpointResolver
                                                                                                      
                                                                                                      	// Signature Version 4 (SigV4) Signer
                                                                                                      	HTTPSignerV4 HTTPSignerV4
                                                                                                      
                                                                                                      	// The logger writer interface to write logging messages to.
                                                                                                      	Logger logging.Logger
                                                                                                      
                                                                                                      	// The region to send requests to. (Required)
                                                                                                      	Region string
                                                                                                      
                                                                                                      	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                                                      	// failures. When nil the API client will use a default retryer.
                                                                                                      	Retryer aws.Retryer
                                                                                                      
                                                                                                      	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                                                      	// implementation if nil.
                                                                                                      	HTTPClient HTTPClient
                                                                                                      }

                                                                                                      func (Options) Copy

                                                                                                      func (o Options) Copy() Options

                                                                                                        Copy creates a clone where the APIOptions list is deep copied.

                                                                                                        type RegisterDeviceInput

                                                                                                        type RegisterDeviceInput struct {
                                                                                                        
                                                                                                        	// The unique ID for this identity.
                                                                                                        	//
                                                                                                        	// This member is required.
                                                                                                        	IdentityId *string
                                                                                                        
                                                                                                        	// 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.
                                                                                                        	//
                                                                                                        	// This member is required.
                                                                                                        	IdentityPoolId *string
                                                                                                        
                                                                                                        	// The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
                                                                                                        	//
                                                                                                        	// This member is required.
                                                                                                        	Platform types.Platform
                                                                                                        
                                                                                                        	// The push token.
                                                                                                        	//
                                                                                                        	// This member is required.
                                                                                                        	Token *string
                                                                                                        }

                                                                                                          A request to RegisterDevice.

                                                                                                          type RegisterDeviceOutput

                                                                                                          type RegisterDeviceOutput struct {
                                                                                                          
                                                                                                          	// The unique ID generated for this device by Cognito.
                                                                                                          	DeviceId *string
                                                                                                          
                                                                                                          	// Metadata pertaining to the operation's result.
                                                                                                          	ResultMetadata middleware.Metadata
                                                                                                          }

                                                                                                            Response to a RegisterDevice request.

                                                                                                            type ResolveEndpoint

                                                                                                            type ResolveEndpoint struct {
                                                                                                            	Resolver EndpointResolver
                                                                                                            	Options  EndpointResolverOptions
                                                                                                            }

                                                                                                            func (*ResolveEndpoint) HandleSerialize

                                                                                                            func (*ResolveEndpoint) ID

                                                                                                            func (*ResolveEndpoint) ID() string

                                                                                                            type SetCognitoEventsInput

                                                                                                            type SetCognitoEventsInput struct {
                                                                                                            
                                                                                                            	// The events to configure
                                                                                                            	//
                                                                                                            	// This member is required.
                                                                                                            	Events map[string]string
                                                                                                            
                                                                                                            	// The Cognito Identity Pool to use when configuring Cognito Events
                                                                                                            	//
                                                                                                            	// This member is required.
                                                                                                            	IdentityPoolId *string
                                                                                                            }

                                                                                                              A request to configure Cognito Events.

                                                                                                              type SetCognitoEventsOutput

                                                                                                              type SetCognitoEventsOutput struct {
                                                                                                              	// Metadata pertaining to the operation's result.
                                                                                                              	ResultMetadata middleware.Metadata
                                                                                                              }

                                                                                                              type SetIdentityPoolConfigurationInput

                                                                                                              type SetIdentityPoolConfigurationInput 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 to modify.
                                                                                                              	//
                                                                                                              	// This member is required.
                                                                                                              	IdentityPoolId *string
                                                                                                              
                                                                                                              	// Options to apply to this identity pool for Amazon Cognito streams.
                                                                                                              	CognitoStreams *types.CognitoStreams
                                                                                                              
                                                                                                              	// Options to apply to this identity pool for push synchronization.
                                                                                                              	PushSync *types.PushSync
                                                                                                              }

                                                                                                                The input for the SetIdentityPoolConfiguration operation.

                                                                                                                type SetIdentityPoolConfigurationOutput

                                                                                                                type SetIdentityPoolConfigurationOutput struct {
                                                                                                                
                                                                                                                	// Options to apply to this identity pool for Amazon Cognito streams.
                                                                                                                	CognitoStreams *types.CognitoStreams
                                                                                                                
                                                                                                                	// A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
                                                                                                                	// created by Amazon Cognito.
                                                                                                                	IdentityPoolId *string
                                                                                                                
                                                                                                                	// Options to apply to this identity pool for push synchronization.
                                                                                                                	PushSync *types.PushSync
                                                                                                                
                                                                                                                	// Metadata pertaining to the operation's result.
                                                                                                                	ResultMetadata middleware.Metadata
                                                                                                                }

                                                                                                                  The output for the SetIdentityPoolConfiguration operation

                                                                                                                  type SubscribeToDatasetInput

                                                                                                                  type SubscribeToDatasetInput struct {
                                                                                                                  
                                                                                                                  	// The name of the dataset to subcribe to.
                                                                                                                  	//
                                                                                                                  	// This member is required.
                                                                                                                  	DatasetName *string
                                                                                                                  
                                                                                                                  	// The unique ID generated for this device by Cognito.
                                                                                                                  	//
                                                                                                                  	// This member is required.
                                                                                                                  	DeviceId *string
                                                                                                                  
                                                                                                                  	// Unique ID for this identity.
                                                                                                                  	//
                                                                                                                  	// This member is required.
                                                                                                                  	IdentityId *string
                                                                                                                  
                                                                                                                  	// 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.
                                                                                                                  	//
                                                                                                                  	// This member is required.
                                                                                                                  	IdentityPoolId *string
                                                                                                                  }

                                                                                                                    A request to SubscribeToDatasetRequest.

                                                                                                                    type SubscribeToDatasetOutput

                                                                                                                    type SubscribeToDatasetOutput struct {
                                                                                                                    	// Metadata pertaining to the operation's result.
                                                                                                                    	ResultMetadata middleware.Metadata
                                                                                                                    }

                                                                                                                      Response to a SubscribeToDataset request.

                                                                                                                      type UnsubscribeFromDatasetInput

                                                                                                                      type UnsubscribeFromDatasetInput struct {
                                                                                                                      
                                                                                                                      	// The name of the dataset from which to unsubcribe.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	DatasetName *string
                                                                                                                      
                                                                                                                      	// The unique ID generated for this device by Cognito.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	DeviceId *string
                                                                                                                      
                                                                                                                      	// Unique ID for this identity.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	IdentityId *string
                                                                                                                      
                                                                                                                      	// 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.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	IdentityPoolId *string
                                                                                                                      }

                                                                                                                        A request to UnsubscribeFromDataset.

                                                                                                                        type UnsubscribeFromDatasetOutput

                                                                                                                        type UnsubscribeFromDatasetOutput struct {
                                                                                                                        	// Metadata pertaining to the operation's result.
                                                                                                                        	ResultMetadata middleware.Metadata
                                                                                                                        }

                                                                                                                          Response to an UnsubscribeFromDataset request.

                                                                                                                          type UpdateRecordsInput

                                                                                                                          type UpdateRecordsInput struct {
                                                                                                                          
                                                                                                                          	// A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
                                                                                                                          	// (underscore), '-' (dash), and '.' (dot).
                                                                                                                          	//
                                                                                                                          	// This member is required.
                                                                                                                          	DatasetName *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.
                                                                                                                          	//
                                                                                                                          	// This member is required.
                                                                                                                          	IdentityId *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.
                                                                                                                          	//
                                                                                                                          	// This member is required.
                                                                                                                          	IdentityPoolId *string
                                                                                                                          
                                                                                                                          	// The SyncSessionToken returned by a previous call to ListRecords for this dataset
                                                                                                                          	// and identity.
                                                                                                                          	//
                                                                                                                          	// This member is required.
                                                                                                                          	SyncSessionToken *string
                                                                                                                          
                                                                                                                          	// 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
                                                                                                                          
                                                                                                                          	// The unique ID generated for this device by Cognito.
                                                                                                                          	DeviceId *string
                                                                                                                          
                                                                                                                          	// A list of patch operations.
                                                                                                                          	RecordPatches []types.RecordPatch
                                                                                                                          }

                                                                                                                            A request to post updates to records or add and delete records for a dataset and user.

                                                                                                                            type UpdateRecordsOutput

                                                                                                                            type UpdateRecordsOutput struct {
                                                                                                                            
                                                                                                                            	// A list of records that have been updated.
                                                                                                                            	Records []types.Record
                                                                                                                            
                                                                                                                            	// Metadata pertaining to the operation's result.
                                                                                                                            	ResultMetadata middleware.Metadata
                                                                                                                            }

                                                                                                                              Returned for a successful UpdateRecordsRequest.

                                                                                                                              Directories

                                                                                                                              Path Synopsis
                                                                                                                              internal