cognitosync

package
v1.12.39 Latest Latest
Warning

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

 Go to latest Published: Dec 1, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

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 contact 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 (
	// BulkPublishStatusNotStarted is a BulkPublishStatus enum value
	BulkPublishStatusNotStarted = "NOT_STARTED"

	// BulkPublishStatusInProgress is a BulkPublishStatus enum value
	BulkPublishStatusInProgress = "IN_PROGRESS"

	// BulkPublishStatusFailed is a BulkPublishStatus enum value
	BulkPublishStatusFailed = "FAILED"

	// BulkPublishStatusSucceeded is a BulkPublishStatus enum value
	BulkPublishStatusSucceeded = "SUCCEEDED"
)
View Source 
const (
	// OperationReplace is a Operation enum value
	OperationReplace = "replace"

	// OperationRemove is a Operation enum value
	OperationRemove = "remove"
)
View Source 
const (
	// PlatformApns is a Platform enum value
	PlatformApns = "APNS"

	// PlatformApnsSandbox is a Platform enum value
	PlatformApnsSandbox = "APNS_SANDBOX"

	// PlatformGcm is a Platform enum value
	PlatformGcm = "GCM"

	// PlatformAdm is a Platform enum value
	PlatformAdm = "ADM"
)
View Source 
const (
	// StreamingStatusEnabled is a StreamingStatus enum value
	StreamingStatusEnabled = "ENABLED"

	// StreamingStatusDisabled is a StreamingStatus enum value
	StreamingStatusDisabled = "DISABLED"
)
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 added in v0.6.5 

func (s BulkPublishInput) GoString() string

GoString returns the string representation

func (*BulkPublishInput) SetIdentityPoolId added in v1.5.0 

func (s *BulkPublishInput) SetIdentityPoolId(v string) *BulkPublishInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (BulkPublishInput) String added in v0.6.5 

func (s BulkPublishInput) String() string

String returns the string representation

func (*BulkPublishInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s BulkPublishOutput) GoString() string

GoString returns the string representation

func (*BulkPublishOutput) SetIdentityPoolId added in v1.5.0 

func (s *BulkPublishOutput) SetIdentityPoolId(v string) *BulkPublishOutput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (BulkPublishOutput) String added in v0.6.5 

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

func (CognitoStreams) GoString added in v0.6.5 

func (s CognitoStreams) GoString() string

GoString returns the string representation

func (*CognitoStreams) SetRoleArn added in v1.5.0 

func (s *CognitoStreams) SetRoleArn(v string) *CognitoStreams

SetRoleArn sets the RoleArn field's value.

func (*CognitoStreams) SetStreamName added in v1.5.0 

func (s *CognitoStreams) SetStreamName(v string) *CognitoStreams

SetStreamName sets the StreamName field's value.

func (*CognitoStreams) SetStreamingStatus added in v1.5.0 

func (s *CognitoStreams) SetStreamingStatus(v string) *CognitoStreams

SetStreamingStatus sets the StreamingStatus field's value.

func (CognitoStreams) String added in v0.6.5 

func (s CognitoStreams) String() string

String returns the string representation

func (*CognitoStreams) Validate added in v1.1.21 

func (s *CognitoStreams) Validate() error

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

type CognitoSync 

type CognitoSync struct {
	*client.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(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)

BulkPublish 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation BulkPublish for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeDuplicateRequestException "DuplicateRequestException" An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool.

  • ErrCodeAlreadyStreamedException "AlreadyStreamedException" An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BulkPublish for more information on using the BulkPublish API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) BulkPublishWithContext added in v1.8.0 

func (c *CognitoSync) BulkPublishWithContext(ctx aws.Context, input *BulkPublishInput, opts ...request.Option) (*BulkPublishOutput, error)

BulkPublishWithContext is the same as BulkPublish with the addition of the ability to pass a context and additional request options.

See BulkPublish for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) DeleteDataset 

func (c *CognitoSync) DeleteDataset(input *DeleteDatasetInput) (*DeleteDatasetOutput, error)

DeleteDataset 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation DeleteDataset for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDataset for more information on using the DeleteDataset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) DeleteDatasetWithContext added in v1.8.0 

func (c *CognitoSync) DeleteDatasetWithContext(ctx aws.Context, input *DeleteDatasetInput, opts ...request.Option) (*DeleteDatasetOutput, error)

DeleteDatasetWithContext is the same as DeleteDataset with the addition of the ability to pass a context and additional request options.

See DeleteDataset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) DescribeDataset 

func (c *CognitoSync) DescribeDataset(input *DescribeDatasetInput) (*DescribeDatasetOutput, error)

DescribeDataset 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation DescribeDataset for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDataset for more information on using the DescribeDataset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) DescribeDatasetWithContext added in v1.8.0 

func (c *CognitoSync) DescribeDatasetWithContext(ctx aws.Context, input *DescribeDatasetInput, opts ...request.Option) (*DescribeDatasetOutput, error)

DescribeDatasetWithContext is the same as DescribeDataset with the addition of the ability to pass a context and additional request options.

See DescribeDataset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) DescribeIdentityPoolUsage 

func (c *CognitoSync) DescribeIdentityPoolUsage(input *DescribeIdentityPoolUsageInput) (*DescribeIdentityPoolUsageOutput, error)

DescribeIdentityPoolUsage 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation DescribeIdentityPoolUsage for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeIdentityPoolUsage for more information on using the DescribeIdentityPoolUsage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) DescribeIdentityPoolUsageWithContext added in v1.8.0 

func (c *CognitoSync) DescribeIdentityPoolUsageWithContext(ctx aws.Context, input *DescribeIdentityPoolUsageInput, opts ...request.Option) (*DescribeIdentityPoolUsageOutput, error)

DescribeIdentityPoolUsageWithContext is the same as DescribeIdentityPoolUsage with the addition of the ability to pass a context and additional request options.

See DescribeIdentityPoolUsage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) DescribeIdentityUsage 

func (c *CognitoSync) DescribeIdentityUsage(input *DescribeIdentityUsageInput) (*DescribeIdentityUsageOutput, error)

