cognitosync

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 8, 2018 License: Apache-2.0 Imports: 7 Imported by: 21

Documentation

Overview

Package cognitosync provides the client and types for making API requests to 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 (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).

See https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30 for more information on this service.

See cognitosync package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cognitosync/

Using the Client

To Amazon Cognito Sync with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Cognito Sync client CognitoSync for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cognitosync/#New

Index

Constants

View Source 
const (

	// ErrCodeAlreadyStreamedException for service response error code
	// "AlreadyStreamedException".
	//
	// An exception thrown when a bulk publish operation is requested less than
	// 24 hours after a previous bulk publish operation completed successfully.
	ErrCodeAlreadyStreamedException = "AlreadyStreamedException"

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// Thrown if there are parallel requests to modify a resource.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeDuplicateRequestException for service response error code
	// "DuplicateRequestException".
	//
	// An exception thrown when there is an IN_PROGRESS bulk publish operation for
	// the given identity pool.
	ErrCodeDuplicateRequestException = "DuplicateRequestException"

	// ErrCodeInternalErrorException for service response error code
	// "InternalErrorException".
	//
	// Indicates an internal service error.
	ErrCodeInternalErrorException = "InternalErrorException"

	// ErrCodeInvalidConfigurationException for service response error code
	// "InvalidConfigurationException".
	ErrCodeInvalidConfigurationException = "InvalidConfigurationException"

	// ErrCodeInvalidLambdaFunctionOutputException for service response error code
	// "InvalidLambdaFunctionOutputException".
	//
	// The AWS Lambda function returned invalid output or an exception.
	ErrCodeInvalidLambdaFunctionOutputException = "InvalidLambdaFunctionOutputException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// Thrown when a request parameter does not comply with the associated constraints.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeLambdaThrottledException for service response error code
	// "LambdaThrottledException".
	//
	// AWS Lambda throttled your account, please contact AWS Support
	ErrCodeLambdaThrottledException = "LambdaThrottledException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Thrown when the limit on the number of objects or operations has been exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotAuthorizedException for service response error code
	// "NotAuthorizedException".
	//
	// Thrown when a user is not authorized to access the requested resource.
	ErrCodeNotAuthorizedException = "NotAuthorizedException"

	// ErrCodeResourceConflictException for service response error code
	// "ResourceConflictException".
	//
	// Thrown if an update can't be applied because the resource was changed by
	// another call and this would result in a conflict.
	ErrCodeResourceConflictException = "ResourceConflictException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Thrown if the resource doesn't exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Thrown if the request is throttled.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)
View Source 
const (
	ServiceName = "cognito-sync" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName    // Service ID for Regions and Endpoints metadata.
)

Service information constants

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 is a required field
	IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the BulkPublish operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/BulkPublishRequest

func (BulkPublishInput) GoString 

func (s BulkPublishInput) GoString() string

GoString returns the string representation

func (BulkPublishInput) MarshalFields added in v0.3.0 

func (s BulkPublishInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/BulkPublishResponse

func (BulkPublishOutput) GoString 

func (s BulkPublishOutput) GoString() string

GoString returns the string representation

func (BulkPublishOutput) MarshalFields added in v0.3.0 

func (s BulkPublishOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BulkPublishOutput) SDKResponseMetadata 

func (s BulkPublishOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (BulkPublishOutput) String 

func (s BulkPublishOutput) String() string

String returns the string representation

type BulkPublishRequest 

type BulkPublishRequest struct {
	*aws.Request
	Input *BulkPublishInput
	Copy  func(*BulkPublishInput) BulkPublishRequest
}

BulkPublishRequest is a API request type for the BulkPublish API operation.

func (BulkPublishRequest) Send 

func (r BulkPublishRequest) Send() (*BulkPublishOutput, error)

Send marshals and sends the BulkPublish API request.

type BulkPublishStatus 

type BulkPublishStatus string
const (
	BulkPublishStatusNotStarted BulkPublishStatus = "NOT_STARTED"
	BulkPublishStatusInProgress BulkPublishStatus = "IN_PROGRESS"
	BulkPublishStatusFailed     BulkPublishStatus = "FAILED"
	BulkPublishStatusSucceeded  BulkPublishStatus = "SUCCEEDED"
)

Enum values for BulkPublishStatus

func (BulkPublishStatus) MarshalValue added in v0.3.0 

func (enum BulkPublishStatus) MarshalValue() (string, error)

func (BulkPublishStatus) MarshalValueBuf added in v0.3.0 

func (enum BulkPublishStatus) MarshalValueBuf(b []byte) ([]byte, error)

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 StreamingStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Configuration options for configure Cognito streams. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/CognitoStreams

func (CognitoStreams) GoString 

func (s CognitoStreams) GoString() string

GoString returns the string representation

func (CognitoStreams) MarshalFields added in v0.3.0 

func (s CognitoStreams) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 

type CognitoSync struct {
	*aws.Client
}

CognitoSync provides the API operation methods for making requests to Amazon Cognito Sync. See this package's package overview docs for details on the service.

CognitoSync methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *CognitoSync

New creates a new instance of the CognitoSync client with a config.

Example: 

// Create a CognitoSync client from just a config.
svc := cognitosync.New(myConfig)

func (*CognitoSync) BulkPublishRequest 

func (c *CognitoSync) BulkPublishRequest(input *BulkPublishInput) BulkPublishRequest

BulkPublishRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the BulkPublishRequest method.
req := client.BulkPublishRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/BulkPublish

func (*CognitoSync) DeleteDatasetRequest 

func (c *CognitoSync) DeleteDatasetRequest(input *DeleteDatasetInput) DeleteDatasetRequest

DeleteDatasetRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the DeleteDatasetRequest method.
req := client.DeleteDatasetRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DeleteDataset

func (*CognitoSync) DescribeDatasetRequest 

func (c *CognitoSync) DescribeDatasetRequest(input *DescribeDatasetInput) DescribeDatasetRequest

DescribeDatasetRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the DescribeDatasetRequest method.
req := client.DescribeDatasetRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeDataset

func (*CognitoSync) DescribeIdentityPoolUsageRequest 

func (c *CognitoSync) DescribeIdentityPoolUsageRequest(input *DescribeIdentityPoolUsageInput) DescribeIdentityPoolUsageRequest

DescribeIdentityPoolUsageRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the DescribeIdentityPoolUsageRequest method.
req := client.DescribeIdentityPoolUsageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityPoolUsage

func (*CognitoSync) DescribeIdentityUsageRequest 

func (c *CognitoSync) DescribeIdentityUsageRequest(input *DescribeIdentityUsageInput) DescribeIdentityUsageRequest

DescribeIdentityUsageRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the DescribeIdentityUsageRequest method.
req := client.DescribeIdentityUsageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityUsage

func (*CognitoSync) GetBulkPublishDetailsRequest 

func (c *CognitoSync) GetBulkPublishDetailsRequest(input *GetBulkPublishDetailsInput) GetBulkPublishDetailsRequest

GetBulkPublishDetailsRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the GetBulkPublishDetailsRequest method.
req := client.GetBulkPublishDetailsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetBulkPublishDetails

func (*CognitoSync) GetCognitoEventsRequest 

func (c *CognitoSync) GetCognitoEventsRequest(input *GetCognitoEventsInput) GetCognitoEventsRequest

GetCognitoEventsRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the GetCognitoEventsRequest method.
req := client.GetCognitoEventsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetCognitoEvents

func (*CognitoSync) GetIdentityPoolConfigurationRequest 

func (c *CognitoSync) GetIdentityPoolConfigurationRequest(input *GetIdentityPoolConfigurationInput) GetIdentityPoolConfigurationRequest

GetIdentityPoolConfigurationRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the GetIdentityPoolConfigurationRequest method.
req := client.GetIdentityPoolConfigurationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetIdentityPoolConfiguration

func (*CognitoSync) ListDatasetsRequest 

func (c *CognitoSync) ListDatasetsRequest(input *ListDatasetsInput) ListDatasetsRequest

ListDatasetsRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the ListDatasetsRequest method.
req := client.ListDatasetsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListDatasets

func (*CognitoSync) ListIdentityPoolUsageRequest 

func (c *CognitoSync) ListIdentityPoolUsageRequest(input *ListIdentityPoolUsageInput) ListIdentityPoolUsageRequest

ListIdentityPoolUsageRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the ListIdentityPoolUsageRequest method.
req := client.ListIdentityPoolUsageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListIdentityPoolUsage

func (*CognitoSync) ListRecordsRequest 

func (c *CognitoSync) ListRecordsRequest(input *ListRecordsInput) ListRecordsRequest

ListRecordsRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the ListRecordsRequest method.
req := client.ListRecordsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListRecords

func (*CognitoSync) RegisterDeviceRequest 

func (c *CognitoSync) RegisterDeviceRequest(input *RegisterDeviceInput) RegisterDeviceRequest

RegisterDeviceRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the RegisterDeviceRequest method.
req := client.RegisterDeviceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/RegisterDevice

func (*CognitoSync) SetCognitoEventsRequest 

func (c *CognitoSync) SetCognitoEventsRequest(input *SetCognitoEventsInput) SetCognitoEventsRequest

SetCognitoEventsRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the SetCognitoEventsRequest method.
req := client.SetCognitoEventsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetCognitoEvents

func (*CognitoSync) SetIdentityPoolConfigurationRequest 

func (c *CognitoSync) SetIdentityPoolConfigurationRequest(input *SetIdentityPoolConfigurationInput) SetIdentityPoolConfigurationRequest

SetIdentityPoolConfigurationRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the SetIdentityPoolConfigurationRequest method.
req := client.SetIdentityPoolConfigurationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetIdentityPoolConfiguration

func (*CognitoSync) SubscribeToDatasetRequest 

func (c *CognitoSync) SubscribeToDatasetRequest(input *SubscribeToDatasetInput) SubscribeToDatasetRequest

SubscribeToDatasetRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the SubscribeToDatasetRequest method.
req := client.SubscribeToDatasetRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SubscribeToDataset

func (*CognitoSync) UnsubscribeFromDatasetRequest 

func (c *CognitoSync) UnsubscribeFromDatasetRequest(input *UnsubscribeFromDatasetInput) UnsubscribeFromDatasetRequest

UnsubscribeFromDatasetRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the UnsubscribeFromDatasetRequest method.
req := client.UnsubscribeFromDatasetRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UnsubscribeFromDataset

func (*CognitoSync) UpdateRecordsRequest 

func (c *CognitoSync) UpdateRecordsRequest(input *UpdateRecordsInput) UpdateRecordsRequest

UpdateRecordsRequest returns a request value for making API operation for Amazon Cognito Sync.

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 sending a request using the UpdateRecordsRequest method.
req := client.UpdateRecordsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UpdateRecords

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/Dataset

func (Dataset) GoString 

func (s Dataset) GoString() string

GoString returns the string representation

func (Dataset) MarshalFields added in v0.3.0 

func (s Dataset) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Dataset) String 

func (s Dataset) String() string

String returns the string representation

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 is a required field
	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 is a required field
	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 is a required field
	IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to delete the specific dataset. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DeleteDatasetRequest

func (DeleteDatasetInput) GoString 

func (s DeleteDatasetInput) GoString() string

GoString returns the string representation

func (DeleteDatasetInput) MarshalFields added in v0.3.0 

func (s DeleteDatasetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DeleteDatasetResponse

func (DeleteDatasetOutput) GoString 

func (s DeleteDatasetOutput) GoString() string

GoString returns the string representation

func (DeleteDatasetOutput) MarshalFields added in v0.3.0 

func (s DeleteDatasetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDatasetOutput) SDKResponseMetadata 

func (s DeleteDatasetOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteDatasetOutput) String 

func (s DeleteDatasetOutput) String() string

String returns the string representation

type DeleteDatasetRequest 

type DeleteDatasetRequest struct {
	*aws.Request
	Input *DeleteDatasetInput
	Copy  func(*DeleteDatasetInput) DeleteDatasetRequest
}

DeleteDatasetRequest is a API request type for the DeleteDataset API operation.

func (DeleteDatasetRequest) Send 

func (r DeleteDatasetRequest) Send() (*DeleteDatasetOutput, error)

Send marshals and sends the DeleteDataset API 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).
	//
	// DatasetName is a required field
	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 is a required field
	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 is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeDatasetRequest

func (DescribeDatasetInput) GoString 

func (s DescribeDatasetInput) GoString() string

GoString returns the string representation

func (DescribeDatasetInput) MarshalFields added in v0.3.0 

func (s DescribeDatasetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeDatasetResponse

func (DescribeDatasetOutput) GoString 

func (s DescribeDatasetOutput) GoString() string

GoString returns the string representation

func (DescribeDatasetOutput) MarshalFields added in v0.3.0 

func (s DescribeDatasetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDatasetOutput) SDKResponseMetadata 

func (s DescribeDatasetOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeDatasetOutput) String 

func (s DescribeDatasetOutput) String() string

String returns the string representation

type DescribeDatasetRequest 

type DescribeDatasetRequest struct {
	*aws.Request
	Input *DescribeDatasetInput
	Copy  func(*DescribeDatasetInput) DescribeDatasetRequest
}

DescribeDatasetRequest is a API request type for the DescribeDataset API operation.

func (DescribeDatasetRequest) Send 

func (r DescribeDatasetRequest) Send() (*DescribeDatasetOutput, error)

Send marshals and sends the DescribeDataset API 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.
	//
	// IdentityPoolId is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityPoolUsageRequest

func (DescribeIdentityPoolUsageInput) GoString 

func (s DescribeIdentityPoolUsageInput) GoString() string

GoString returns the string representation

func (DescribeIdentityPoolUsageInput) MarshalFields added in v0.3.0 

func (s DescribeIdentityPoolUsageInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityPoolUsageResponse

func (DescribeIdentityPoolUsageOutput) GoString 

func (s DescribeIdentityPoolUsageOutput) GoString() string

GoString returns the string representation

func (DescribeIdentityPoolUsageOutput) MarshalFields added in v0.3.0 

func (s DescribeIdentityPoolUsageOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeIdentityPoolUsageOutput) SDKResponseMetadata 

func (s DescribeIdentityPoolUsageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeIdentityPoolUsageOutput) String 

func (s DescribeIdentityPoolUsageOutput) String() string

String returns the string representation

type DescribeIdentityPoolUsageRequest 

type DescribeIdentityPoolUsageRequest struct {
	*aws.Request
	Input *DescribeIdentityPoolUsageInput
	Copy  func(*DescribeIdentityPoolUsageInput) DescribeIdentityPoolUsageRequest
}

DescribeIdentityPoolUsageRequest is a API request type for the DescribeIdentityPoolUsage API operation.

func (DescribeIdentityPoolUsageRequest) Send 

func (r DescribeIdentityPoolUsageRequest) Send() (*DescribeIdentityPoolUsageOutput, error)

Send marshals and sends the DescribeIdentityPoolUsage API 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.
	//
	// IdentityId is a required field
	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 is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityUsageRequest

func (DescribeIdentityUsageInput) GoString 

func (s DescribeIdentityUsageInput) GoString() string

GoString returns the string representation

func (DescribeIdentityUsageInput) MarshalFields added in v0.3.0 

func (s DescribeIdentityUsageInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityUsageResponse

func (DescribeIdentityUsageOutput) GoString 

func (s DescribeIdentityUsageOutput) GoString() string

GoString returns the string representation

func (DescribeIdentityUsageOutput) MarshalFields added in v0.3.0 

func (s DescribeIdentityUsageOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeIdentityUsageOutput) SDKResponseMetadata 

func (s DescribeIdentityUsageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeIdentityUsageOutput) String 

func (s DescribeIdentityUsageOutput) String() string

String returns the string representation

type DescribeIdentityUsageRequest 

type DescribeIdentityUsageRequest struct {
	*aws.Request
	Input *DescribeIdentityUsageInput
	Copy  func(*DescribeIdentityUsageInput) DescribeIdentityUsageRequest
}

DescribeIdentityUsageRequest is a API request type for the DescribeIdentityUsage API operation.

func (DescribeIdentityUsageRequest) Send 

func (r DescribeIdentityUsageRequest) Send() (*DescribeIdentityUsageOutput, error)

Send marshals and sends the DescribeIdentityUsage API request.

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 is a required field
	IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the GetBulkPublishDetails operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetBulkPublishDetailsRequest

func (GetBulkPublishDetailsInput) GoString 

func (s GetBulkPublishDetailsInput) GoString() string

GoString returns the string representation

func (GetBulkPublishDetailsInput) MarshalFields added in v0.3.0 

func (s GetBulkPublishDetailsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 BulkPublishStatus `type:"string" enum:"true"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetBulkPublishDetailsResponse

func (GetBulkPublishDetailsOutput) GoString 

func (s GetBulkPublishDetailsOutput) GoString() string

GoString returns the string representation

func (GetBulkPublishDetailsOutput) MarshalFields added in v0.3.0 

func (s GetBulkPublishDetailsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBulkPublishDetailsOutput) SDKResponseMetadata 

func (s GetBulkPublishDetailsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetBulkPublishDetailsOutput) String 

func (s GetBulkPublishDetailsOutput) String() string

String returns the string representation

type GetBulkPublishDetailsRequest 

type GetBulkPublishDetailsRequest struct {
	*aws.Request
	Input *GetBulkPublishDetailsInput
	Copy  func(*GetBulkPublishDetailsInput) GetBulkPublishDetailsRequest
}

GetBulkPublishDetailsRequest is a API request type for the GetBulkPublishDetails API operation.

func (GetBulkPublishDetailsRequest) Send 

func (r GetBulkPublishDetailsRequest) Send() (*GetBulkPublishDetailsOutput, error)

Send marshals and sends the GetBulkPublishDetails API request.

type GetCognitoEventsInput 

type GetCognitoEventsInput struct {

	// The Cognito Identity Pool ID for the request
	//
	// IdentityPoolId is a required field
	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 Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetCognitoEventsRequest

func (GetCognitoEventsInput) GoString 

func (s GetCognitoEventsInput) GoString() string

GoString returns the string representation

func (GetCognitoEventsInput) MarshalFields added in v0.3.0 

func (s GetCognitoEventsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetCognitoEventsResponse

func (GetCognitoEventsOutput) GoString 

func (s GetCognitoEventsOutput) GoString() string

GoString returns the string representation

func (GetCognitoEventsOutput) MarshalFields added in v0.3.0 

func (s GetCognitoEventsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetCognitoEventsOutput) SDKResponseMetadata 

func (s GetCognitoEventsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetCognitoEventsOutput) String 

func (s GetCognitoEventsOutput) String() string

String returns the string representation

type GetCognitoEventsRequest 

type GetCognitoEventsRequest struct {
	*aws.Request
	Input *GetCognitoEventsInput
	Copy  func(*GetCognitoEventsInput) GetCognitoEventsRequest
}

GetCognitoEventsRequest is a API request type for the GetCognitoEvents API operation.

func (GetCognitoEventsRequest) Send 

func (r GetCognitoEventsRequest) Send() (*GetCognitoEventsOutput, error)

Send marshals and sends the GetCognitoEvents API 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.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the GetIdentityPoolConfiguration operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetIdentityPoolConfigurationRequest

func (GetIdentityPoolConfigurationInput) GoString 

func (s GetIdentityPoolConfigurationInput) GoString() string

GoString returns the string representation

func (GetIdentityPoolConfigurationInput) MarshalFields added in v0.3.0 

func (s GetIdentityPoolConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetIdentityPoolConfigurationResponse

func (GetIdentityPoolConfigurationOutput) GoString 

func (s GetIdentityPoolConfigurationOutput) GoString() string

GoString returns the string representation

func (GetIdentityPoolConfigurationOutput) MarshalFields added in v0.3.0 

func (s GetIdentityPoolConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetIdentityPoolConfigurationOutput) SDKResponseMetadata 

func (s GetIdentityPoolConfigurationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetIdentityPoolConfigurationOutput) String 

func (s GetIdentityPoolConfigurationOutput) String() string

String returns the string representation

type GetIdentityPoolConfigurationRequest 

type GetIdentityPoolConfigurationRequest struct {
	*aws.Request
	Input *GetIdentityPoolConfigurationInput
	Copy  func(*GetIdentityPoolConfigurationInput) GetIdentityPoolConfigurationRequest
}

GetIdentityPoolConfigurationRequest is a API request type for the GetIdentityPoolConfiguration API operation.

func (GetIdentityPoolConfigurationRequest) Send 

func (r GetIdentityPoolConfigurationRequest) Send() (*GetIdentityPoolConfigurationOutput, error)

Send marshals and sends the GetIdentityPoolConfiguration API request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/IdentityPoolUsage

func (IdentityPoolUsage) GoString 

func (s IdentityPoolUsage) GoString() string

GoString returns the string representation

func (IdentityPoolUsage) MarshalFields added in v0.3.0 

func (s IdentityPoolUsage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/IdentityUsage

func (IdentityUsage) GoString 

func (s IdentityUsage) GoString() string

GoString returns the string representation

func (IdentityUsage) MarshalFields added in v0.3.0 

func (s IdentityUsage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 is a required field
	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 is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListDatasetsRequest

func (ListDatasetsInput) GoString 

func (s ListDatasetsInput) GoString() string

GoString returns the string representation

func (ListDatasetsInput) MarshalFields added in v0.3.0 

func (s ListDatasetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListDatasetsResponse

func (ListDatasetsOutput) GoString 

func (s ListDatasetsOutput) GoString() string

GoString returns the string representation

func (ListDatasetsOutput) MarshalFields added in v0.3.0 

func (s ListDatasetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDatasetsOutput) SDKResponseMetadata 

func (s ListDatasetsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListDatasetsOutput) String 

func (s ListDatasetsOutput) String() string

String returns the string representation

type ListDatasetsRequest 

type ListDatasetsRequest struct {
	*aws.Request
	Input *ListDatasetsInput
	Copy  func(*ListDatasetsInput) ListDatasetsRequest
}

ListDatasetsRequest is a API request type for the ListDatasets API operation.

func (ListDatasetsRequest) Send 

func (r ListDatasetsRequest) Send() (*ListDatasetsOutput, error)

Send marshals and sends the ListDatasets API request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListIdentityPoolUsageRequest

func (ListIdentityPoolUsageInput) GoString 

func (s ListIdentityPoolUsageInput) GoString() string

GoString returns the string representation

func (ListIdentityPoolUsageInput) MarshalFields added in v0.3.0 

func (s ListIdentityPoolUsageInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListIdentityPoolUsageResponse

func (ListIdentityPoolUsageOutput) GoString 

func (s ListIdentityPoolUsageOutput) GoString() string

GoString returns the string representation

func (ListIdentityPoolUsageOutput) MarshalFields added in v0.3.0 

func (s ListIdentityPoolUsageOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListIdentityPoolUsageOutput) SDKResponseMetadata 

func (s ListIdentityPoolUsageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListIdentityPoolUsageOutput) String 

func (s ListIdentityPoolUsageOutput) String() string

String returns the string representation

type ListIdentityPoolUsageRequest 

type ListIdentityPoolUsageRequest struct {
	*aws.Request
	Input *ListIdentityPoolUsageInput
	Copy  func(*ListIdentityPoolUsageInput) ListIdentityPoolUsageRequest
}

ListIdentityPoolUsageRequest is a API request type for the ListIdentityPoolUsage API operation.

func (ListIdentityPoolUsageRequest) Send 

func (r ListIdentityPoolUsageRequest) Send() (*ListIdentityPoolUsageOutput, error)

Send marshals and sends the ListIdentityPoolUsage API 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).
	//
	// DatasetName is a required field
	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 is a required field
	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 is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListRecordsRequest

func (ListRecordsInput) GoString 

func (s ListRecordsInput) GoString() string

GoString returns the string representation

func (ListRecordsInput) MarshalFields added in v0.3.0 

func (s ListRecordsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListRecordsResponse

func (ListRecordsOutput) GoString 

func (s ListRecordsOutput) GoString() string

GoString returns the string representation

func (ListRecordsOutput) MarshalFields added in v0.3.0 

func (s ListRecordsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListRecordsOutput) SDKResponseMetadata 

func (s ListRecordsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListRecordsOutput) String 

func (s ListRecordsOutput) String() string

String returns the string representation

type ListRecordsRequest 

type ListRecordsRequest struct {
	*aws.Request
	Input *ListRecordsInput
	Copy  func(*ListRecordsInput) ListRecordsRequest
}

ListRecordsRequest is a API request type for the ListRecords API operation.

func (ListRecordsRequest) Send 

func (r ListRecordsRequest) Send() (*ListRecordsOutput, error)

Send marshals and sends the ListRecords API request.

type Operation 

type Operation string
const (
	OperationReplace Operation = "replace"
	OperationRemove  Operation = "remove"
)

Enum values for Operation

func (Operation) MarshalValue added in v0.3.0 

func (enum Operation) MarshalValue() (string, error)

func (Operation) MarshalValueBuf added in v0.3.0 

func (enum Operation) MarshalValueBuf(b []byte) ([]byte, error)

type Platform 

type Platform string
const (
	PlatformApns        Platform = "APNS"
	PlatformApnsSandbox Platform = "APNS_SANDBOX"
	PlatformGcm         Platform = "GCM"
	PlatformAdm         Platform = "ADM"
)

Enum values for Platform

func (Platform) MarshalValue added in v0.3.0 

func (enum Platform) MarshalValue() (string, error)

func (Platform) MarshalValueBuf added in v0.3.0 

func (enum Platform) MarshalValueBuf(b []byte) ([]byte, error)

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/PushSync

func (PushSync) GoString 

func (s PushSync) GoString() string

GoString returns the string representation

func (PushSync) MarshalFields added in v0.3.0 

func (s PushSync) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PushSync) String 

func (s PushSync) String() string

String returns the string representation

func (*PushSync) Validate 

func (s *PushSync) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/Record

func (Record) GoString 

func (s Record) GoString() string

GoString returns the string representation

func (Record) MarshalFields added in v0.3.0 

func (s Record) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Record) String 

func (s Record) String() string

String returns the string representation

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 is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// An operation, either replace or remove.
	//
	// Op is a required field
	Op Operation `type:"string" required:"true" enum:"true"`

	// Last known server sync count for this record. Set to 0 if unknown.
	//
	// SyncCount is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/RecordPatch

func (RecordPatch) GoString 

func (s RecordPatch) GoString() string

GoString returns the string representation

func (RecordPatch) MarshalFields added in v0.3.0 

func (s RecordPatch) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 is a required field
	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 is a required field
	IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`

	// The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
	//
	// Platform is a required field
	Platform Platform `type:"string" required:"true" enum:"true"`

	// The push token.
	//
	// Token is a required field
	Token *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to RegisterDevice. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/RegisterDeviceRequest

func (RegisterDeviceInput) GoString 

func (s RegisterDeviceInput) GoString() string

GoString returns the string representation

func (RegisterDeviceInput) MarshalFields added in v0.3.0 

func (s RegisterDeviceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/RegisterDeviceResponse

func (RegisterDeviceOutput) GoString 

func (s RegisterDeviceOutput) GoString() string

GoString returns the string representation

func (RegisterDeviceOutput) MarshalFields added in v0.3.0 

func (s RegisterDeviceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RegisterDeviceOutput) SDKResponseMetadata 

func (s RegisterDeviceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (RegisterDeviceOutput) String 

func (s RegisterDeviceOutput) String() string

String returns the string representation

type RegisterDeviceRequest 

type RegisterDeviceRequest struct {
	*aws.Request
	Input *RegisterDeviceInput
	Copy  func(*RegisterDeviceInput) RegisterDeviceRequest
}

RegisterDeviceRequest is a API request type for the RegisterDevice API operation.

func (RegisterDeviceRequest) Send 

func (r RegisterDeviceRequest) Send() (*RegisterDeviceOutput, error)

Send marshals and sends the RegisterDevice API request.

type SetCognitoEventsInput 

type SetCognitoEventsInput struct {

	// The events to configure
	//
	// Events is a required field
	Events map[string]string `type:"map" required:"true"`

	// The Cognito Identity Pool to use when configuring Cognito Events
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to configure Cognito Events" Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetCognitoEventsRequest

func (SetCognitoEventsInput) GoString 

func (s SetCognitoEventsInput) GoString() string

GoString returns the string representation

func (SetCognitoEventsInput) MarshalFields added in v0.3.0 

func (s SetCognitoEventsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetCognitoEventsOutput

func (SetCognitoEventsOutput) GoString 

func (s SetCognitoEventsOutput) GoString() string

GoString returns the string representation

func (SetCognitoEventsOutput) MarshalFields added in v0.3.0 

func (s SetCognitoEventsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SetCognitoEventsOutput) SDKResponseMetadata 

func (s SetCognitoEventsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SetCognitoEventsOutput) String 

func (s SetCognitoEventsOutput) String() string

String returns the string representation

type SetCognitoEventsRequest 

type SetCognitoEventsRequest struct {
	*aws.Request
	Input *SetCognitoEventsInput
	Copy  func(*SetCognitoEventsInput) SetCognitoEventsRequest
}

SetCognitoEventsRequest is a API request type for the SetCognitoEvents API operation.

func (SetCognitoEventsRequest) Send 

func (r SetCognitoEventsRequest) Send() (*SetCognitoEventsOutput, error)

Send marshals and sends the SetCognitoEvents API request.

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 is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetIdentityPoolConfigurationRequest

func (SetIdentityPoolConfigurationInput) GoString 

func (s SetIdentityPoolConfigurationInput) GoString() string

GoString returns the string representation

func (SetIdentityPoolConfigurationInput) MarshalFields added in v0.3.0 

func (s SetIdentityPoolConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetIdentityPoolConfigurationResponse

func (SetIdentityPoolConfigurationOutput) GoString 

func (s SetIdentityPoolConfigurationOutput) GoString() string

GoString returns the string representation

func (SetIdentityPoolConfigurationOutput) MarshalFields added in v0.3.0 

func (s SetIdentityPoolConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SetIdentityPoolConfigurationOutput) SDKResponseMetadata 

func (s SetIdentityPoolConfigurationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SetIdentityPoolConfigurationOutput) String 

func (s SetIdentityPoolConfigurationOutput) String() string

String returns the string representation

type SetIdentityPoolConfigurationRequest 

type SetIdentityPoolConfigurationRequest struct {
	*aws.Request
	Input *SetIdentityPoolConfigurationInput
	Copy  func(*SetIdentityPoolConfigurationInput) SetIdentityPoolConfigurationRequest
}

SetIdentityPoolConfigurationRequest is a API request type for the SetIdentityPoolConfiguration API operation.

func (SetIdentityPoolConfigurationRequest) Send 

func (r SetIdentityPoolConfigurationRequest) Send() (*SetIdentityPoolConfigurationOutput, error)

Send marshals and sends the SetIdentityPoolConfiguration API request.

type StreamingStatus 

type StreamingStatus string
const (
	StreamingStatusEnabled  StreamingStatus = "ENABLED"
	StreamingStatusDisabled StreamingStatus = "DISABLED"
)

Enum values for StreamingStatus

func (StreamingStatus) MarshalValue added in v0.3.0 

func (enum StreamingStatus) MarshalValue() (string, error)

func (StreamingStatus) MarshalValueBuf added in v0.3.0 

func (enum StreamingStatus) MarshalValueBuf(b []byte) ([]byte, error)

type SubscribeToDatasetInput 

type SubscribeToDatasetInput struct {

	// The name of the dataset to subcribe to.
	//
	// DatasetName is a required field
	DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"`

	// The unique ID generated for this device by Cognito.
	//
	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"`

	// Unique ID for this identity.
	//
	// IdentityId is a required field
	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 is a required field
	IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to SubscribeToDatasetRequest. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SubscribeToDatasetRequest

func (SubscribeToDatasetInput) GoString 

func (s SubscribeToDatasetInput) GoString() string

GoString returns the string representation

func (SubscribeToDatasetInput) MarshalFields added in v0.3.0 

func (s SubscribeToDatasetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SubscribeToDatasetResponse

func (SubscribeToDatasetOutput) GoString 

func (s SubscribeToDatasetOutput) GoString() string

GoString returns the string representation

func (SubscribeToDatasetOutput) MarshalFields added in v0.3.0 

func (s SubscribeToDatasetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SubscribeToDatasetOutput) SDKResponseMetadata 

func (s SubscribeToDatasetOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SubscribeToDatasetOutput) String 

func (s SubscribeToDatasetOutput) String() string

String returns the string representation

type SubscribeToDatasetRequest 

type SubscribeToDatasetRequest struct {
	*aws.Request
	Input *SubscribeToDatasetInput
	Copy  func(*SubscribeToDatasetInput) SubscribeToDatasetRequest
}

SubscribeToDatasetRequest is a API request type for the SubscribeToDataset API operation.

func (SubscribeToDatasetRequest) Send 

func (r SubscribeToDatasetRequest) Send() (*SubscribeToDatasetOutput, error)

Send marshals and sends the SubscribeToDataset API request.

type UnsubscribeFromDatasetInput 

type UnsubscribeFromDatasetInput struct {

	// The name of the dataset from which to unsubcribe.
	//
	// DatasetName is a required field
	DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"`

	// The unique ID generated for this device by Cognito.
	//
	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"`

	// Unique ID for this identity.
	//
	// IdentityId is a required field
	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 is a required field
	IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to UnsubscribeFromDataset. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UnsubscribeFromDatasetRequest

func (UnsubscribeFromDatasetInput) GoString 

func (s UnsubscribeFromDatasetInput) GoString() string

GoString returns the string representation

func (UnsubscribeFromDatasetInput) MarshalFields added in v0.3.0 

func (s UnsubscribeFromDatasetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UnsubscribeFromDatasetResponse

func (UnsubscribeFromDatasetOutput) GoString 

func (s UnsubscribeFromDatasetOutput) GoString() string

GoString returns the string representation

func (UnsubscribeFromDatasetOutput) MarshalFields added in v0.3.0 

func (s UnsubscribeFromDatasetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UnsubscribeFromDatasetOutput) SDKResponseMetadata 

func (s UnsubscribeFromDatasetOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UnsubscribeFromDatasetOutput) String 

func (s UnsubscribeFromDatasetOutput) String() string

String returns the string representation

type UnsubscribeFromDatasetRequest 

type UnsubscribeFromDatasetRequest struct {
	*aws.Request
	Input *UnsubscribeFromDatasetInput
	Copy  func(*UnsubscribeFromDatasetInput) UnsubscribeFromDatasetRequest
}

UnsubscribeFromDatasetRequest is a API request type for the UnsubscribeFromDataset API operation.

func (UnsubscribeFromDatasetRequest) Send 

func (r UnsubscribeFromDatasetRequest) Send() (*UnsubscribeFromDatasetOutput, error)

Send marshals and sends the UnsubscribeFromDataset API request.

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 is a required field
	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 is a required field
	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 is a required field
	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 is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UpdateRecordsRequest

func (UpdateRecordsInput) GoString 

func (s UpdateRecordsInput) GoString() string

GoString returns the string representation

func (UpdateRecordsInput) MarshalFields added in v0.3.0 

func (s UpdateRecordsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UpdateRecordsResponse

func (UpdateRecordsOutput) GoString 

func (s UpdateRecordsOutput) GoString() string

GoString returns the string representation

func (UpdateRecordsOutput) MarshalFields added in v0.3.0 

func (s UpdateRecordsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateRecordsOutput) SDKResponseMetadata 

func (s UpdateRecordsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateRecordsOutput) String 

func (s UpdateRecordsOutput) String() string

String returns the string representation

type UpdateRecordsRequest 

type UpdateRecordsRequest struct {
	*aws.Request
	Input *UpdateRecordsInput
	Copy  func(*UpdateRecordsInput) UpdateRecordsRequest
}

UpdateRecordsRequest is a API request type for the UpdateRecords API operation.

func (UpdateRecordsRequest) Send 

func (r UpdateRecordsRequest) Send() (*UpdateRecordsOutput, error)

Send marshals and sends the UpdateRecords API request.

Source Files

View all Source files

Directories

Path Synopsis
Package cognitosynciface provides an interface to enable mocking the Amazon Cognito Sync service client for testing your code.
 Package cognitosynciface provides an interface to enable mocking the Amazon Cognito Sync service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.