simpledb

package
v2.0.0-preview.4+incom... Latest Latest
Warning

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

 Go to latest Published: May 26, 2018 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package simpledb provides the client and types for making API requests to Amazon SimpleDB.

Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud. By offloading the time and effort associated with building and operating a web-scale database, SimpleDB provides developers the freedom to focus on application development. A traditional, clustered relational database requires a sizable upfront capital outlay, is complex to design, and often requires extensive and repetitive database administration. Amazon SimpleDB is dramatically simpler, requiring no schema, automatically indexing your data and providing a simple API for storage and access. This approach eliminates the administrative burden of data modeling, index maintenance, and performance tuning. Developers gain access to this functionality within Amazon's proven computing environment, are able to scale instantly, and pay only for what they use.

Visit http://aws.amazon.com/simpledb/ (http://aws.amazon.com/simpledb/) for more information.

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

Using the Client

To Amazon SimpleDB 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 SimpleDB client SimpleDB for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/simpledb/#New

Index

Constants

View Source 
const (

	// ErrCodeAttributeDoesNotExist for service response error code
	// "AttributeDoesNotExist".
	//
	// The specified attribute does not exist.
	ErrCodeAttributeDoesNotExist = "AttributeDoesNotExist"

	// ErrCodeDuplicateItemName for service response error code
	// "DuplicateItemName".
	//
	// The item name was specified more than once.
	ErrCodeDuplicateItemName = "DuplicateItemName"

	// ErrCodeInvalidNextToken for service response error code
	// "InvalidNextToken".
	//
	// The specified NextToken is not valid.
	ErrCodeInvalidNextToken = "InvalidNextToken"

	// ErrCodeInvalidNumberPredicates for service response error code
	// "InvalidNumberPredicates".
	//
	// Too many predicates exist in the query expression.
	ErrCodeInvalidNumberPredicates = "InvalidNumberPredicates"

	// ErrCodeInvalidNumberValueTests for service response error code
	// "InvalidNumberValueTests".
	//
	// Too many predicates exist in the query expression.
	ErrCodeInvalidNumberValueTests = "InvalidNumberValueTests"

	// ErrCodeInvalidParameterValue for service response error code
	// "InvalidParameterValue".
	//
	// The value for a parameter is invalid.
	ErrCodeInvalidParameterValue = "InvalidParameterValue"

	// ErrCodeInvalidQueryExpression for service response error code
	// "InvalidQueryExpression".
	//
	// The specified query expression syntax is not valid.
	ErrCodeInvalidQueryExpression = "InvalidQueryExpression"

	// ErrCodeMissingParameter for service response error code
	// "MissingParameter".
	//
	// The request must contain the specified missing parameter.
	ErrCodeMissingParameter = "MissingParameter"

	// ErrCodeNoSuchDomain for service response error code
	// "NoSuchDomain".
	//
	// The specified domain does not exist.
	ErrCodeNoSuchDomain = "NoSuchDomain"

	// ErrCodeNumberDomainAttributesExceeded for service response error code
	// "NumberDomainAttributesExceeded".
	//
	// Too many attributes in this domain.
	ErrCodeNumberDomainAttributesExceeded = "NumberDomainAttributesExceeded"

	// ErrCodeNumberDomainBytesExceeded for service response error code
	// "NumberDomainBytesExceeded".
	//
	// Too many bytes in this domain.
	ErrCodeNumberDomainBytesExceeded = "NumberDomainBytesExceeded"

	// ErrCodeNumberDomainsExceeded for service response error code
	// "NumberDomainsExceeded".
	//
	// Too many domains exist per this account.
	ErrCodeNumberDomainsExceeded = "NumberDomainsExceeded"

	// ErrCodeNumberItemAttributesExceeded for service response error code
	// "NumberItemAttributesExceeded".
	//
	// Too many attributes in this item.
	ErrCodeNumberItemAttributesExceeded = "NumberItemAttributesExceeded"

	// ErrCodeNumberSubmittedAttributesExceeded for service response error code
	// "NumberSubmittedAttributesExceeded".
	//
	// Too many attributes exist in a single call.
	ErrCodeNumberSubmittedAttributesExceeded = "NumberSubmittedAttributesExceeded"

	// ErrCodeNumberSubmittedItemsExceeded for service response error code
	// "NumberSubmittedItemsExceeded".
	//
	// Too many items exist in a single call.
	ErrCodeNumberSubmittedItemsExceeded = "NumberSubmittedItemsExceeded"

	// ErrCodeRequestTimeout for service response error code
	// "RequestTimeout".
	//
	// A timeout occurred when attempting to query the specified domain with specified
	// query expression.
	ErrCodeRequestTimeout = "RequestTimeout"

	// ErrCodeTooManyRequestedAttributes for service response error code
	// "TooManyRequestedAttributes".
	//
	// Too many attributes requested.
	ErrCodeTooManyRequestedAttributes = "TooManyRequestedAttributes"
)
View Source 
const (
	ServiceName = "sdb"       // 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 Attribute 

type Attribute struct {
	AlternateNameEncoding *string `type:"string"`

	AlternateValueEncoding *string `type:"string"`

	// The name of the attribute.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The value of the attribute.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (Attribute) GoString 

func (s Attribute) GoString() string

GoString returns the string representation

func (Attribute) String 

func (s Attribute) String() string

String returns the string representation

type BatchDeleteAttributesInput 

type BatchDeleteAttributesInput struct {

	// The name of the domain in which the attributes are being deleted.
	//
	// DomainName is a required field
	DomainName *string `type:"string" required:"true"`

	// A list of items on which to perform the operation.
	//
	// Items is a required field
	Items []DeletableItem `locationNameList:"Item" type:"list" flattened:"true" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteAttributesInput) GoString 

func (s BatchDeleteAttributesInput) GoString() string

GoString returns the string representation

func (BatchDeleteAttributesInput) String 

func (s BatchDeleteAttributesInput) String() string

String returns the string representation

func (*BatchDeleteAttributesInput) Validate 

func (s *BatchDeleteAttributesInput) Validate() error

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

type BatchDeleteAttributesOutput 

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

func (BatchDeleteAttributesOutput) GoString 

func (s BatchDeleteAttributesOutput) GoString() string

GoString returns the string representation

func (BatchDeleteAttributesOutput) SDKResponseMetadata 

func (s BatchDeleteAttributesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (BatchDeleteAttributesOutput) String 

func (s BatchDeleteAttributesOutput) String() string

String returns the string representation

type BatchDeleteAttributesRequest 

type BatchDeleteAttributesRequest struct {
	*aws.Request
	Input *BatchDeleteAttributesInput
	Copy  func(*BatchDeleteAttributesInput) BatchDeleteAttributesRequest
}

BatchDeleteAttributesRequest is a API request type for the BatchDeleteAttributes API operation.

func (BatchDeleteAttributesRequest) Send 

func (r BatchDeleteAttributesRequest) Send() (*BatchDeleteAttributesOutput, error)

Send marshals and sends the BatchDeleteAttributes API request.

type BatchPutAttributesInput 

type BatchPutAttributesInput struct {

	// The name of the domain in which the attributes are being stored.
	//
	// DomainName is a required field
	DomainName *string `type:"string" required:"true"`

	// A list of items on which to perform the operation.
	//
	// Items is a required field
	Items []ReplaceableItem `locationNameList:"Item" type:"list" flattened:"true" required:"true"`
	// contains filtered or unexported fields
}

func (BatchPutAttributesInput) GoString 

func (s BatchPutAttributesInput) GoString() string

GoString returns the string representation

func (BatchPutAttributesInput) String 

func (s BatchPutAttributesInput) String() string

String returns the string representation

func (*BatchPutAttributesInput) Validate 

func (s *BatchPutAttributesInput) Validate() error

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

type BatchPutAttributesOutput 

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

func (BatchPutAttributesOutput) GoString 

func (s BatchPutAttributesOutput) GoString() string

GoString returns the string representation

func (BatchPutAttributesOutput) SDKResponseMetadata 

func (s BatchPutAttributesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (BatchPutAttributesOutput) String 

func (s BatchPutAttributesOutput) String() string

String returns the string representation

type BatchPutAttributesRequest 

type BatchPutAttributesRequest struct {
	*aws.Request
	Input *BatchPutAttributesInput
	Copy  func(*BatchPutAttributesInput) BatchPutAttributesRequest
}

BatchPutAttributesRequest is a API request type for the BatchPutAttributes API operation.

func (BatchPutAttributesRequest) Send 

func (r BatchPutAttributesRequest) Send() (*BatchPutAttributesOutput, error)

Send marshals and sends the BatchPutAttributes API request.

type CreateDomainInput 

type CreateDomainInput struct {

	// The name of the domain to create. The name can range between 3 and 255 characters
	// and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'.
	//
	// DomainName is a required field
	DomainName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDomainInput) GoString 

func (s CreateDomainInput) GoString() string

GoString returns the string representation

func (CreateDomainInput) String 

func (s CreateDomainInput) String() string

String returns the string representation

func (*CreateDomainInput) Validate 

func (s *CreateDomainInput) Validate() error

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

type CreateDomainOutput 

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

func (CreateDomainOutput) GoString 

func (s CreateDomainOutput) GoString() string

GoString returns the string representation

func (CreateDomainOutput) SDKResponseMetadata 

func (s CreateDomainOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateDomainOutput) String 

func (s CreateDomainOutput) String() string

String returns the string representation

type CreateDomainRequest 

type CreateDomainRequest struct {
	*aws.Request
	Input *CreateDomainInput
	Copy  func(*CreateDomainInput) CreateDomainRequest
}

CreateDomainRequest is a API request type for the CreateDomain API operation.

func (CreateDomainRequest) Send 

func (r CreateDomainRequest) Send() (*CreateDomainOutput, error)

Send marshals and sends the CreateDomain API request.

type DeletableAttribute 

type DeletableAttribute struct {

	// The name of the attribute.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The value of the attribute.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeletableAttribute) GoString 

func (s DeletableAttribute) GoString() string

GoString returns the string representation

func (DeletableAttribute) String 

func (s DeletableAttribute) String() string

String returns the string representation

func (*DeletableAttribute) Validate 

func (s *DeletableAttribute) Validate() error

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

type DeletableItem 

type DeletableItem struct {
	Attributes []DeletableAttribute `locationNameList:"Attribute" type:"list" flattened:"true"`

	// Name is a required field
	Name *string `locationName:"ItemName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletableItem) GoString 

func (s DeletableItem) GoString() string

GoString returns the string representation

func (DeletableItem) String 

func (s DeletableItem) String() string

String returns the string representation

func (*DeletableItem) Validate 

func (s *DeletableItem) Validate() error

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

type DeleteAttributesInput 

type DeleteAttributesInput struct {

	// A list of Attributes. Similar to columns on a spreadsheet, attributes represent
	// categories of data that can be assigned to items.
	Attributes []DeletableAttribute `locationNameList:"Attribute" type:"list" flattened:"true"`

	// The name of the domain in which to perform the operation.
	//
	// DomainName is a required field
	DomainName *string `type:"string" required:"true"`

	// The update condition which, if specified, determines whether the specified
	// attributes will be deleted or not. The update condition must be satisfied
	// in order for this request to be processed and the attributes to be deleted.
	Expected *UpdateCondition `type:"structure"`

	// The name of the item. Similar to rows on a spreadsheet, items represent individual
	// objects that contain one or more value-attribute pairs.
	//
	// ItemName is a required field
	ItemName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAttributesInput) GoString 

func (s DeleteAttributesInput) GoString() string

GoString returns the string representation

func (DeleteAttributesInput) String 

func (s DeleteAttributesInput) String() string

String returns the string representation

func (*DeleteAttributesInput) Validate 

func (s *DeleteAttributesInput) Validate() error

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

type DeleteAttributesOutput 

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

func (DeleteAttributesOutput) GoString 

func (s DeleteAttributesOutput) GoString() string

GoString returns the string representation

func (DeleteAttributesOutput) SDKResponseMetadata 

func (s DeleteAttributesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteAttributesOutput) String 

func (s DeleteAttributesOutput) String() string

String returns the string representation

type DeleteAttributesRequest 

type DeleteAttributesRequest struct {
	*aws.Request
	Input *DeleteAttributesInput
	Copy  func(*DeleteAttributesInput) DeleteAttributesRequest
}

DeleteAttributesRequest is a API request type for the DeleteAttributes API operation.

func (DeleteAttributesRequest) Send 

func (r DeleteAttributesRequest) Send() (*DeleteAttributesOutput, error)

Send marshals and sends the DeleteAttributes API request.

type DeleteDomainInput 

type DeleteDomainInput struct {

	// The name of the domain to delete.
	//
	// DomainName is a required field
	DomainName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDomainInput) GoString 

func (s DeleteDomainInput) GoString() string

GoString returns the string representation

func (DeleteDomainInput) String 

func (s DeleteDomainInput) String() string

String returns the string representation

func (*DeleteDomainInput) Validate 

func (s *DeleteDomainInput) Validate() error

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

type DeleteDomainOutput 

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

func (DeleteDomainOutput) GoString 

func (s DeleteDomainOutput) GoString() string

GoString returns the string representation

func (DeleteDomainOutput) SDKResponseMetadata 

func (s DeleteDomainOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteDomainOutput) String 

func (s DeleteDomainOutput) String() string

String returns the string representation

type DeleteDomainRequest 

type DeleteDomainRequest struct {
	*aws.Request
	Input *DeleteDomainInput
	Copy  func(*DeleteDomainInput) DeleteDomainRequest
}

DeleteDomainRequest is a API request type for the DeleteDomain API operation.

func (DeleteDomainRequest) Send 

func (r DeleteDomainRequest) Send() (*DeleteDomainOutput, error)

Send marshals and sends the DeleteDomain API request.

type DomainMetadataInput 

type DomainMetadataInput struct {

	// The name of the domain for which to display the metadata of.
	//
	// DomainName is a required field
	DomainName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DomainMetadataInput) GoString 

func (s DomainMetadataInput) GoString() string

GoString returns the string representation

func (DomainMetadataInput) String 

func (s DomainMetadataInput) String() string

String returns the string representation

func (*DomainMetadataInput) Validate 

func (s *DomainMetadataInput) Validate() error

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

type DomainMetadataOutput 

type DomainMetadataOutput struct {

	// The number of unique attribute names in the domain.
	AttributeNameCount *int64 `type:"integer"`

	// The total size of all unique attribute names in the domain, in bytes.
	AttributeNamesSizeBytes *int64 `type:"long"`

	// The number of all attribute name/value pairs in the domain.
	AttributeValueCount *int64 `type:"integer"`

	// The total size of all attribute values in the domain, in bytes.
	AttributeValuesSizeBytes *int64 `type:"long"`

	// The number of all items in the domain.
	ItemCount *int64 `type:"integer"`

	// The total size of all item names in the domain, in bytes.
	ItemNamesSizeBytes *int64 `type:"long"`

	// The data and time when metadata was calculated, in Epoch (UNIX) seconds.
	Timestamp *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DomainMetadataOutput) GoString 

func (s DomainMetadataOutput) GoString() string

GoString returns the string representation

func (DomainMetadataOutput) SDKResponseMetadata 

func (s DomainMetadataOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DomainMetadataOutput) String 

func (s DomainMetadataOutput) String() string

String returns the string representation

type DomainMetadataRequest 

type DomainMetadataRequest struct {
	*aws.Request
	Input *DomainMetadataInput
	Copy  func(*DomainMetadataInput) DomainMetadataRequest
}

DomainMetadataRequest is a API request type for the DomainMetadata API operation.

func (DomainMetadataRequest) Send 

func (r DomainMetadataRequest) Send() (*DomainMetadataOutput, error)

Send marshals and sends the DomainMetadata API request.

type GetAttributesInput 

type GetAttributesInput struct {

	// The names of the attributes.
	AttributeNames []string `locationNameList:"AttributeName" type:"list" flattened:"true"`

	// Determines whether or not strong consistency should be enforced when data
	// is read from SimpleDB. If true
	ConsistentRead *bool `type:"boolean"`

	// The name of the domain in which to perform the operation.
	//
	// DomainName is a required field
	DomainName *string `type:"string" required:"true"`

	// The name of the item.
	//
	// ItemName is a required field
	ItemName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAttributesInput) GoString 

func (s GetAttributesInput) GoString() string

GoString returns the string representation

func (GetAttributesInput) String 

func (s GetAttributesInput) String() string

String returns the string representation

func (*GetAttributesInput) Validate 

func (s *GetAttributesInput) Validate() error

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

type GetAttributesOutput 

type GetAttributesOutput struct {

	// The list of attributes returned by the operation.
	Attributes []Attribute `locationNameList:"Attribute" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

func (GetAttributesOutput) GoString 

func (s GetAttributesOutput) GoString() string

GoString returns the string representation

func (GetAttributesOutput) SDKResponseMetadata 

func (s GetAttributesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetAttributesOutput) String 

func (s GetAttributesOutput) String() string

String returns the string representation

type GetAttributesRequest 

type GetAttributesRequest struct {
	*aws.Request
	Input *GetAttributesInput
	Copy  func(*GetAttributesInput) GetAttributesRequest
}

GetAttributesRequest is a API request type for the GetAttributes API operation.

func (GetAttributesRequest) Send 

func (r GetAttributesRequest) Send() (*GetAttributesOutput, error)

Send marshals and sends the GetAttributes API request.

type Item 

type Item struct {
	AlternateNameEncoding *string `type:"string"`

	// A list of attributes.
	//
	// Attributes is a required field
	Attributes []Attribute `locationNameList:"Attribute" type:"list" flattened:"true" required:"true"`

	// The name of the item.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (Item) GoString 

func (s Item) GoString() string

GoString returns the string representation

func (Item) String 

func (s Item) String() string

String returns the string representation

type ListDomainsInput 

type ListDomainsInput struct {

	// The maximum number of domain names you want returned. The range is 1 to 100.
	// The default setting is 100.
	MaxNumberOfDomains *int64 `type:"integer"`

	// A string informing Amazon SimpleDB where to start the next list of domain
	// names.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDomainsInput) GoString 

func (s ListDomainsInput) GoString() string

GoString returns the string representation

func (ListDomainsInput) String 

func (s ListDomainsInput) String() string

String returns the string representation

type ListDomainsOutput 

type ListDomainsOutput struct {

	// A list of domain names that match the expression.
	DomainNames []string `locationNameList:"DomainName" type:"list" flattened:"true"`

	// An opaque token indicating that there are more domains than the specified
	// MaxNumberOfDomains
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDomainsOutput) GoString 

func (s ListDomainsOutput) GoString() string

GoString returns the string representation

func (ListDomainsOutput) SDKResponseMetadata 

func (s ListDomainsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListDomainsOutput) String 

func (s ListDomainsOutput) String() string

String returns the string representation

type ListDomainsPager 

type ListDomainsPager struct {
	aws.Pager
}

ListDomainsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListDomainsPager) CurrentPage 

func (p *ListDomainsPager) CurrentPage() *ListDomainsOutput

type ListDomainsRequest 

type ListDomainsRequest struct {
	*aws.Request
	Input *ListDomainsInput
	Copy  func(*ListDomainsInput) ListDomainsRequest
}

ListDomainsRequest is a API request type for the ListDomains API operation.

func (*ListDomainsRequest) Paginate 

func (p *ListDomainsRequest) Paginate(opts ...aws.Option) ListDomainsPager

Paginate pages iterates over the pages of a ListDomainsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service. 

   // Example iterating over at most 3 pages of a ListDomains operation.
		req := client.ListDomainsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListDomainsRequest) Send 

func (r ListDomainsRequest) Send() (*ListDomainsOutput, error)

Send marshals and sends the ListDomains API request.

type PutAttributesInput 

type PutAttributesInput struct {

	// The list of attributes.
	//
	// Attributes is a required field
	Attributes []ReplaceableAttribute `locationNameList:"Attribute" type:"list" flattened:"true" required:"true"`

	// The name of the domain in which to perform the operation.
	//
	// DomainName is a required field
	DomainName *string `type:"string" required:"true"`

	// The update condition which, if specified, determines whether the specified
	// attributes will be updated or not. The update condition must be satisfied
	// in order for this request to be processed and the attributes to be updated.
	Expected *UpdateCondition `type:"structure"`

	// The name of the item.
	//
	// ItemName is a required field
	ItemName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutAttributesInput) GoString 

func (s PutAttributesInput) GoString() string

GoString returns the string representation

func (PutAttributesInput) String 

func (s PutAttributesInput) String() string

String returns the string representation

func (*PutAttributesInput) Validate 

func (s *PutAttributesInput) Validate() error

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

type PutAttributesOutput 

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

func (PutAttributesOutput) GoString 

func (s PutAttributesOutput) GoString() string

GoString returns the string representation

func (PutAttributesOutput) SDKResponseMetadata 

func (s PutAttributesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (PutAttributesOutput) String 

func (s PutAttributesOutput) String() string

String returns the string representation

type PutAttributesRequest 

type PutAttributesRequest struct {
	*aws.Request
	Input *PutAttributesInput
	Copy  func(*PutAttributesInput) PutAttributesRequest
}

PutAttributesRequest is a API request type for the PutAttributes API operation.

func (PutAttributesRequest) Send 

func (r PutAttributesRequest) Send() (*PutAttributesOutput, error)

Send marshals and sends the PutAttributes API request.

type ReplaceableAttribute 

type ReplaceableAttribute struct {

	// The name of the replaceable attribute.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// A flag specifying whether or not to replace the attribute/value pair or to
	// add a new attribute/value pair. The default setting is false
	Replace *bool `type:"boolean"`

	// The value of the replaceable attribute.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ReplaceableAttribute) GoString 

func (s ReplaceableAttribute) GoString() string

GoString returns the string representation

func (ReplaceableAttribute) String 

func (s ReplaceableAttribute) String() string

String returns the string representation

func (*ReplaceableAttribute) Validate 

func (s *ReplaceableAttribute) Validate() error

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

type ReplaceableItem 

type ReplaceableItem struct {

	// The list of attributes for a replaceable item.
	//
	// Attributes is a required field
	Attributes []ReplaceableAttribute `locationNameList:"Attribute" type:"list" flattened:"true" required:"true"`

	// The name of the replaceable item.
	//
	// Name is a required field
	Name *string `locationName:"ItemName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ReplaceableItem) GoString 

func (s ReplaceableItem) GoString() string

GoString returns the string representation

func (ReplaceableItem) String 

func (s ReplaceableItem) String() string

String returns the string representation

func (*ReplaceableItem) Validate 

func (s *ReplaceableItem) Validate() error

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

type SelectInput 

type SelectInput struct {

	// Determines whether or not strong consistency should be enforced when data
	// is read from SimpleDB. If true
	ConsistentRead *bool `type:"boolean"`

	// A string informing Amazon SimpleDB where to start the next list of ItemNames
	NextToken *string `type:"string"`

	// The expression used to query the domain.
	//
	// SelectExpression is a required field
	SelectExpression *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SelectInput) GoString 

func (s SelectInput) GoString() string

GoString returns the string representation

func (SelectInput) String 

func (s SelectInput) String() string

String returns the string representation

func (*SelectInput) Validate 

func (s *SelectInput) Validate() error

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

type SelectOutput 

type SelectOutput struct {

	// A list of items that match the select expression.
	Items []Item `locationNameList:"Item" type:"list" flattened:"true"`

	// An opaque token indicating that more items than MaxNumberOfItems
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (SelectOutput) GoString 

func (s SelectOutput) GoString() string

GoString returns the string representation

func (SelectOutput) SDKResponseMetadata 

func (s SelectOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SelectOutput) String 

func (s SelectOutput) String() string

String returns the string representation

type SelectPager 

type SelectPager struct {
	aws.Pager
}

SelectPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*SelectPager) CurrentPage 

func (p *SelectPager) CurrentPage() *SelectOutput

type SelectRequest 

type SelectRequest struct {
	*aws.Request
	Input *SelectInput
	Copy  func(*SelectInput) SelectRequest
}

SelectRequest is a API request type for the Select API operation.

func (*SelectRequest) Paginate 

func (p *SelectRequest) Paginate(opts ...aws.Option) SelectPager

Paginate pages iterates over the pages of a SelectRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service. 

   // Example iterating over at most 3 pages of a Select operation.
		req := client.SelectRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (SelectRequest) Send 

func (r SelectRequest) Send() (*SelectOutput, error)

Send marshals and sends the Select API request.

type SimpleDB 

type SimpleDB struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *SimpleDB

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

Example: 

// Create a SimpleDB client from just a config.
svc := simpledb.New(myConfig)

func (*SimpleDB) BatchDeleteAttributesRequest 

func (c *SimpleDB) BatchDeleteAttributesRequest(input *BatchDeleteAttributesInput) BatchDeleteAttributesRequest

BatchDeleteAttributesRequest returns a request value for making API operation for Amazon SimpleDB.

Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput.

If you specify BatchDeleteAttributes without attributes or values, all the attributes for the item are deleted. 

BatchDeleteAttributes is an idempotent operation; running it multiple times

on the same item or attribute doesn't result in an error. 

The BatchDeleteAttributes operation succeeds or fails in its entirety. There

are no partial deletes. You can execute multiple BatchDeleteAttributes operations and other operations in parallel. However, large numbers of concurrent BatchDeleteAttributes calls can result in Service Unavailable (503) responses. 

This operation is vulnerable to exceeding the maximum URL size when making

a REST request using the HTTP GET method. 

This operation does not support conditions using Expected.X.Name, Expected.X.Value,

or Expected.X.Exists.

The following limitations are enforced for this operation: 1 MB request size

25 item limit per BatchDeleteAttributes operation 

// Example sending a request using the BatchDeleteAttributesRequest method.
req := client.BatchDeleteAttributesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*SimpleDB) BatchPutAttributesRequest 

func (c *SimpleDB) BatchPutAttributesRequest(input *BatchPutAttributesInput) BatchPutAttributesRequest

BatchPutAttributesRequest returns a request value for making API operation for Amazon SimpleDB.

The BatchPutAttributes operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput.

The client may specify the item name with the Item.X.ItemName parameter. The client may specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. The client may specify the first attribute for the first item using the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value, and so on.

Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes { "first_name", "first_value" } and { "first_name", "second_value" }. However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value are the same.

Optionally, the requester can supply the Replace parameter for each individual value. Setting this value to true will cause the new attribute values to replace the existing attribute values. For example, if an item I has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requester does a BatchPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute with the new value.

You cannot specify an empty string as an item or as an attribute name. The BatchPutAttributes operation succeeds or fails in its entirety. There are no partial puts. This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists. You can execute multiple BatchPutAttributes operations and other operations in parallel. However, large numbers of concurrent BatchPutAttributes calls can result in Service Unavailable (503) responses.

The following limitations are enforced for this operation: 256 attribute name-value pairs per item 1 MB request size 1 billion attributes per domain 10 GB of total user data storage per domain 25 item limit per BatchPutAttributes operation 

// Example sending a request using the BatchPutAttributesRequest method.
req := client.BatchPutAttributesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*SimpleDB) CreateDomainRequest 

func (c *SimpleDB) CreateDomainRequest(input *CreateDomainInput) CreateDomainRequest

CreateDomainRequest returns a request value for making API operation for Amazon SimpleDB.

The CreateDomain operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. The CreateDomain operation may take 10 or more seconds to complete.

CreateDomain is an idempotent operation; running it multiple times using the same domain name will not result in an error response. The client can create up to 100 domains per account.

If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/ (http://aws.amazon.com/contact-us/simpledb-limit-request/). 

// Example sending a request using the CreateDomainRequest method.
req := client.CreateDomainRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*SimpleDB) DeleteAttributesRequest 

func (c *SimpleDB) DeleteAttributesRequest(input *DeleteAttributesInput) DeleteAttributesRequest

DeleteAttributesRequest returns a request value for making API operation for Amazon SimpleDB.

Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted.

If DeleteAttributes is called without being passed any attributes or values specified, all the attributes for the item are deleted. DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data. 

// Example sending a request using the DeleteAttributesRequest method.
req := client.DeleteAttributesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*SimpleDB) DeleteDomainRequest 

func (c *SimpleDB) DeleteDomainRequest(input *DeleteDomainInput) DeleteDomainRequest

DeleteDomainRequest returns a request value for making API operation for Amazon SimpleDB.

The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to complete.

Running DeleteDomain on a domain that does not exist or running the function multiple times using the same domain name will not result in an error response. 

// Example sending a request using the DeleteDomainRequest method.
req := client.DeleteDomainRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*SimpleDB) DomainMetadataRequest 