DescribeIdentityUsage 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation DescribeIdentityUsage for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeIdentityUsage for more information on using the DescribeIdentityUsage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) DescribeIdentityUsageWithContext added in v1.8.0 

func (c *CognitoSync) DescribeIdentityUsageWithContext(ctx aws.Context, input *DescribeIdentityUsageInput, opts ...request.Option) (*DescribeIdentityUsageOutput, error)

DescribeIdentityUsageWithContext is the same as DescribeIdentityUsage with the addition of the ability to pass a context and additional request options.

See DescribeIdentityUsage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) GetBulkPublishDetails 

func (c *CognitoSync) GetBulkPublishDetails(input *GetBulkPublishDetailsInput) (*GetBulkPublishDetailsOutput, error)

GetBulkPublishDetails 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation GetBulkPublishDetails for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBulkPublishDetails for more information on using the GetBulkPublishDetails API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) GetBulkPublishDetailsWithContext added in v1.8.0 

func (c *CognitoSync) GetBulkPublishDetailsWithContext(ctx aws.Context, input *GetBulkPublishDetailsInput, opts ...request.Option) (*GetBulkPublishDetailsOutput, error)

GetBulkPublishDetailsWithContext is the same as GetBulkPublishDetails with the addition of the ability to pass a context and additional request options.

See GetBulkPublishDetails for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) GetCognitoEvents 

func (c *CognitoSync) GetCognitoEvents(input *GetCognitoEventsInput) (*GetCognitoEventsOutput, error)

GetCognitoEvents 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation GetCognitoEvents for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCognitoEvents for more information on using the GetCognitoEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) GetCognitoEventsWithContext added in v1.8.0 

func (c *CognitoSync) GetCognitoEventsWithContext(ctx aws.Context, input *GetCognitoEventsInput, opts ...request.Option) (*GetCognitoEventsOutput, error)

GetCognitoEventsWithContext is the same as GetCognitoEvents with the addition of the ability to pass a context and additional request options.

See GetCognitoEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) GetIdentityPoolConfiguration 

func (c *CognitoSync) GetIdentityPoolConfiguration(input *GetIdentityPoolConfigurationInput) (*GetIdentityPoolConfigurationOutput, error)

GetIdentityPoolConfiguration 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation GetIdentityPoolConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetIdentityPoolConfiguration for more information on using the GetIdentityPoolConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) GetIdentityPoolConfigurationWithContext added in v1.8.0 

func (c *CognitoSync) GetIdentityPoolConfigurationWithContext(ctx aws.Context, input *GetIdentityPoolConfigurationInput, opts ...request.Option) (*GetIdentityPoolConfigurationOutput, error)

GetIdentityPoolConfigurationWithContext is the same as GetIdentityPoolConfiguration with the addition of the ability to pass a context and additional request options.

See GetIdentityPoolConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) ListDatasets 

func (c *CognitoSync) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error)

ListDatasets 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation ListDatasets for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDatasets for more information on using the ListDatasets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) ListDatasetsWithContext added in v1.8.0 

func (c *CognitoSync) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, error)

ListDatasetsWithContext is the same as ListDatasets with the addition of the ability to pass a context and additional request options.

See ListDatasets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) ListIdentityPoolUsage 

func (c *CognitoSync) ListIdentityPoolUsage(input *ListIdentityPoolUsageInput) (*ListIdentityPoolUsageOutput, error)

ListIdentityPoolUsage 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation ListIdentityPoolUsage for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIdentityPoolUsage for more information on using the ListIdentityPoolUsage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) ListIdentityPoolUsageWithContext added in v1.8.0 

func (c *CognitoSync) ListIdentityPoolUsageWithContext(ctx aws.Context, input *ListIdentityPoolUsageInput, opts ...request.Option) (*ListIdentityPoolUsageOutput, error)

ListIdentityPoolUsageWithContext is the same as ListIdentityPoolUsage with the addition of the ability to pass a context and additional request options.

See ListIdentityPoolUsage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) ListRecords 

func (c *CognitoSync) ListRecords(input *ListRecordsInput) (*ListRecordsOutput, error)

ListRecords 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation ListRecords for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRecords for more information on using the ListRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) ListRecordsWithContext added in v1.8.0 

func (c *CognitoSync) ListRecordsWithContext(ctx aws.Context, input *ListRecordsInput, opts ...request.Option) (*ListRecordsOutput, error)

ListRecordsWithContext is the same as ListRecords with the addition of the ability to pass a context and additional request options.

See ListRecords for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) RegisterDevice 

func (c *CognitoSync) RegisterDevice(input *RegisterDeviceInput) (*RegisterDeviceOutput, error)

RegisterDevice 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation RegisterDevice for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeInvalidConfigurationException "InvalidConfigurationException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterDevice for more information on using the RegisterDevice API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) RegisterDeviceWithContext added in v1.8.0 

func (c *CognitoSync) RegisterDeviceWithContext(ctx aws.Context, input *RegisterDeviceInput, opts ...request.Option) (*RegisterDeviceOutput, error)

RegisterDeviceWithContext is the same as RegisterDevice with the addition of the ability to pass a context and additional request options.

See RegisterDevice for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) SetCognitoEvents 

func (c *CognitoSync) SetCognitoEvents(input *SetCognitoEventsInput) (*SetCognitoEventsOutput, error)

SetCognitoEvents 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation SetCognitoEvents for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetCognitoEvents for more information on using the SetCognitoEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) SetCognitoEventsWithContext added in v1.8.0 

func (c *CognitoSync) SetCognitoEventsWithContext(ctx aws.Context, input *SetCognitoEventsInput, opts ...request.Option) (*SetCognitoEventsOutput, error)

SetCognitoEventsWithContext is the same as SetCognitoEvents with the addition of the ability to pass a context and additional request options.

See SetCognitoEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) SetIdentityPoolConfiguration 

func (c *CognitoSync) SetIdentityPoolConfiguration(input *SetIdentityPoolConfigurationInput) (*SetIdentityPoolConfigurationOutput, error)

