Documentation ¶
Overview ¶
Package cognitosync provides a client for Amazon Cognito Sync.
Index ¶
- Constants
- type BulkPublishInput
- type BulkPublishOutput
- type CognitoStreams
- type CognitoSync
- func (c *CognitoSync) BulkPublish(input *BulkPublishInput) (*BulkPublishOutput, error)
- func (c *CognitoSync) BulkPublishRequest(input *BulkPublishInput) (req *request.Request, output *BulkPublishOutput)
- func (c *CognitoSync) DeleteDataset(input *DeleteDatasetInput) (*DeleteDatasetOutput, error)
- func (c *CognitoSync) DeleteDatasetRequest(input *DeleteDatasetInput) (req *request.Request, output *DeleteDatasetOutput)
- func (c *CognitoSync) DescribeDataset(input *DescribeDatasetInput) (*DescribeDatasetOutput, error)
- func (c *CognitoSync) DescribeDatasetRequest(input *DescribeDatasetInput) (req *request.Request, output *DescribeDatasetOutput)
- func (c *CognitoSync) DescribeIdentityPoolUsage(input *DescribeIdentityPoolUsageInput) (*DescribeIdentityPoolUsageOutput, error)
- func (c *CognitoSync) DescribeIdentityPoolUsageRequest(input *DescribeIdentityPoolUsageInput) (req *request.Request, output *DescribeIdentityPoolUsageOutput)
- func (c *CognitoSync) DescribeIdentityUsage(input *DescribeIdentityUsageInput) (*DescribeIdentityUsageOutput, error)
- func (c *CognitoSync) DescribeIdentityUsageRequest(input *DescribeIdentityUsageInput) (req *request.Request, output *DescribeIdentityUsageOutput)
- func (c *CognitoSync) GetBulkPublishDetails(input *GetBulkPublishDetailsInput) (*GetBulkPublishDetailsOutput, error)
- func (c *CognitoSync) GetBulkPublishDetailsRequest(input *GetBulkPublishDetailsInput) (req *request.Request, output *GetBulkPublishDetailsOutput)
- func (c *CognitoSync) GetCognitoEvents(input *GetCognitoEventsInput) (*GetCognitoEventsOutput, error)
- func (c *CognitoSync) GetCognitoEventsRequest(input *GetCognitoEventsInput) (req *request.Request, output *GetCognitoEventsOutput)
- func (c *CognitoSync) GetIdentityPoolConfiguration(input *GetIdentityPoolConfigurationInput) (*GetIdentityPoolConfigurationOutput, error)
- func (c *CognitoSync) GetIdentityPoolConfigurationRequest(input *GetIdentityPoolConfigurationInput) (req *request.Request, output *GetIdentityPoolConfigurationOutput)
- func (c *CognitoSync) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error)
- func (c *CognitoSync) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput)
- func (c *CognitoSync) ListIdentityPoolUsage(input *ListIdentityPoolUsageInput) (*ListIdentityPoolUsageOutput, error)
- func (c *CognitoSync) ListIdentityPoolUsageRequest(input *ListIdentityPoolUsageInput) (req *request.Request, output *ListIdentityPoolUsageOutput)
- func (c *CognitoSync) ListRecords(input *ListRecordsInput) (*ListRecordsOutput, error)
- func (c *CognitoSync) ListRecordsRequest(input *ListRecordsInput) (req *request.Request, output *ListRecordsOutput)
- func (c *CognitoSync) RegisterDevice(input *RegisterDeviceInput) (*RegisterDeviceOutput, error)
- func (c *CognitoSync) RegisterDeviceRequest(input *RegisterDeviceInput) (req *request.Request, output *RegisterDeviceOutput)
- func (c *CognitoSync) SetCognitoEvents(input *SetCognitoEventsInput) (*SetCognitoEventsOutput, error)
- func (c *CognitoSync) SetCognitoEventsRequest(input *SetCognitoEventsInput) (req *request.Request, output *SetCognitoEventsOutput)
- func (c *CognitoSync) SetIdentityPoolConfiguration(input *SetIdentityPoolConfigurationInput) (*SetIdentityPoolConfigurationOutput, error)
- func (c *CognitoSync) SetIdentityPoolConfigurationRequest(input *SetIdentityPoolConfigurationInput) (req *request.Request, output *SetIdentityPoolConfigurationOutput)
- func (c *CognitoSync) SubscribeToDataset(input *SubscribeToDatasetInput) (*SubscribeToDatasetOutput, error)
- func (c *CognitoSync) SubscribeToDatasetRequest(input *SubscribeToDatasetInput) (req *request.Request, output *SubscribeToDatasetOutput)
- func (c *CognitoSync) UnsubscribeFromDataset(input *UnsubscribeFromDatasetInput) (*UnsubscribeFromDatasetOutput, error)
- func (c *CognitoSync) UnsubscribeFromDatasetRequest(input *UnsubscribeFromDatasetInput) (req *request.Request, output *UnsubscribeFromDatasetOutput)
- func (c *CognitoSync) UpdateRecords(input *UpdateRecordsInput) (*UpdateRecordsOutput, error)
- func (c *CognitoSync) UpdateRecordsRequest(input *UpdateRecordsInput) (req *request.Request, output *UpdateRecordsOutput)
- type Dataset
- type DeleteDatasetInput
- type DeleteDatasetOutput
- type DescribeDatasetInput
- type DescribeDatasetOutput
- type DescribeIdentityPoolUsageInput
- type DescribeIdentityPoolUsageOutput
- type DescribeIdentityUsageInput
- type DescribeIdentityUsageOutput
- type GetBulkPublishDetailsInput
- type GetBulkPublishDetailsOutput
- type GetCognitoEventsInput
- type GetCognitoEventsOutput
- type GetIdentityPoolConfigurationInput
- type GetIdentityPoolConfigurationOutput
- type IdentityPoolUsage
- type IdentityUsage
- type ListDatasetsInput
- type ListDatasetsOutput
- type ListIdentityPoolUsageInput
- type ListIdentityPoolUsageOutput
- type ListRecordsInput
- type ListRecordsOutput
- type PushSync
- type Record
- type RecordPatch
- type RegisterDeviceInput
- type RegisterDeviceOutput
- type SetCognitoEventsInput
- type SetCognitoEventsOutput
- type SetIdentityPoolConfigurationInput
- type SetIdentityPoolConfigurationOutput
- type SubscribeToDatasetInput
- type SubscribeToDatasetOutput
- type UnsubscribeFromDatasetInput
- type UnsubscribeFromDatasetOutput
- type UpdateRecordsInput
- type UpdateRecordsOutput
Examples ¶
- CognitoSync.BulkPublish
- CognitoSync.DeleteDataset
- CognitoSync.DescribeDataset
- CognitoSync.DescribeIdentityPoolUsage
- CognitoSync.DescribeIdentityUsage
- CognitoSync.GetBulkPublishDetails
- CognitoSync.GetCognitoEvents
- CognitoSync.GetIdentityPoolConfiguration
- CognitoSync.ListDatasets
- CognitoSync.ListIdentityPoolUsage
- CognitoSync.ListRecords
- CognitoSync.RegisterDevice
- CognitoSync.SetCognitoEvents
- CognitoSync.SetIdentityPoolConfiguration
- CognitoSync.SubscribeToDataset
- CognitoSync.UnsubscribeFromDataset
- CognitoSync.UpdateRecords
Constants ¶
const ( // @enum BulkPublishStatus BulkPublishStatusNotStarted = "NOT_STARTED" // @enum BulkPublishStatus BulkPublishStatusInProgress = "IN_PROGRESS" // @enum BulkPublishStatus BulkPublishStatusFailed = "FAILED" // @enum BulkPublishStatus BulkPublishStatusSucceeded = "SUCCEEDED" )
const ( // @enum Operation OperationReplace = "replace" // @enum Operation OperationRemove = "remove" )
const ( // @enum Platform PlatformApns = "APNS" // @enum Platform PlatformApnsSandbox = "APNS_SANDBOX" // @enum Platform PlatformGcm = "GCM" // @enum Platform PlatformAdm = "ADM" )
const ( // @enum StreamingStatus StreamingStatusEnabled = "ENABLED" // @enum StreamingStatus StreamingStatusDisabled = "DISABLED" )
const ServiceName = "cognito-sync"
A ServiceName is the name of the service the client will make API calls to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The input for the BulkPublish operation.
func (BulkPublishInput) GoString ¶
func (s BulkPublishInput) GoString() string
GoString returns the string representation
func (BulkPublishInput) String ¶
func (s BulkPublishInput) String() string
String returns the string representation
func (*BulkPublishInput) Validate ¶
func (s *BulkPublishInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 `min:"1" type:"string"` // contains filtered or unexported fields }
The output for the BulkPublish operation.
func (BulkPublishOutput) GoString ¶
func (s BulkPublishOutput) GoString() string
GoString returns the string representation
func (BulkPublishOutput) String ¶
func (s BulkPublishOutput) String() string
String returns the string representation
type CognitoStreams ¶
type CognitoStreams struct { // The ARN of the role Amazon Cognito can assume in order to publish to the // stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke // PutRecord on your Cognito stream. RoleArn *string `min:"20" type:"string"` // The name of the Cognito stream to receive updates. This stream must be in // the developers account and in the same region as the identity pool. StreamName *string `min:"1" type:"string"` // Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates // to identity pool is enabled. // // DISABLED - Streaming of updates to identity pool is disabled. Bulk publish // will also fail if StreamingStatus is DISABLED. StreamingStatus *string `type:"string" enum:"StreamingStatus"` // contains filtered or unexported fields }
Configuration options for configure Cognito streams.
func (CognitoStreams) GoString ¶
func (s CognitoStreams) GoString() string
GoString returns the string representation
func (CognitoStreams) String ¶
func (s CognitoStreams) String() string
String returns the string representation
func (*CognitoStreams) Validate ¶
func (s *CognitoStreams) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CognitoSync ¶
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 (http://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 (http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html) and the Developer Guide for iOS (http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *CognitoSync
New creates a new instance of the CognitoSync client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a CognitoSync client from just a session. svc := cognitosync.New(mySession) // Create a CognitoSync client with additional configuration svc := cognitosync.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*CognitoSync) BulkPublish ¶
func (c *CognitoSync) BulkPublish(input *BulkPublishInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.BulkPublishInput{ IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.BulkPublish(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) BulkPublishRequest ¶
func (c *CognitoSync) BulkPublishRequest(input *BulkPublishInput) (req *request.Request, output *BulkPublishOutput)
BulkPublishRequest generates a "aws/request.Request" representing the client's request for the BulkPublish operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the BulkPublish method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the BulkPublishRequest method. req, resp := client.BulkPublishRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) DeleteDataset ¶
func (c *CognitoSync) DeleteDataset(input *DeleteDatasetInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.DeleteDatasetInput{ DatasetName: aws.String("DatasetName"), // Required IdentityId: aws.String("IdentityId"), // Required IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.DeleteDataset(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) DeleteDatasetRequest ¶
func (c *CognitoSync) DeleteDatasetRequest(input *DeleteDatasetInput) (req *request.Request, output *DeleteDatasetOutput)
DeleteDatasetRequest generates a "aws/request.Request" representing the client's request for the DeleteDataset operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDataset method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDatasetRequest method. req, resp := client.DeleteDatasetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) DescribeDataset ¶
func (c *CognitoSync) DescribeDataset(input *DescribeDatasetInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.DescribeDatasetInput{ DatasetName: aws.String("DatasetName"), // Required IdentityId: aws.String("IdentityId"), // Required IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.DescribeDataset(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) DescribeDatasetRequest ¶
func (c *CognitoSync) DescribeDatasetRequest(input *DescribeDatasetInput) (req *request.Request, output *DescribeDatasetOutput)
DescribeDatasetRequest generates a "aws/request.Request" representing the client's request for the DescribeDataset operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeDataset method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeDatasetRequest method. req, resp := client.DescribeDatasetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) DescribeIdentityPoolUsage ¶
func (c *CognitoSync) DescribeIdentityPoolUsage(input *DescribeIdentityPoolUsageInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.DescribeIdentityPoolUsageInput{ IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.DescribeIdentityPoolUsage(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) DescribeIdentityPoolUsageRequest ¶
func (c *CognitoSync) DescribeIdentityPoolUsageRequest(input *DescribeIdentityPoolUsageInput) (req *request.Request, output *DescribeIdentityPoolUsageOutput)
DescribeIdentityPoolUsageRequest generates a "aws/request.Request" representing the client's request for the DescribeIdentityPoolUsage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeIdentityPoolUsage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeIdentityPoolUsageRequest method. req, resp := client.DescribeIdentityPoolUsageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) DescribeIdentityUsage ¶
func (c *CognitoSync) DescribeIdentityUsage(input *DescribeIdentityUsageInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.DescribeIdentityUsageInput{ IdentityId: aws.String("IdentityId"), // Required IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.DescribeIdentityUsage(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) DescribeIdentityUsageRequest ¶
func (c *CognitoSync) DescribeIdentityUsageRequest(input *DescribeIdentityUsageInput) (req *request.Request, output *DescribeIdentityUsageOutput)
DescribeIdentityUsageRequest generates a "aws/request.Request" representing the client's request for the DescribeIdentityUsage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeIdentityUsage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeIdentityUsageRequest method. req, resp := client.DescribeIdentityUsageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) GetBulkPublishDetails ¶
func (c *CognitoSync) GetBulkPublishDetails(input *GetBulkPublishDetailsInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.GetBulkPublishDetailsInput{ IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.GetBulkPublishDetails(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) GetBulkPublishDetailsRequest ¶
func (c *CognitoSync) GetBulkPublishDetailsRequest(input *GetBulkPublishDetailsInput) (req *request.Request, output *GetBulkPublishDetailsOutput)
GetBulkPublishDetailsRequest generates a "aws/request.Request" representing the client's request for the GetBulkPublishDetails operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetBulkPublishDetails method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetBulkPublishDetailsRequest method. req, resp := client.GetBulkPublishDetailsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) GetCognitoEvents ¶
func (c *CognitoSync) GetCognitoEvents(input *GetCognitoEventsInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.GetCognitoEventsInput{ IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.GetCognitoEvents(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) GetCognitoEventsRequest ¶
func (c *CognitoSync) GetCognitoEventsRequest(input *GetCognitoEventsInput) (req *request.Request, output *GetCognitoEventsOutput)
GetCognitoEventsRequest generates a "aws/request.Request" representing the client's request for the GetCognitoEvents operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetCognitoEvents method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetCognitoEventsRequest method. req, resp := client.GetCognitoEventsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) GetIdentityPoolConfiguration ¶
func (c *CognitoSync) GetIdentityPoolConfiguration(input *GetIdentityPoolConfigurationInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.GetIdentityPoolConfigurationInput{ IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.GetIdentityPoolConfiguration(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) GetIdentityPoolConfigurationRequest ¶
func (c *CognitoSync) GetIdentityPoolConfigurationRequest(input *GetIdentityPoolConfigurationInput) (req *request.Request, output *GetIdentityPoolConfigurationOutput)
GetIdentityPoolConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetIdentityPoolConfiguration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetIdentityPoolConfiguration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetIdentityPoolConfigurationRequest method. req, resp := client.GetIdentityPoolConfigurationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) ListDatasets ¶
func (c *CognitoSync) ListDatasets(input *ListDatasetsInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.ListDatasetsInput{ IdentityId: aws.String("IdentityId"), // Required IdentityPoolId: aws.String("IdentityPoolId"), // Required MaxResults: aws.Int64(1), NextToken: aws.String("String"), } resp, err := svc.ListDatasets(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) ListDatasetsRequest ¶
func (c *CognitoSync) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput)
ListDatasetsRequest generates a "aws/request.Request" representing the client's request for the ListDatasets operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListDatasets method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListDatasetsRequest method. req, resp := client.ListDatasetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) ListIdentityPoolUsage ¶
func (c *CognitoSync) ListIdentityPoolUsage(input *ListIdentityPoolUsageInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.ListIdentityPoolUsageInput{ MaxResults: aws.Int64(1), NextToken: aws.String("String"), } resp, err := svc.ListIdentityPoolUsage(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) ListIdentityPoolUsageRequest ¶
func (c *CognitoSync) ListIdentityPoolUsageRequest(input *ListIdentityPoolUsageInput) (req *request.Request, output *ListIdentityPoolUsageOutput)
ListIdentityPoolUsageRequest generates a "aws/request.Request" representing the client's request for the ListIdentityPoolUsage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListIdentityPoolUsage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListIdentityPoolUsageRequest method. req, resp := client.ListIdentityPoolUsageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) ListRecords ¶
func (c *CognitoSync) ListRecords(input *ListRecordsInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.ListRecordsInput{ DatasetName: aws.String("DatasetName"), // Required IdentityId: aws.String("IdentityId"), // Required IdentityPoolId: aws.String("IdentityPoolId"), // Required LastSyncCount: aws.Int64(1), MaxResults: aws.Int64(1), NextToken: aws.String("String"), SyncSessionToken: aws.String("SyncSessionToken"), } resp, err := svc.ListRecords(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) ListRecordsRequest ¶
func (c *CognitoSync) ListRecordsRequest(input *ListRecordsInput) (req *request.Request, output *ListRecordsOutput)
ListRecordsRequest generates a "aws/request.Request" representing the client's request for the ListRecords operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListRecords method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListRecordsRequest method. req, resp := client.ListRecordsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) RegisterDevice ¶
func (c *CognitoSync) RegisterDevice(input *RegisterDeviceInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.RegisterDeviceInput{ IdentityId: aws.String("IdentityId"), // Required IdentityPoolId: aws.String("IdentityPoolId"), // Required Platform: aws.String("Platform"), // Required Token: aws.String("PushToken"), // Required } resp, err := svc.RegisterDevice(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) RegisterDeviceRequest ¶
func (c *CognitoSync) RegisterDeviceRequest(input *RegisterDeviceInput) (req *request.Request, output *RegisterDeviceOutput)
RegisterDeviceRequest generates a "aws/request.Request" representing the client's request for the RegisterDevice operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RegisterDevice method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the RegisterDeviceRequest method. req, resp := client.RegisterDeviceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) SetCognitoEvents ¶
func (c *CognitoSync) SetCognitoEvents(input *SetCognitoEventsInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.SetCognitoEventsInput{ Events: map[string]*string{ // Required "Key": aws.String("LambdaFunctionArn"), // Required // More values... }, IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.SetCognitoEvents(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) SetCognitoEventsRequest ¶
func (c *CognitoSync) SetCognitoEventsRequest(input *SetCognitoEventsInput) (req *request.Request, output *SetCognitoEventsOutput)
SetCognitoEventsRequest generates a "aws/request.Request" representing the client's request for the SetCognitoEvents operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetCognitoEvents method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the SetCognitoEventsRequest method. req, resp := client.SetCognitoEventsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) SetIdentityPoolConfiguration ¶
func (c *CognitoSync) SetIdentityPoolConfiguration(input *SetIdentityPoolConfigurationInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.SetIdentityPoolConfigurationInput{ IdentityPoolId: aws.String("IdentityPoolId"), // Required CognitoStreams: &cognitosync.CognitoStreams{ RoleArn: aws.String("AssumeRoleArn"), StreamName: aws.String("StreamName"), StreamingStatus: aws.String("StreamingStatus"), }, PushSync: &cognitosync.PushSync{ ApplicationArns: []*string{ aws.String("ApplicationArn"), // Required // More values... }, RoleArn: aws.String("AssumeRoleArn"), }, } resp, err := svc.SetIdentityPoolConfiguration(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) SetIdentityPoolConfigurationRequest ¶
func (c *CognitoSync) SetIdentityPoolConfigurationRequest(input *SetIdentityPoolConfigurationInput) (req *request.Request, output *SetIdentityPoolConfigurationOutput)
SetIdentityPoolConfigurationRequest generates a "aws/request.Request" representing the client's request for the SetIdentityPoolConfiguration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetIdentityPoolConfiguration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the SetIdentityPoolConfigurationRequest method. req, resp := client.SetIdentityPoolConfigurationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) SubscribeToDataset ¶
func (c *CognitoSync) SubscribeToDataset(input *SubscribeToDatasetInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.SubscribeToDatasetInput{ DatasetName: aws.String("DatasetName"), // Required DeviceId: aws.String("DeviceId"), // Required IdentityId: aws.String("IdentityId"), // Required IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.SubscribeToDataset(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) SubscribeToDatasetRequest ¶
func (c *CognitoSync) SubscribeToDatasetRequest(input *SubscribeToDatasetInput) (req *request.Request, output *SubscribeToDatasetOutput)
SubscribeToDatasetRequest generates a "aws/request.Request" representing the client's request for the SubscribeToDataset operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SubscribeToDataset method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the SubscribeToDatasetRequest method. req, resp := client.SubscribeToDatasetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) UnsubscribeFromDataset ¶
func (c *CognitoSync) UnsubscribeFromDataset(input *UnsubscribeFromDatasetInput) (*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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.UnsubscribeFromDatasetInput{ DatasetName: aws.String("DatasetName"), // Required DeviceId: aws.String("DeviceId"), // Required IdentityId: aws.String("IdentityId"), // Required IdentityPoolId: aws.String("IdentityPoolId"), // Required } resp, err := svc.UnsubscribeFromDataset(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) UnsubscribeFromDatasetRequest ¶
func (c *CognitoSync) UnsubscribeFromDatasetRequest(input *UnsubscribeFromDatasetInput) (req *request.Request, output *UnsubscribeFromDatasetOutput)
UnsubscribeFromDatasetRequest generates a "aws/request.Request" representing the client's request for the UnsubscribeFromDataset operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UnsubscribeFromDataset method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UnsubscribeFromDatasetRequest method. req, resp := client.UnsubscribeFromDatasetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoSync) UpdateRecords ¶
func (c *CognitoSync) UpdateRecords(input *UpdateRecordsInput) (*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.
Example ¶
package main import ( "fmt" "time" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cognitosync" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cognitosync.New(sess) params := &cognitosync.UpdateRecordsInput{ DatasetName: aws.String("DatasetName"), // Required IdentityId: aws.String("IdentityId"), // Required IdentityPoolId: aws.String("IdentityPoolId"), // Required SyncSessionToken: aws.String("SyncSessionToken"), // Required ClientContext: aws.String("ClientContext"), DeviceId: aws.String("DeviceId"), RecordPatches: []*cognitosync.RecordPatch{ { // Required Key: aws.String("RecordKey"), // Required Op: aws.String("Operation"), // Required SyncCount: aws.Int64(1), // Required DeviceLastModifiedDate: aws.Time(time.Now()), Value: aws.String("RecordValue"), }, // More values... }, } resp, err := svc.UpdateRecords(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CognitoSync) UpdateRecordsRequest ¶
func (c *CognitoSync) UpdateRecordsRequest(input *UpdateRecordsInput) (req *request.Request, output *UpdateRecordsOutput)
UpdateRecordsRequest generates a "aws/request.Request" representing the client's request for the UpdateRecords operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateRecords method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateRecordsRequest method. req, resp := client.UpdateRecordsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
type Dataset ¶
type Dataset struct { // Date on which the dataset was created. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // Total size in bytes of the records in this dataset. DataStorage *int64 `type:"long"` // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' // (underscore), '-' (dash), and '.' (dot). DatasetName *string `min:"1" type:"string"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityId *string `min:"1" type:"string"` // The device that made the last change to this dataset. LastModifiedBy *string `type:"string"` // Date when the dataset was last modified. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // Number of records in this dataset. NumRecords *int64 `type:"long"` // contains filtered or unexported fields }
A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.
type DeleteDatasetInput ¶
type DeleteDatasetInput struct { // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' // (underscore), '-' (dash), and '.' (dot). DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete the specific dataset.
func (DeleteDatasetInput) GoString ¶
func (s DeleteDatasetInput) GoString() string
GoString returns the string representation
func (DeleteDatasetInput) String ¶
func (s DeleteDatasetInput) String() string
String returns the string representation
func (*DeleteDatasetInput) Validate ¶
func (s *DeleteDatasetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 *Dataset `type:"structure"` // contains filtered or unexported fields }
Response to a successful DeleteDataset request.
func (DeleteDatasetOutput) GoString ¶
func (s DeleteDatasetOutput) GoString() string
GoString returns the string representation
func (DeleteDatasetOutput) String ¶
func (s DeleteDatasetOutput) String() string
String returns the string representation
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). DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.
func (DescribeDatasetInput) GoString ¶
func (s DescribeDatasetInput) GoString() string
GoString returns the string representation
func (DescribeDatasetInput) String ¶
func (s DescribeDatasetInput) String() string
String returns the string representation
func (*DescribeDatasetInput) Validate ¶
func (s *DescribeDatasetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDatasetOutput ¶
type DescribeDatasetOutput struct { // Meta data for a collection of data for an identity. An identity can have // multiple datasets. A dataset can be general or associated with a particular // entity in an application (like a saved game). Datasets are automatically // created if they don't exist. Data is synced by dataset, and a dataset can // hold up to 1MB of key-value pairs. Dataset *Dataset `type:"structure"` // contains filtered or unexported fields }
Response to a successful DescribeDataset request.
func (DescribeDatasetOutput) GoString ¶
func (s DescribeDatasetOutput) GoString() string
GoString returns the string representation
func (DescribeDatasetOutput) String ¶
func (s DescribeDatasetOutput) String() string
String returns the string representation
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. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A request for usage information about the identity pool.
func (DescribeIdentityPoolUsageInput) GoString ¶
func (s DescribeIdentityPoolUsageInput) GoString() string
GoString returns the string representation
func (DescribeIdentityPoolUsageInput) String ¶
func (s DescribeIdentityPoolUsageInput) String() string
String returns the string representation
func (*DescribeIdentityPoolUsageInput) Validate ¶
func (s *DescribeIdentityPoolUsageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeIdentityPoolUsageOutput ¶
type DescribeIdentityPoolUsageOutput struct { // Information about the usage of the identity pool. IdentityPoolUsage *IdentityPoolUsage `type:"structure"` // contains filtered or unexported fields }
Response to a successful DescribeIdentityPoolUsage request.
func (DescribeIdentityPoolUsageOutput) GoString ¶
func (s DescribeIdentityPoolUsageOutput) GoString() string
GoString returns the string representation
func (DescribeIdentityPoolUsageOutput) String ¶
func (s DescribeIdentityPoolUsageOutput) String() string
String returns the string representation
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. IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A request for information about the usage of an identity pool.
func (DescribeIdentityUsageInput) GoString ¶
func (s DescribeIdentityUsageInput) GoString() string
GoString returns the string representation
func (DescribeIdentityUsageInput) String ¶
func (s DescribeIdentityUsageInput) String() string
String returns the string representation
func (*DescribeIdentityUsageInput) Validate ¶
func (s *DescribeIdentityUsageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeIdentityUsageOutput ¶
type DescribeIdentityUsageOutput struct { // Usage information for the identity. IdentityUsage *IdentityUsage `type:"structure"` // contains filtered or unexported fields }
The response to a successful DescribeIdentityUsage request.
func (DescribeIdentityUsageOutput) GoString ¶
func (s DescribeIdentityUsageOutput) GoString() string
GoString returns the string representation
func (DescribeIdentityUsageOutput) String ¶
func (s DescribeIdentityUsageOutput) String() string
String returns the string representation
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. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The input for the GetBulkPublishDetails operation.
func (GetBulkPublishDetailsInput) GoString ¶
func (s GetBulkPublishDetailsInput) GoString() string
GoString returns the string representation
func (GetBulkPublishDetailsInput) String ¶
func (s GetBulkPublishDetailsInput) String() string
String returns the string representation
func (*GetBulkPublishDetailsInput) Validate ¶
func (s *GetBulkPublishDetailsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBulkPublishDetailsOutput ¶
type GetBulkPublishDetailsOutput struct { // If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation // completed. BulkPublishCompleteTime *time.Time `type:"timestamp" timestampFormat:"unix"` // The date/time at which the last bulk publish was initiated. BulkPublishStartTime *time.Time `type:"timestamp" timestampFormat:"unix"` // Status of the last bulk publish operation, valid values are: NOT_STARTED // - No bulk publish has been requested for this identity pool // // IN_PROGRESS - Data is being published to the configured stream // // SUCCEEDED - All data for the identity pool has been published to the configured // stream // // FAILED - Some portion of the data has failed to publish, check FailureMessage // for the cause. BulkPublishStatus *string `type:"string" enum:"BulkPublishStatus"` // If BulkPublishStatus is FAILED this field will contain the error message // that caused the bulk publish to fail. FailureMessage *string `type:"string"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string `min:"1" type:"string"` // contains filtered or unexported fields }
The output for the GetBulkPublishDetails operation.
func (GetBulkPublishDetailsOutput) GoString ¶
func (s GetBulkPublishDetailsOutput) GoString() string
GoString returns the string representation
func (GetBulkPublishDetailsOutput) String ¶
func (s GetBulkPublishDetailsOutput) String() string
String returns the string representation
type GetCognitoEventsInput ¶
type GetCognitoEventsInput struct { // The Cognito Identity Pool ID for the request IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A request for a list of the configured Cognito Events
func (GetCognitoEventsInput) GoString ¶
func (s GetCognitoEventsInput) GoString() string
GoString returns the string representation
func (GetCognitoEventsInput) String ¶
func (s GetCognitoEventsInput) String() string
String returns the string representation
func (*GetCognitoEventsInput) Validate ¶
func (s *GetCognitoEventsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCognitoEventsOutput ¶
type GetCognitoEventsOutput struct { // The Cognito Events returned from the GetCognitoEvents request Events map[string]*string `type:"map"` // contains filtered or unexported fields }
The response from the GetCognitoEvents request
func (GetCognitoEventsOutput) GoString ¶
func (s GetCognitoEventsOutput) GoString() string
GoString returns the string representation
func (GetCognitoEventsOutput) String ¶
func (s GetCognitoEventsOutput) String() string
String returns the string representation
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. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The input for the GetIdentityPoolConfiguration operation.
func (GetIdentityPoolConfigurationInput) GoString ¶
func (s GetIdentityPoolConfigurationInput) GoString() string
GoString returns the string representation
func (GetIdentityPoolConfigurationInput) String ¶
func (s GetIdentityPoolConfigurationInput) String() string
String returns the string representation
func (*GetIdentityPoolConfigurationInput) Validate ¶
func (s *GetIdentityPoolConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetIdentityPoolConfigurationOutput ¶
type GetIdentityPoolConfigurationOutput struct { // Options to apply to this identity pool for Amazon Cognito streams. CognitoStreams *CognitoStreams `type:"structure"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. IdentityPoolId *string `min:"1" type:"string"` // Options to apply to this identity pool for push synchronization. PushSync *PushSync `type:"structure"` // contains filtered or unexported fields }
The output for the GetIdentityPoolConfiguration operation.
func (GetIdentityPoolConfigurationOutput) GoString ¶
func (s GetIdentityPoolConfigurationOutput) GoString() string
GoString returns the string representation
func (GetIdentityPoolConfigurationOutput) String ¶
func (s GetIdentityPoolConfigurationOutput) String() string
String returns the string representation
type IdentityPoolUsage ¶
type IdentityPoolUsage struct { // Data storage information for the identity pool. DataStorage *int64 `type:"long"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string `min:"1" type:"string"` // Date on which the identity pool was last modified. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // Number of sync sessions for the identity pool. SyncSessionsCount *int64 `type:"long"` // contains filtered or unexported fields }
Usage information for the identity pool.
func (IdentityPoolUsage) GoString ¶
func (s IdentityPoolUsage) GoString() string
GoString returns the string representation
func (IdentityPoolUsage) String ¶
func (s IdentityPoolUsage) String() string
String returns the string representation
type IdentityUsage ¶
type IdentityUsage struct { // Total data storage for this identity. DataStorage *int64 `type:"long"` // Number of datasets for the identity. DatasetCount *int64 `type:"integer"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityId *string `min:"1" type:"string"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string `min:"1" type:"string"` // Date on which the identity was last modified. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
Usage information for the identity.
func (IdentityUsage) GoString ¶
func (s IdentityUsage) GoString() string
GoString returns the string representation
func (IdentityUsage) String ¶
func (s IdentityUsage) String() string
String returns the string representation
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. IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // The maximum number of results to be returned. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A pagination token for obtaining the next page of results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
Request for a list of datasets for an identity.
func (ListDatasetsInput) GoString ¶
func (s ListDatasetsInput) GoString() string
GoString returns the string representation
func (ListDatasetsInput) String ¶
func (s ListDatasetsInput) String() string
String returns the string representation
func (*ListDatasetsInput) Validate ¶
func (s *ListDatasetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDatasetsOutput ¶
type ListDatasetsOutput struct { // Number of datasets returned. Count *int64 `type:"integer"` // A set of datasets. Datasets []*Dataset `type:"list"` // A pagination token for obtaining the next page of results. NextToken *string `type:"string"` // contains filtered or unexported fields }
Returned for a successful ListDatasets request.
func (ListDatasetsOutput) GoString ¶
func (s ListDatasetsOutput) GoString() string
GoString returns the string representation
func (ListDatasetsOutput) String ¶
func (s ListDatasetsOutput) String() string
String returns the string representation
type ListIdentityPoolUsageInput ¶
type ListIdentityPoolUsageInput struct { // The maximum number of results to be returned. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A pagination token for obtaining the next page of results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
A request for usage information on an identity pool.
func (ListIdentityPoolUsageInput) GoString ¶
func (s ListIdentityPoolUsageInput) GoString() string
GoString returns the string representation
func (ListIdentityPoolUsageInput) String ¶
func (s ListIdentityPoolUsageInput) String() string
String returns the string representation
type ListIdentityPoolUsageOutput ¶
type ListIdentityPoolUsageOutput struct { // Total number of identities for the identity pool. Count *int64 `type:"integer"` // Usage information for the identity pools. IdentityPoolUsages []*IdentityPoolUsage `type:"list"` // The maximum number of results to be returned. MaxResults *int64 `type:"integer"` // A pagination token for obtaining the next page of results. NextToken *string `type:"string"` // contains filtered or unexported fields }
Returned for a successful ListIdentityPoolUsage request.
func (ListIdentityPoolUsageOutput) GoString ¶
func (s ListIdentityPoolUsageOutput) GoString() string
GoString returns the string representation
func (ListIdentityPoolUsageOutput) String ¶
func (s ListIdentityPoolUsageOutput) String() string
String returns the string representation
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). DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // The last server sync count for this record. LastSyncCount *int64 `location:"querystring" locationName:"lastSyncCount" type:"long"` // The maximum number of results to be returned. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A pagination token for obtaining the next page of results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // A token containing a session ID, identity ID, and expiration. SyncSessionToken *string `location:"querystring" locationName:"syncSessionToken" type:"string"` // contains filtered or unexported fields }
A request for a list of records.
func (ListRecordsInput) GoString ¶
func (s ListRecordsInput) GoString() string
GoString returns the string representation
func (ListRecordsInput) String ¶
func (s ListRecordsInput) String() string
String returns the string representation
func (*ListRecordsInput) Validate ¶
func (s *ListRecordsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListRecordsOutput ¶
type ListRecordsOutput struct { // Total number of records. Count *int64 `type:"integer"` // A boolean value specifying whether to delete the dataset locally. DatasetDeletedAfterRequestedSyncCount *bool `type:"boolean"` // Indicates whether the dataset exists. DatasetExists *bool `type:"boolean"` // Server sync count for this dataset. DatasetSyncCount *int64 `type:"long"` // The user/device that made the last change to this record. LastModifiedBy *string `type:"string"` // Names of merged datasets. MergedDatasetNames []*string `type:"list"` // A pagination token for obtaining the next page of results. NextToken *string `type:"string"` // A list of all records. Records []*Record `type:"list"` // A token containing a session ID, identity ID, and expiration. SyncSessionToken *string `type:"string"` // contains filtered or unexported fields }
Returned for a successful ListRecordsRequest.
func (ListRecordsOutput) GoString ¶
func (s ListRecordsOutput) GoString() string
GoString returns the string representation
func (ListRecordsOutput) String ¶
func (s ListRecordsOutput) String() string
String returns the string representation
type PushSync ¶
type PushSync struct { // List of SNS platform application ARNs that could be used by clients. ApplicationArns []*string `type:"list"` // A role configured to allow Cognito to call SNS on behalf of the developer. RoleArn *string `min:"20" type:"string"` // contains filtered or unexported fields }
Configuration options to be applied to the identity pool.
type Record ¶
type Record struct { // The last modified date of the client device. DeviceLastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The key for the record. Key *string `min:"1" type:"string"` // The user/device that made the last change to this record. LastModifiedBy *string `type:"string"` // The date on which the record was last modified. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The server sync count for this record. SyncCount *int64 `type:"long"` // The value for the record. Value *string `type:"string"` // contains filtered or unexported fields }
The basic data structure of a dataset.
type RecordPatch ¶
type RecordPatch struct { // The last modified date of the client device. DeviceLastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The key associated with the record patch. Key *string `min:"1" type:"string" required:"true"` // An operation, either replace or remove. Op *string `type:"string" required:"true" enum:"Operation"` // Last known server sync count for this record. Set to 0 if unknown. SyncCount *int64 `type:"long" required:"true"` // The value associated with the record patch. Value *string `type:"string"` // contains filtered or unexported fields }
An update operation for a record.
func (RecordPatch) GoString ¶
func (s RecordPatch) GoString() string
GoString returns the string representation
func (RecordPatch) String ¶
func (s RecordPatch) String() string
String returns the string representation
func (*RecordPatch) Validate ¶
func (s *RecordPatch) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterDeviceInput ¶
type RegisterDeviceInput struct { // The unique ID for this identity. IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. Here, the ID of the pool that the identity belongs // to. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX). Platform *string `type:"string" required:"true" enum:"Platform"` // The push token. Token *string `type:"string" required:"true"` // contains filtered or unexported fields }
A request to RegisterDevice.
func (RegisterDeviceInput) GoString ¶
func (s RegisterDeviceInput) GoString() string
GoString returns the string representation
func (RegisterDeviceInput) String ¶
func (s RegisterDeviceInput) String() string
String returns the string representation
func (*RegisterDeviceInput) Validate ¶
func (s *RegisterDeviceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterDeviceOutput ¶
type RegisterDeviceOutput struct { // The unique ID generated for this device by Cognito. DeviceId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Response to a RegisterDevice request.
func (RegisterDeviceOutput) GoString ¶
func (s RegisterDeviceOutput) GoString() string
GoString returns the string representation
func (RegisterDeviceOutput) String ¶
func (s RegisterDeviceOutput) String() string
String returns the string representation
type SetCognitoEventsInput ¶
type SetCognitoEventsInput struct { // The events to configure Events map[string]*string `type:"map" required:"true"` // The Cognito Identity Pool to use when configuring Cognito Events IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A request to configure Cognito Events"
"
func (SetCognitoEventsInput) GoString ¶
func (s SetCognitoEventsInput) GoString() string
GoString returns the string representation
func (SetCognitoEventsInput) String ¶
func (s SetCognitoEventsInput) String() string
String returns the string representation
func (*SetCognitoEventsInput) Validate ¶
func (s *SetCognitoEventsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetCognitoEventsOutput ¶
type SetCognitoEventsOutput struct {
// contains filtered or unexported fields
}
func (SetCognitoEventsOutput) GoString ¶
func (s SetCognitoEventsOutput) GoString() string
GoString returns the string representation
func (SetCognitoEventsOutput) String ¶
func (s SetCognitoEventsOutput) String() string
String returns the string representation
type SetIdentityPoolConfigurationInput ¶
type SetIdentityPoolConfigurationInput struct { // Options to apply to this identity pool for Amazon Cognito streams. CognitoStreams *CognitoStreams `type:"structure"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. This is the ID of the pool to modify. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // Options to apply to this identity pool for push synchronization. PushSync *PushSync `type:"structure"` // contains filtered or unexported fields }
The input for the SetIdentityPoolConfiguration operation.
func (SetIdentityPoolConfigurationInput) GoString ¶
func (s SetIdentityPoolConfigurationInput) GoString() string
GoString returns the string representation
func (SetIdentityPoolConfigurationInput) String ¶
func (s SetIdentityPoolConfigurationInput) String() string
String returns the string representation
func (*SetIdentityPoolConfigurationInput) Validate ¶
func (s *SetIdentityPoolConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetIdentityPoolConfigurationOutput ¶
type SetIdentityPoolConfigurationOutput struct { // Options to apply to this identity pool for Amazon Cognito streams. CognitoStreams *CognitoStreams `type:"structure"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. IdentityPoolId *string `min:"1" type:"string"` // Options to apply to this identity pool for push synchronization. PushSync *PushSync `type:"structure"` // contains filtered or unexported fields }
The output for the SetIdentityPoolConfiguration operation
func (SetIdentityPoolConfigurationOutput) GoString ¶
func (s SetIdentityPoolConfigurationOutput) GoString() string
GoString returns the string representation
func (SetIdentityPoolConfigurationOutput) String ¶
func (s SetIdentityPoolConfigurationOutput) String() string
String returns the string representation
type SubscribeToDatasetInput ¶
type SubscribeToDatasetInput struct { // The name of the dataset to subcribe to. DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"` // The unique ID generated for this device by Cognito. DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"` // Unique ID for this identity. IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. The ID of the pool to which the identity belongs. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A request to SubscribeToDatasetRequest.
func (SubscribeToDatasetInput) GoString ¶
func (s SubscribeToDatasetInput) GoString() string
GoString returns the string representation
func (SubscribeToDatasetInput) String ¶
func (s SubscribeToDatasetInput) String() string
String returns the string representation
func (*SubscribeToDatasetInput) Validate ¶
func (s *SubscribeToDatasetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SubscribeToDatasetOutput ¶
type SubscribeToDatasetOutput struct {
// contains filtered or unexported fields
}
Response to a SubscribeToDataset request.
func (SubscribeToDatasetOutput) GoString ¶
func (s SubscribeToDatasetOutput) GoString() string
GoString returns the string representation
func (SubscribeToDatasetOutput) String ¶
func (s SubscribeToDatasetOutput) String() string
String returns the string representation
type UnsubscribeFromDatasetInput ¶
type UnsubscribeFromDatasetInput struct { // The name of the dataset from which to unsubcribe. DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"` // The unique ID generated for this device by Cognito. DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"` // Unique ID for this identity. IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. The ID of the pool to which this identity belongs. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A request to UnsubscribeFromDataset.
func (UnsubscribeFromDatasetInput) GoString ¶
func (s UnsubscribeFromDatasetInput) GoString() string
GoString returns the string representation
func (UnsubscribeFromDatasetInput) String ¶
func (s UnsubscribeFromDatasetInput) String() string
String returns the string representation
func (*UnsubscribeFromDatasetInput) Validate ¶
func (s *UnsubscribeFromDatasetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UnsubscribeFromDatasetOutput ¶
type UnsubscribeFromDatasetOutput struct {
// contains filtered or unexported fields
}
Response to an UnsubscribeFromDataset request.
func (UnsubscribeFromDatasetOutput) GoString ¶
func (s UnsubscribeFromDatasetOutput) GoString() string
GoString returns the string representation
func (UnsubscribeFromDatasetOutput) String ¶
func (s UnsubscribeFromDatasetOutput) String() string
String returns the string representation
type UpdateRecordsInput ¶
type UpdateRecordsInput struct { // Intended to supply a device ID that will populate the lastModifiedBy field // referenced in other methods. The ClientContext field is not yet implemented. ClientContext *string `location:"header" locationName:"x-amz-Client-Context" type:"string"` // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' // (underscore), '-' (dash), and '.' (dot). DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"` // The unique ID generated for this device by Cognito. DeviceId *string `min:"1" type:"string"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"` // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) // created by Amazon Cognito. GUID generation is unique within a region. IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"` // A list of patch operations. RecordPatches []*RecordPatch `type:"list"` // The SyncSessionToken returned by a previous call to ListRecords for this // dataset and identity. SyncSessionToken *string `type:"string" required:"true"` // contains filtered or unexported fields }
A request to post updates to records or add and delete records for a dataset and user.
func (UpdateRecordsInput) GoString ¶
func (s UpdateRecordsInput) GoString() string
GoString returns the string representation
func (UpdateRecordsInput) String ¶
func (s UpdateRecordsInput) String() string
String returns the string representation
func (*UpdateRecordsInput) Validate ¶
func (s *UpdateRecordsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRecordsOutput ¶
type UpdateRecordsOutput struct { // A list of records that have been updated. Records []*Record `type:"list"` // contains filtered or unexported fields }
Returned for a successful UpdateRecordsRequest.
func (UpdateRecordsOutput) GoString ¶
func (s UpdateRecordsOutput) GoString() string
GoString returns the string representation
func (UpdateRecordsOutput) String ¶
func (s UpdateRecordsOutput) String() string
String returns the string representation
Directories ¶
Path | Synopsis |
---|---|
Package cognitosynciface provides an interface for the Amazon Cognito Sync.
|
Package cognitosynciface provides an interface for the Amazon Cognito Sync. |