func (c *SimpleDB) DomainMetadataRequest(input *DomainMetadataInput) DomainMetadataRequest

DomainMetadataRequest returns a request value for making API operation for Amazon SimpleDB.

Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values. 

// Example sending a request using the DomainMetadataRequest method.
req := client.DomainMetadataRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*SimpleDB) GetAttributesRequest 

func (c *SimpleDB) GetAttributesRequest(input *GetAttributesInput) GetAttributesRequest

GetAttributesRequest returns a request value for making API operation for Amazon SimpleDB.

Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter.

If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas.

If GetAttributes is called without being passed any attribute names, all the attributes for the item are returned. 

// Example sending a request using the GetAttributesRequest method.
req := client.GetAttributesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*SimpleDB) ListDomainsRequest 

func (c *SimpleDB) ListDomainsRequest(input *ListDomainsInput) ListDomainsRequest

ListDomainsRequest returns a request value for making API operation for Amazon SimpleDB.

The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains (#MaxNumberOfDomains). A NextToken (#NextToken) is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call. 

// Example sending a request using the ListDomainsRequest method.
req := client.ListDomainsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*SimpleDB) PutAttributesRequest 

func (c *SimpleDB) PutAttributesRequest(input *PutAttributesInput) PutAttributesRequest

PutAttributesRequest returns a request value for making API operation for Amazon SimpleDB.