SetIdentityPoolConfiguration 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation SetIdentityPoolConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" Thrown if there are parallel requests to modify a resource.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetIdentityPoolConfiguration for more information on using the SetIdentityPoolConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) SetIdentityPoolConfigurationWithContext added in v1.8.0 

func (c *CognitoSync) SetIdentityPoolConfigurationWithContext(ctx aws.Context, input *SetIdentityPoolConfigurationInput, opts ...request.Option) (*SetIdentityPoolConfigurationOutput, error)

SetIdentityPoolConfigurationWithContext is the same as SetIdentityPoolConfiguration with the addition of the ability to pass a context and additional request options.

See SetIdentityPoolConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) SubscribeToDataset 

func (c *CognitoSync) SubscribeToDataset(input *SubscribeToDatasetInput) (*SubscribeToDatasetOutput, error)

SubscribeToDataset 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation SubscribeToDataset for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeInvalidConfigurationException "InvalidConfigurationException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SubscribeToDataset for more information on using the SubscribeToDataset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) SubscribeToDatasetWithContext added in v1.8.0 

func (c *CognitoSync) SubscribeToDatasetWithContext(ctx aws.Context, input *SubscribeToDatasetInput, opts ...request.Option) (*SubscribeToDatasetOutput, error)

SubscribeToDatasetWithContext is the same as SubscribeToDataset with the addition of the ability to pass a context and additional request options.

See SubscribeToDataset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) UnsubscribeFromDataset 

func (c *CognitoSync) UnsubscribeFromDataset(input *UnsubscribeFromDatasetInput) (*UnsubscribeFromDatasetOutput, error)

UnsubscribeFromDataset 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation UnsubscribeFromDataset for usage and error information.

Returned Error Codes:

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

  • ErrCodeInvalidConfigurationException "InvalidConfigurationException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UnsubscribeFromDataset for more information on using the UnsubscribeFromDataset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) UnsubscribeFromDatasetWithContext added in v1.8.0 

func (c *CognitoSync) UnsubscribeFromDatasetWithContext(ctx aws.Context, input *UnsubscribeFromDatasetInput, opts ...request.Option) (*UnsubscribeFromDatasetOutput, error)

UnsubscribeFromDatasetWithContext is the same as UnsubscribeFromDataset with the addition of the ability to pass a context and additional request options.

See UnsubscribeFromDataset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoSync) UpdateRecords 

func (c *CognitoSync) UpdateRecords(input *UpdateRecordsInput) (*UpdateRecordsOutput, error)

UpdateRecords 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Sync's API operation UpdateRecords for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown when a request parameter does not comply with the associated constraints.

  • ErrCodeLimitExceededException "LimitExceededException" Thrown when the limit on the number of objects or operations has been exceeded.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown if the resource doesn't exist.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.

  • ErrCodeInvalidLambdaFunctionOutputException "InvalidLambdaFunctionOutputException" The AWS Lambda function returned invalid output or an exception.

  • ErrCodeLambdaThrottledException "LambdaThrottledException" AWS Lambda throttled your account, please contact AWS Support

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown if the request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Indicates an internal service error.

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

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 will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRecords for more information on using the UpdateRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

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

func (*CognitoSync) UpdateRecordsWithContext added in v1.8.0 

func (c *CognitoSync) UpdateRecordsWithContext(ctx aws.Context, input *UpdateRecordsInput, opts ...request.Option) (*UpdateRecordsOutput, error)

UpdateRecordsWithContext is the same as UpdateRecords with the addition of the ability to pass a context and additional request options.

See UpdateRecords for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 added in v0.6.5 

func (s Dataset) GoString() string

GoString returns the string representation

func (*Dataset) SetCreationDate added in v1.5.0 

func (s *Dataset) SetCreationDate(v time.Time) *Dataset

SetCreationDate sets the CreationDate field's value.

func (*Dataset) SetDataStorage added in v1.5.0 

func (s *Dataset) SetDataStorage(v int64) *Dataset

SetDataStorage sets the DataStorage field's value.

func (*Dataset) SetDatasetName added in v1.5.0 

func (s *Dataset) SetDatasetName(v string) *Dataset

SetDatasetName sets the DatasetName field's value.

func (*Dataset) SetIdentityId added in v1.5.0 

func (s *Dataset) SetIdentityId(v string) *Dataset

SetIdentityId sets the IdentityId field's value.

func (*Dataset) SetLastModifiedBy added in v1.5.0 

func (s *Dataset) SetLastModifiedBy(v string) *Dataset

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*Dataset) SetLastModifiedDate added in v1.5.0 

func (s *Dataset) SetLastModifiedDate(v time.Time) *Dataset

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*Dataset) SetNumRecords added in v1.5.0 

func (s *Dataset) SetNumRecords(v int64) *Dataset

SetNumRecords sets the NumRecords field's value.

func (Dataset) String added in v0.6.5 

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 added in v0.6.5 

func (s DeleteDatasetInput) GoString() string

GoString returns the string representation

func (*DeleteDatasetInput) SetDatasetName added in v1.5.0 

func (s *DeleteDatasetInput) SetDatasetName(v string) *DeleteDatasetInput

SetDatasetName sets the DatasetName field's value.

func (*DeleteDatasetInput) SetIdentityId added in v1.5.0 

func (s *DeleteDatasetInput) SetIdentityId(v string) *DeleteDatasetInput

SetIdentityId sets the IdentityId field's value.

func (*DeleteDatasetInput) SetIdentityPoolId added in v1.5.0 

func (s *DeleteDatasetInput) SetIdentityPoolId(v string) *DeleteDatasetInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (DeleteDatasetInput) String added in v0.6.5 

func (s DeleteDatasetInput) String() string

String returns the string representation

func (*DeleteDatasetInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DeleteDatasetOutput) GoString() string

GoString returns the string representation

func (*DeleteDatasetOutput) SetDataset added in v1.5.0 

func (s *DeleteDatasetOutput) SetDataset(v *Dataset) *DeleteDatasetOutput

SetDataset sets the Dataset field's value.

func (DeleteDatasetOutput) String added in v0.6.5 

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 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 added in v0.6.5 

func (s DescribeDatasetInput) GoString() string

GoString returns the string representation

func (*DescribeDatasetInput) SetDatasetName added in v1.5.0 

func (s *DescribeDatasetInput) SetDatasetName(v string) *DescribeDatasetInput

SetDatasetName sets the DatasetName field's value.

func (*DescribeDatasetInput) SetIdentityId added in v1.5.0 

func (s *DescribeDatasetInput) SetIdentityId(v string) *DescribeDatasetInput

SetIdentityId sets the IdentityId field's value.

func (*DescribeDatasetInput) SetIdentityPoolId added in v1.5.0 

func (s *DescribeDatasetInput) SetIdentityPoolId(v string) *DescribeDatasetInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (DescribeDatasetInput) String added in v0.6.5 

func (s DescribeDatasetInput) String() string

String returns the string representation

func (*DescribeDatasetInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DescribeDatasetOutput) GoString() string

GoString returns the string representation

func (*DescribeDatasetOutput) SetDataset added in v1.5.0 

func (s *DescribeDatasetOutput) SetDataset(v *Dataset) *DescribeDatasetOutput

SetDataset sets the Dataset field's value.

func (DescribeDatasetOutput) String added in v0.6.5 

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 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 added in v0.6.5 

func (s DescribeIdentityPoolUsageInput) GoString() string

GoString returns the string representation

func (*DescribeIdentityPoolUsageInput) SetIdentityPoolId added in v1.5.0 

func (s *DescribeIdentityPoolUsageInput) SetIdentityPoolId(v string) *DescribeIdentityPoolUsageInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (DescribeIdentityPoolUsageInput) String added in v0.6.5 

func (s DescribeIdentityPoolUsageInput) String() string

String returns the string representation

func (*DescribeIdentityPoolUsageInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DescribeIdentityPoolUsageOutput) GoString() string

GoString returns the string representation

func (*DescribeIdentityPoolUsageOutput) SetIdentityPoolUsage added in v1.5.0 

func (s *DescribeIdentityPoolUsageOutput) SetIdentityPoolUsage(v *IdentityPoolUsage) *DescribeIdentityPoolUsageOutput

SetIdentityPoolUsage sets the IdentityPoolUsage field's value.

func (DescribeIdentityPoolUsageOutput) String added in v0.6.5 

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 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 added in v0.6.5 

func (s DescribeIdentityUsageInput) GoString() string

GoString returns the string representation

func (*DescribeIdentityUsageInput) SetIdentityId added in v1.5.0 

func (s *DescribeIdentityUsageInput) SetIdentityId(v string) *DescribeIdentityUsageInput

SetIdentityId sets the IdentityId field's value.

func (*DescribeIdentityUsageInput) SetIdentityPoolId added in v1.5.0 

func (s *DescribeIdentityUsageInput) SetIdentityPoolId(v string) *DescribeIdentityUsageInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (DescribeIdentityUsageInput) String added in v0.6.5 

func (s DescribeIdentityUsageInput) String() string

String returns the string representation

func (*DescribeIdentityUsageInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DescribeIdentityUsageOutput) GoString() string

GoString returns the string representation

func (*DescribeIdentityUsageOutput) SetIdentityUsage added in v1.5.0 

func (s *DescribeIdentityUsageOutput) SetIdentityUsage(v *IdentityUsage) *DescribeIdentityUsageOutput

SetIdentityUsage sets the IdentityUsage field's value.

func (DescribeIdentityUsageOutput) String added in v0.6.5 

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 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 added in v0.6.5 

func (s GetBulkPublishDetailsInput) GoString() string

GoString returns the string representation

func (*GetBulkPublishDetailsInput) SetIdentityPoolId added in v1.5.0 

func (s *GetBulkPublishDetailsInput) SetIdentityPoolId(v string) *GetBulkPublishDetailsInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (GetBulkPublishDetailsInput) String added in v0.6.5 

func (s GetBulkPublishDetailsInput) String() string

String returns the string representation

func (*GetBulkPublishDetailsInput) Validate added in v1.1.21 

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

func (GetBulkPublishDetailsOutput) GoString added in v0.6.5 

func (s GetBulkPublishDetailsOutput) GoString() string

GoString returns the string representation

func (*GetBulkPublishDetailsOutput) SetBulkPublishCompleteTime added in v1.5.0 

func (s *GetBulkPublishDetailsOutput) SetBulkPublishCompleteTime(v time.Time) *GetBulkPublishDetailsOutput

SetBulkPublishCompleteTime sets the BulkPublishCompleteTime field's value.

func (*GetBulkPublishDetailsOutput) SetBulkPublishStartTime added in v1.5.0 

func (s *GetBulkPublishDetailsOutput) SetBulkPublishStartTime(v time.Time) *GetBulkPublishDetailsOutput

SetBulkPublishStartTime sets the BulkPublishStartTime field's value.

func (*GetBulkPublishDetailsOutput) SetBulkPublishStatus added in v1.5.0 

func (s *GetBulkPublishDetailsOutput) SetBulkPublishStatus(v string) *GetBulkPublishDetailsOutput

SetBulkPublishStatus sets the BulkPublishStatus field's value.

func (*GetBulkPublishDetailsOutput) SetFailureMessage added in v1.5.0 

func (s *GetBulkPublishDetailsOutput) SetFailureMessage(v string) *GetBulkPublishDetailsOutput

SetFailureMessage sets the FailureMessage field's value.

func (*GetBulkPublishDetailsOutput) SetIdentityPoolId added in v1.5.0 

func (s *GetBulkPublishDetailsOutput) SetIdentityPoolId(v string) *GetBulkPublishDetailsOutput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (GetBulkPublishDetailsOutput) String added in v0.6.5 

func (s GetBulkPublishDetailsOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s GetCognitoEventsInput) GoString() string

GoString returns the string representation

func (*GetCognitoEventsInput) SetIdentityPoolId added in v1.5.0 