The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. The client specifies the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on.

Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes { "first_name", "first_value" } and { "first_name", second_value" }. However, it cannot have two attribute instances where both the Attribute.X.Name and Attribute.X.Value are the same.

Optionally, the requestor can supply the Replace parameter for each individual attribute. Setting this value to true causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes { 'b', '4' } with the Replace parameter set to true, the final attributes of the item are changed to { 'a', '1' } and { 'b', '4' }, which replaces the previous values of the 'b' attribute with the new value.

Using PutAttributes to replace attribute values that do not exist will not result in an error response. You cannot specify an empty string as an attribute name.

Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (write) might not return the updated data.

The following limitations are enforced for this operation: 256 total attribute name-value pairs per item One billion attributes per domain 10 GB of total user data storage per domain 

// Example sending a request using the PutAttributesRequest method.
req := client.PutAttributesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*SimpleDB) SelectRequest 

func (c *SimpleDB) SelectRequest(input *SelectInput) SelectRequest

SelectRequest returns a request value for making API operation for Amazon SimpleDB.

The Select operation returns a set of attributes for ItemNames that match the select expression. Select is similar to the standard SQL SELECT statement.

The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access the next page of results.

For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide. 

// Example sending a request using the SelectRequest method.
req := client.SelectRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

type UpdateCondition 

type UpdateCondition struct {

	// A value specifying whether or not the specified attribute must exist with
	// the specified value in order for the update condition to be satisfied. Specify
	// true if the attribute must exist for the update condition to be satisfied.
	// Specify false if the attribute should not exist in order for the update condition
	// to be satisfied.
	Exists *bool `type:"boolean"`

	// The name of the attribute involved in the condition.
	Name *string `type:"string"`

	// The value of an attribute. This value can only be specified when the Exists
	// parameter is equal to true.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the conditions under which data should be updated. If an update condition is specified for a request, the data will only be updated if the condition is satisfied. For example, if an attribute with a specific name and value exists, or if a specific attribute doesn't exist.

func (UpdateCondition) GoString 

func (s UpdateCondition) GoString() string

GoString returns the string representation

func (UpdateCondition) String 

func (s UpdateCondition) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package simpledbiface provides an interface to enable mocking the Amazon SimpleDB service client for testing your code.
 Package simpledbiface provides an interface to enable mocking the Amazon SimpleDB 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.