func (s *GetCognitoEventsInput) SetIdentityPoolId(v string) *GetCognitoEventsInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (GetCognitoEventsInput) String added in v0.6.5 

func (s GetCognitoEventsInput) String() string

String returns the string representation

func (*GetCognitoEventsInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s GetCognitoEventsOutput) GoString() string

GoString returns the string representation

func (*GetCognitoEventsOutput) SetEvents added in v1.5.0 

func (s *GetCognitoEventsOutput) SetEvents(v map[string]*string) *GetCognitoEventsOutput

SetEvents sets the Events field's value.

func (GetCognitoEventsOutput) String added in v0.6.5 

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 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 added in v0.6.5 

func (s GetIdentityPoolConfigurationInput) GoString() string

GoString returns the string representation

func (*GetIdentityPoolConfigurationInput) SetIdentityPoolId added in v1.5.0 

func (s *GetIdentityPoolConfigurationInput) SetIdentityPoolId(v string) *GetIdentityPoolConfigurationInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (GetIdentityPoolConfigurationInput) String added in v0.6.5 

func (s GetIdentityPoolConfigurationInput) String() string

String returns the string representation

func (*GetIdentityPoolConfigurationInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s GetIdentityPoolConfigurationOutput) GoString() string

GoString returns the string representation

func (*GetIdentityPoolConfigurationOutput) SetCognitoStreams added in v1.5.0 

func (s *GetIdentityPoolConfigurationOutput) SetCognitoStreams(v *CognitoStreams) *GetIdentityPoolConfigurationOutput

SetCognitoStreams sets the CognitoStreams field's value.

func (*GetIdentityPoolConfigurationOutput) SetIdentityPoolId added in v1.5.0 

func (s *GetIdentityPoolConfigurationOutput) SetIdentityPoolId(v string) *GetIdentityPoolConfigurationOutput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*GetIdentityPoolConfigurationOutput) SetPushSync added in v1.5.0 

func (s *GetIdentityPoolConfigurationOutput) SetPushSync(v *PushSync) *GetIdentityPoolConfigurationOutput

SetPushSync sets the PushSync field's value.

func (GetIdentityPoolConfigurationOutput) String added in v0.6.5 

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

func (IdentityPoolUsage) GoString added in v0.6.5 

func (s IdentityPoolUsage) GoString() string

GoString returns the string representation

func (*IdentityPoolUsage) SetDataStorage added in v1.5.0 

func (s *IdentityPoolUsage) SetDataStorage(v int64) *IdentityPoolUsage

SetDataStorage sets the DataStorage field's value.

func (*IdentityPoolUsage) SetIdentityPoolId added in v1.5.0 

func (s *IdentityPoolUsage) SetIdentityPoolId(v string) *IdentityPoolUsage

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*IdentityPoolUsage) SetLastModifiedDate added in v1.5.0 

func (s *IdentityPoolUsage) SetLastModifiedDate(v time.Time) *IdentityPoolUsage

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*IdentityPoolUsage) SetSyncSessionsCount added in v1.5.0 

func (s *IdentityPoolUsage) SetSyncSessionsCount(v int64) *IdentityPoolUsage

SetSyncSessionsCount sets the SyncSessionsCount field's value.

func (IdentityPoolUsage) String added in v0.6.5 

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 added in v0.6.5 

func (s IdentityUsage) GoString() string

GoString returns the string representation

func (*IdentityUsage) SetDataStorage added in v1.5.0 

func (s *IdentityUsage) SetDataStorage(v int64) *IdentityUsage

SetDataStorage sets the DataStorage field's value.

func (*IdentityUsage) SetDatasetCount added in v1.5.0 

func (s *IdentityUsage) SetDatasetCount(v int64) *IdentityUsage

SetDatasetCount sets the DatasetCount field's value.

func (*IdentityUsage) SetIdentityId added in v1.5.0 

func (s *IdentityUsage) SetIdentityId(v string) *IdentityUsage

SetIdentityId sets the IdentityId field's value.

func (*IdentityUsage) SetIdentityPoolId added in v1.5.0 

func (s *IdentityUsage) SetIdentityPoolId(v string) *IdentityUsage

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*IdentityUsage) SetLastModifiedDate added in v1.5.0 

func (s *IdentityUsage) SetLastModifiedDate(v time.Time) *IdentityUsage

SetLastModifiedDate sets the LastModifiedDate field's value.

func (IdentityUsage) String added in v0.6.5 

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 added in v0.6.5 

func (s ListDatasetsInput) GoString() string

GoString returns the string representation

func (*ListDatasetsInput) SetIdentityId added in v1.5.0 

func (s *ListDatasetsInput) SetIdentityId(v string) *ListDatasetsInput

SetIdentityId sets the IdentityId field's value.

func (*ListDatasetsInput) SetIdentityPoolId added in v1.5.0 

func (s *ListDatasetsInput) SetIdentityPoolId(v string) *ListDatasetsInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*ListDatasetsInput) SetMaxResults added in v1.5.0 

func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetsInput) SetNextToken added in v1.5.0 

func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput

SetNextToken sets the NextToken field's value.

func (ListDatasetsInput) String added in v0.6.5 

func (s ListDatasetsInput) String() string

String returns the string representation

func (*ListDatasetsInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s ListDatasetsOutput) GoString() string

GoString returns the string representation

func (*ListDatasetsOutput) SetCount added in v1.5.0 

func (s *ListDatasetsOutput) SetCount(v int64) *ListDatasetsOutput

SetCount sets the Count field's value.

func (*ListDatasetsOutput) SetDatasets added in v1.5.0 

func (s *ListDatasetsOutput) SetDatasets(v []*Dataset) *ListDatasetsOutput

SetDatasets sets the Datasets field's value.

func (*ListDatasetsOutput) SetNextToken added in v1.5.0 

func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput

SetNextToken sets the NextToken field's value.

func (ListDatasetsOutput) String added in v0.6.5 

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

func (ListIdentityPoolUsageInput) GoString added in v0.6.5 

func (s ListIdentityPoolUsageInput) GoString() string

GoString returns the string representation

func (*ListIdentityPoolUsageInput) SetMaxResults added in v1.5.0 

func (s *ListIdentityPoolUsageInput) SetMaxResults(v int64) *ListIdentityPoolUsageInput

SetMaxResults sets the MaxResults field's value.

func (*ListIdentityPoolUsageInput) SetNextToken added in v1.5.0 

func (s *ListIdentityPoolUsageInput) SetNextToken(v string) *ListIdentityPoolUsageInput

SetNextToken sets the NextToken field's value.

func (ListIdentityPoolUsageInput) String added in v0.6.5 

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 added in v0.6.5 

func (s ListIdentityPoolUsageOutput) GoString() string

GoString returns the string representation

func (*ListIdentityPoolUsageOutput) SetCount added in v1.5.0 

func (s *ListIdentityPoolUsageOutput) SetCount(v int64) *ListIdentityPoolUsageOutput

SetCount sets the Count field's value.

func (*ListIdentityPoolUsageOutput) SetIdentityPoolUsages added in v1.5.0 

func (s *ListIdentityPoolUsageOutput) SetIdentityPoolUsages(v []*IdentityPoolUsage) *ListIdentityPoolUsageOutput

SetIdentityPoolUsages sets the IdentityPoolUsages field's value.

func (*ListIdentityPoolUsageOutput) SetMaxResults added in v1.5.0 

func (s *ListIdentityPoolUsageOutput) SetMaxResults(v int64) *ListIdentityPoolUsageOutput

SetMaxResults sets the MaxResults field's value.

func (*ListIdentityPoolUsageOutput) SetNextToken added in v1.5.0 

func (s *ListIdentityPoolUsageOutput) SetNextToken(v string) *ListIdentityPoolUsageOutput

SetNextToken sets the NextToken field's value.

func (ListIdentityPoolUsageOutput) String added in v0.6.5 

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 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 added in v0.6.5 

func (s ListRecordsInput) GoString() string

GoString returns the string representation

func (*ListRecordsInput) SetDatasetName added in v1.5.0 

func (s *ListRecordsInput) SetDatasetName(v string) *ListRecordsInput

SetDatasetName sets the DatasetName field's value.

func (*ListRecordsInput) SetIdentityId added in v1.5.0 

func (s *ListRecordsInput) SetIdentityId(v string) *ListRecordsInput

SetIdentityId sets the IdentityId field's value.

func (*ListRecordsInput) SetIdentityPoolId added in v1.5.0 

func (s *ListRecordsInput) SetIdentityPoolId(v string) *ListRecordsInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*ListRecordsInput) SetLastSyncCount added in v1.5.0 

func (s *ListRecordsInput) SetLastSyncCount(v int64) *ListRecordsInput

SetLastSyncCount sets the LastSyncCount field's value.

func (*ListRecordsInput) SetMaxResults added in v1.5.0 

func (s *ListRecordsInput) SetMaxResults(v int64) *ListRecordsInput

SetMaxResults sets the MaxResults field's value.

func (*ListRecordsInput) SetNextToken added in v1.5.0 

func (s *ListRecordsInput) SetNextToken(v string) *ListRecordsInput

SetNextToken sets the NextToken field's value.

func (*ListRecordsInput) SetSyncSessionToken added in v1.5.0 

func (s *ListRecordsInput) SetSyncSessionToken(v string) *ListRecordsInput

SetSyncSessionToken sets the SyncSessionToken field's value.

func (ListRecordsInput) String added in v0.6.5 

func (s ListRecordsInput) String() string

String returns the string representation

func (*ListRecordsInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s ListRecordsOutput) GoString() string

GoString returns the string representation

func (*ListRecordsOutput) SetCount added in v1.5.0 

func (s *ListRecordsOutput) SetCount(v int64) *ListRecordsOutput

SetCount sets the Count field's value.

func (*ListRecordsOutput) SetDatasetDeletedAfterRequestedSyncCount added in v1.5.0 

func (s *ListRecordsOutput) SetDatasetDeletedAfterRequestedSyncCount(v bool) *ListRecordsOutput

SetDatasetDeletedAfterRequestedSyncCount sets the DatasetDeletedAfterRequestedSyncCount field's value.

func (*ListRecordsOutput) SetDatasetExists added in v1.5.0 

func (s *ListRecordsOutput) SetDatasetExists(v bool) *ListRecordsOutput

SetDatasetExists sets the DatasetExists field's value.

func (*ListRecordsOutput) SetDatasetSyncCount added in v1.5.0 

func (s *ListRecordsOutput) SetDatasetSyncCount(v int64) *ListRecordsOutput

SetDatasetSyncCount sets the DatasetSyncCount field's value.

func (*ListRecordsOutput) SetLastModifiedBy added in v1.5.0 

func (s *ListRecordsOutput) SetLastModifiedBy(v string) *ListRecordsOutput

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*ListRecordsOutput) SetMergedDatasetNames added in v1.5.0 

func (s *ListRecordsOutput) SetMergedDatasetNames(v []*string) *ListRecordsOutput

SetMergedDatasetNames sets the MergedDatasetNames field's value.

func (*ListRecordsOutput) SetNextToken added in v1.5.0 

func (s *ListRecordsOutput) SetNextToken(v string) *ListRecordsOutput

SetNextToken sets the NextToken field's value.

func (*ListRecordsOutput) SetRecords added in v1.5.0 

func (s *ListRecordsOutput) SetRecords(v []*Record) *ListRecordsOutput

SetRecords sets the Records field's value.

func (*ListRecordsOutput) SetSyncSessionToken added in v1.5.0 

func (s *ListRecordsOutput) SetSyncSessionToken(v string) *ListRecordsOutput

SetSyncSessionToken sets the SyncSessionToken field's value.

func (ListRecordsOutput) String added in v0.6.5 

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

func (PushSync) GoString added in v0.6.5 

func (s PushSync) GoString() string

GoString returns the string representation

func (*PushSync) SetApplicationArns added in v1.5.0 

func (s *PushSync) SetApplicationArns(v []*string) *PushSync

SetApplicationArns sets the ApplicationArns field's value.

func (*PushSync) SetRoleArn added in v1.5.0 

func (s *PushSync) SetRoleArn(v string) *PushSync

SetRoleArn sets the RoleArn field's value.

func (PushSync) String added in v0.6.5 

func (s PushSync) String() string

String returns the string representation

func (*PushSync) Validate added in v1.1.21 

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 added in v0.6.5 

func (s Record) GoString() string

GoString returns the string representation

func (*Record) SetDeviceLastModifiedDate added in v1.5.0 

func (s *Record) SetDeviceLastModifiedDate(v time.Time) *Record

SetDeviceLastModifiedDate sets the DeviceLastModifiedDate field's value.

func (*Record) SetKey added in v1.5.0 

func (s *Record) SetKey(v string) *Record

SetKey sets the Key field's value.

func (*Record) SetLastModifiedBy added in v1.5.0 

func (s *Record) SetLastModifiedBy(v string) *Record

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*Record) SetLastModifiedDate added in v1.5.0 

func (s *Record) SetLastModifiedDate(v time.Time) *Record

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*Record) SetSyncCount added in v1.5.0 

func (s *Record) SetSyncCount(v int64) *Record

SetSyncCount sets the SyncCount field's value.

func (*Record) SetValue added in v1.5.0 

func (s *Record) SetValue(v string) *Record

SetValue sets the Value field's value.

func (Record) String added in v0.6.5 

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 *string `type:"string" required:"true" enum:"Operation"`

	// 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 added in v0.6.5 

func (s RecordPatch) GoString() string

GoString returns the string representation

func (*RecordPatch) SetDeviceLastModifiedDate added in v1.5.0 

func (s *RecordPatch) SetDeviceLastModifiedDate(v time.Time) *RecordPatch

SetDeviceLastModifiedDate sets the DeviceLastModifiedDate field's value.

func (*RecordPatch) SetKey added in v1.5.0 

func (s *RecordPatch) SetKey(v string) *RecordPatch

SetKey sets the Key field's value.

func (*RecordPatch) SetOp added in v1.5.0 

func (s *RecordPatch) SetOp(v string) *RecordPatch

SetOp sets the Op field's value.

func (*RecordPatch) SetSyncCount added in v1.5.0 

func (s *RecordPatch) SetSyncCount(v int64) *RecordPatch

SetSyncCount sets the SyncCount field's value.

func (*RecordPatch) SetValue added in v1.5.0 

func (s *RecordPatch) SetValue(v string) *RecordPatch

SetValue sets the Value field's value.

func (RecordPatch) String added in v0.6.5 

func (s RecordPatch) String() string

String returns the string representation

func (*RecordPatch) Validate added in v1.1.21 

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 *string `type:"string" required:"true" enum:"Platform"`

	// 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 added in v0.6.5 

func (s RegisterDeviceInput) GoString() string

GoString returns the string representation

func (*RegisterDeviceInput) SetIdentityId added in v1.5.0 

func (s *RegisterDeviceInput) SetIdentityId(v string) *RegisterDeviceInput

SetIdentityId sets the IdentityId field's value.

func (*RegisterDeviceInput) SetIdentityPoolId added in v1.5.0 

func (s *RegisterDeviceInput) SetIdentityPoolId(v string) *RegisterDeviceInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*RegisterDeviceInput) SetPlatform added in v1.5.0 

func (s *RegisterDeviceInput) SetPlatform(v string) *RegisterDeviceInput

SetPlatform sets the Platform field's value.

func (*RegisterDeviceInput) SetToken added in v1.5.0 

func (s *RegisterDeviceInput) SetToken(v string) *RegisterDeviceInput

SetToken sets the Token field's value.

func (RegisterDeviceInput) String added in v0.6.5 

func (s RegisterDeviceInput) String() string

String returns the string representation

func (*RegisterDeviceInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s RegisterDeviceOutput) GoString() string

GoString returns the string representation

func (*RegisterDeviceOutput) SetDeviceId added in v1.5.0 

func (s *RegisterDeviceOutput) SetDeviceId(v string) *RegisterDeviceOutput

SetDeviceId sets the DeviceId field's value.

func (RegisterDeviceOutput) String added in v0.6.5 

func (s RegisterDeviceOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s SetCognitoEventsInput) GoString() string

GoString returns the string representation

func (*SetCognitoEventsInput) SetEvents added in v1.5.0 

func (s *SetCognitoEventsInput) SetEvents(v map[string]*string) *SetCognitoEventsInput

SetEvents sets the Events field's value.

func (*SetCognitoEventsInput) SetIdentityPoolId added in v1.5.0 

func (s *SetCognitoEventsInput) SetIdentityPoolId(v string) *SetCognitoEventsInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (SetCognitoEventsInput) String added in v0.6.5 

func (s SetCognitoEventsInput) String() string

String returns the string representation

func (*SetCognitoEventsInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s SetCognitoEventsOutput) GoString() string

GoString returns the string representation

func (SetCognitoEventsOutput) String added in v0.6.5 

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 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 added in v0.6.5 

func (s SetIdentityPoolConfigurationInput) GoString() string

GoString returns the string representation

func (*SetIdentityPoolConfigurationInput) SetCognitoStreams added in v1.5.0 

func (s *SetIdentityPoolConfigurationInput) SetCognitoStreams(v *CognitoStreams) *SetIdentityPoolConfigurationInput

SetCognitoStreams sets the CognitoStreams field's value.

func (*SetIdentityPoolConfigurationInput) SetIdentityPoolId added in v1.5.0 

func (s *SetIdentityPoolConfigurationInput) SetIdentityPoolId(v string) *SetIdentityPoolConfigurationInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*SetIdentityPoolConfigurationInput) SetPushSync added in v1.5.0 

func (s *SetIdentityPoolConfigurationInput) SetPushSync(v *PushSync) *SetIdentityPoolConfigurationInput

SetPushSync sets the PushSync field's value.

func (SetIdentityPoolConfigurationInput) String added in v0.6.5 

func (s SetIdentityPoolConfigurationInput) String() string

String returns the string representation

func (*SetIdentityPoolConfigurationInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s SetIdentityPoolConfigurationOutput) GoString() string

GoString returns the string representation

func (*SetIdentityPoolConfigurationOutput) SetCognitoStreams added in v1.5.0 

func (s *SetIdentityPoolConfigurationOutput) SetCognitoStreams(v *CognitoStreams) *SetIdentityPoolConfigurationOutput

SetCognitoStreams sets the CognitoStreams field's value.

func (*SetIdentityPoolConfigurationOutput) SetIdentityPoolId added in v1.5.0 

func (s *SetIdentityPoolConfigurationOutput) SetIdentityPoolId(v string) *SetIdentityPoolConfigurationOutput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*SetIdentityPoolConfigurationOutput) SetPushSync added in v1.5.0 

func (s *SetIdentityPoolConfigurationOutput) SetPushSync(v *PushSync) *SetIdentityPoolConfigurationOutput

SetPushSync sets the PushSync field's value.

func (SetIdentityPoolConfigurationOutput) String added in v0.6.5 

func (s SetIdentityPoolConfigurationOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s SubscribeToDatasetInput) GoString() string

GoString returns the string representation

func (*SubscribeToDatasetInput) SetDatasetName added in v1.5.0 

func (s *SubscribeToDatasetInput) SetDatasetName(v string) *SubscribeToDatasetInput

SetDatasetName sets the DatasetName field's value.

func (*SubscribeToDatasetInput) SetDeviceId added in v1.5.0 

func (s *SubscribeToDatasetInput) SetDeviceId(v string) *SubscribeToDatasetInput

SetDeviceId sets the DeviceId field's value.

func (*SubscribeToDatasetInput) SetIdentityId added in v1.5.0 

func (s *SubscribeToDatasetInput) SetIdentityId(v string) *SubscribeToDatasetInput

SetIdentityId sets the IdentityId field's value.

func (*SubscribeToDatasetInput) SetIdentityPoolId added in v1.5.0 

func (s *SubscribeToDatasetInput) SetIdentityPoolId(v string) *SubscribeToDatasetInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (SubscribeToDatasetInput) String added in v0.6.5 

func (s SubscribeToDatasetInput) String() string

String returns the string representation

func (*SubscribeToDatasetInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s SubscribeToDatasetOutput) GoString() string

GoString returns the string representation

func (SubscribeToDatasetOutput) String added in v0.6.5 

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 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 added in v0.6.5 

func (s UnsubscribeFromDatasetInput) GoString() string

GoString returns the string representation

func (*UnsubscribeFromDatasetInput) SetDatasetName added in v1.5.0 

func (s *UnsubscribeFromDatasetInput) SetDatasetName(v string) *UnsubscribeFromDatasetInput

SetDatasetName sets the DatasetName field's value.

func (*UnsubscribeFromDatasetInput) SetDeviceId added in v1.5.0 

func (s *UnsubscribeFromDatasetInput) SetDeviceId(v string) *UnsubscribeFromDatasetInput

SetDeviceId sets the DeviceId field's value.

func (*UnsubscribeFromDatasetInput) SetIdentityId added in v1.5.0 

func (s *UnsubscribeFromDatasetInput) SetIdentityId(v string) *UnsubscribeFromDatasetInput

SetIdentityId sets the IdentityId field's value.

func (*UnsubscribeFromDatasetInput) SetIdentityPoolId added in v1.5.0 

func (s *UnsubscribeFromDatasetInput) SetIdentityPoolId(v string) *UnsubscribeFromDatasetInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (UnsubscribeFromDatasetInput) String added in v0.6.5 

func (s UnsubscribeFromDatasetInput) String() string

String returns the string representation

func (*UnsubscribeFromDatasetInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s UnsubscribeFromDatasetOutput) GoString() string

GoString returns the string representation

func (UnsubscribeFromDatasetOutput) String added in v0.6.5 

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 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 added in v0.6.5 

func (s UpdateRecordsInput) GoString() string

GoString returns the string representation

func (*UpdateRecordsInput) SetClientContext added in v1.5.0 

func (s *UpdateRecordsInput) SetClientContext(v string) *UpdateRecordsInput

SetClientContext sets the ClientContext field's value.

func (*UpdateRecordsInput) SetDatasetName added in v1.5.0 

func (s *UpdateRecordsInput) SetDatasetName(v string) *UpdateRecordsInput

SetDatasetName sets the DatasetName field's value.

func (*UpdateRecordsInput) SetDeviceId added in v1.5.0 

func (s *UpdateRecordsInput) SetDeviceId(v string) *UpdateRecordsInput

SetDeviceId sets the DeviceId field's value.

func (*UpdateRecordsInput) SetIdentityId added in v1.5.0 

func (s *UpdateRecordsInput) SetIdentityId(v string) *UpdateRecordsInput

SetIdentityId sets the IdentityId field's value.

func (*UpdateRecordsInput) SetIdentityPoolId added in v1.5.0 

func (s *UpdateRecordsInput) SetIdentityPoolId(v string) *UpdateRecordsInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*UpdateRecordsInput) SetRecordPatches added in v1.5.0 

func (s *UpdateRecordsInput) SetRecordPatches(v []*RecordPatch) *UpdateRecordsInput

SetRecordPatches sets the RecordPatches field's value.

func (*UpdateRecordsInput) SetSyncSessionToken added in v1.5.0 

func (s *UpdateRecordsInput) SetSyncSessionToken(v string) *UpdateRecordsInput

SetSyncSessionToken sets the SyncSessionToken field's value.

func (UpdateRecordsInput) String added in v0.6.5 

func (s UpdateRecordsInput) String() string

String returns the string representation

func (*UpdateRecordsInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s UpdateRecordsOutput) GoString() string

GoString returns the string representation

func (*UpdateRecordsOutput) SetRecords added in v1.5.0 

func (s *UpdateRecordsOutput) SetRecords(v []*Record) *UpdateRecordsOutput

SetRecords sets the Records field's value.

func (UpdateRecordsOutput) String added in v0.6.5 

func (s UpdateRecordsOutput) String() string

String returns the string representation

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.