simpledb

package
v0.9.14-0...-d3b6d25 Latest Latest
Warning

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

Go to latest
Published: Jun 14, 2016 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package simpledb provides a client for Amazon SimpleDB.

Index

Examples

Constants

View Source
const ServiceName = "sdb"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type Attribute

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

	AlternateValueEncoding *string `type:"string"`

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

	// The value of the attribute.
	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 *string `type:"string" required:"true"`

	// A list of items on which to perform the operation.
	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

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) String

String returns the string representation

type BatchPutAttributesInput

type BatchPutAttributesInput struct {

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

	// A list of items on which to perform the operation.
	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) String

func (s BatchPutAttributesOutput) String() string

String returns the string representation

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 *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) String

func (s CreateDomainOutput) String() string

String returns the string representation

type DeletableAttribute

type DeletableAttribute struct {

	// The name of the attribute.
	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 *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 *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 *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) String

func (s DeleteAttributesOutput) String() string

String returns the string representation

type DeleteDomainInput

type DeleteDomainInput struct {

	// The name of the domain to delete.
	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) String

func (s DeleteDomainOutput) String() string

String returns the string representation

type DomainMetadataInput

type DomainMetadataInput struct {

	// The name of the domain for which to display the metadata of.
	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) String

func (s DomainMetadataOutput) String() string

String returns the string representation

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, any data previously written to SimpleDB will
	// be returned. Otherwise, results will be consistent eventually, and the client
	// may not see data that was written immediately before your read.
	ConsistentRead *bool `type:"boolean"`

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

	// The name of the item.
	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) String

func (s GetAttributesOutput) String() string

String returns the string representation

type Item

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

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

	// The name of the item.
	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 still available.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDomainsOutput) GoString

func (s ListDomainsOutput) GoString() string

GoString returns the string representation

func (ListDomainsOutput) String

func (s ListDomainsOutput) String() string

String returns the string representation

type PutAttributesInput

type PutAttributesInput struct {

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

	// The name of the domain in which to perform the operation.
	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 *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) String

func (s PutAttributesOutput) String() string

String returns the string representation

type ReplaceableAttribute

type ReplaceableAttribute struct {

	// The name of the replaceable attribute.
	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 *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 []*ReplaceableAttribute `locationNameList:"Attribute" type:"list" flattened:"true" required:"true"`

	// The name of the replaceable item.
	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, any data previously written to SimpleDB will
	// be returned. Otherwise, results will be consistent eventually, and the client
	// may not see data that was written immediately before your read.
	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 *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 were matched,
	// the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (SelectOutput) GoString

func (s SelectOutput) GoString() string

GoString returns the string representation

func (SelectOutput) String

func (s SelectOutput) String() string

String returns the string representation

type SimpleDB

type SimpleDB struct {
	*client.Client
}

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. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SimpleDB

New creates a new instance of the SimpleDB 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 SimpleDB client from just a session.
svc := simpledb.New(mySession)

// Create a SimpleDB client with additional configuration
svc := simpledb.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SimpleDB) BatchDeleteAttributes

func (c *SimpleDB) BatchDeleteAttributes(input *BatchDeleteAttributesInput) (*BatchDeleteAttributesOutput, error)

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
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/simpledb"
)

func main() {
	svc := simpledb.New(session.New())

	params := &simpledb.BatchDeleteAttributesInput{
		DomainName: aws.String("String"), // Required
		Items: []*simpledb.DeletableItem{ // Required
			{ // Required
				Name: aws.String("String"), // Required
				Attributes: []*simpledb.DeletableAttribute{
					{ // Required
						Name:  aws.String("String"), // Required
						Value: aws.String("String"),
					},
					// More values...
				},
			},
			// More values...
		},
	}
	resp, err := svc.BatchDeleteAttributes(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SimpleDB) BatchDeleteAttributesRequest

func (c *SimpleDB) BatchDeleteAttributesRequest(input *BatchDeleteAttributesInput) (req *request.Request, output *BatchDeleteAttributesOutput)

BatchDeleteAttributesRequest generates a request for the BatchDeleteAttributes operation.

func (*SimpleDB) BatchPutAttributes

func (c *SimpleDB) BatchPutAttributes(input *BatchPutAttributesInput) (*BatchPutAttributesOutput, error)

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
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/simpledb"
)

func main() {
	svc := simpledb.New(session.New())

	params := &simpledb.BatchPutAttributesInput{
		DomainName: aws.String("String"), // Required
		Items: []*simpledb.ReplaceableItem{ // Required
			{ // Required
				Attributes: []*simpledb.ReplaceableAttribute{ // Required
					{ // Required
						Name:    aws.String("String"), // Required
						Value:   aws.String("String"), // Required
						Replace: aws.Bool(true),
					},
					// More values...
				},
				Name: aws.String("String"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.BatchPutAttributes(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SimpleDB) BatchPutAttributesRequest

func (c *SimpleDB) BatchPutAttributesRequest(input *BatchPutAttributesInput) (req *request.Request, output *BatchPutAttributesOutput)

BatchPutAttributesRequest generates a request for the BatchPutAttributes operation.

func (*SimpleDB) CreateDomain

func (c *SimpleDB) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error)

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
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/simpledb"
)

func main() {
	svc := simpledb.New(session.New())

	params := &simpledb.CreateDomainInput{
		DomainName: aws.String("String"), // Required
	}
	resp, err := svc.CreateDomain(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SimpleDB) CreateDomainRequest

func (c *SimpleDB) CreateDomainRequest(input *CreateDomainInput) (req *request.Request, output *CreateDomainOutput)

CreateDomainRequest generates a request for the CreateDomain operation.

func (*SimpleDB) DeleteAttributes

func (c *SimpleDB) DeleteAttributes(input *DeleteAttributesInput) (*DeleteAttributesOutput, error)

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
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/simpledb"
)

func main() {
	svc := simpledb.New(session.New())

	params := &simpledb.DeleteAttributesInput{
		DomainName: aws.String("String"), // Required
		ItemName:   aws.String("String"), // Required
		Attributes: []*simpledb.DeletableAttribute{
			{ // Required
				Name:  aws.String("String"), // Required
				Value: aws.String("String"),
			},
			// More values...
		},
		Expected: &simpledb.UpdateCondition{
			Exists: aws.Bool(true),
			Name:   aws.String("String"),
			Value:  aws.String("String"),
		},
	}
	resp, err := svc.DeleteAttributes(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SimpleDB) DeleteAttributesRequest

func (c *SimpleDB) DeleteAttributesRequest(input *DeleteAttributesInput) (req *request.Request, output *DeleteAttributesOutput)

DeleteAttributesRequest generates a request for the DeleteAttributes operation.

func (*SimpleDB) DeleteDomain

func (c *SimpleDB) DeleteDomain(input *DeleteDomainInput) (*DeleteDomainOutput, error)

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
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/simpledb"
)

func main() {
	svc := simpledb.New(session.New())

	params := &simpledb.DeleteDomainInput{
		DomainName: aws.String("String"), // Required
	}
	resp, err := svc.DeleteDomain(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SimpleDB) DeleteDomainRequest

func (c *SimpleDB) DeleteDomainRequest(input *DeleteDomainInput) (req *request.Request, output *DeleteDomainOutput)

DeleteDomainRequest generates a request for the DeleteDomain operation.

func (*SimpleDB) DomainMetadata

func (c *SimpleDB) DomainMetadata(input *DomainMetadataInput) (*DomainMetadataOutput, error)

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
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/simpledb"
)

func main() {
	svc := simpledb.New(session.New())

	params := &simpledb.DomainMetadataInput{
		DomainName: aws.String("String"), // Required
	}
	resp, err := svc.DomainMetadata(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SimpleDB) DomainMetadataRequest

func (c *SimpleDB) DomainMetadataRequest(input *DomainMetadataInput) (req *request.Request, output *DomainMetadataOutput)

DomainMetadataRequest generates a request for the DomainMetadata operation.

func (*SimpleDB) GetAttributes

func (c *SimpleDB) GetAttributes(input *GetAttributesInput) (*GetAttributesOutput, error)

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
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/simpledb"
)

func main() {
	svc := simpledb.New(session.New())

	params := &simpledb.GetAttributesInput{
		DomainName: aws.String("String"), // Required
		ItemName:   aws.String("String"), // Required
		AttributeNames: []*string{
			aws.String("String"), // Required
			// More values...
		},
		ConsistentRead: aws.Bool(true),
	}
	resp, err := svc.GetAttributes(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SimpleDB) GetAttributesRequest

func (c *SimpleDB) GetAttributesRequest(input *GetAttributesInput) (req *request.Request, output *GetAttributesOutput)

GetAttributesRequest generates a request for the GetAttributes operation.

func (*SimpleDB) ListDomains

func (c *SimpleDB) ListDomains(input *ListDomainsInput) (*ListDomainsOutput, error)

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
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/simpledb"
)

func main() {
	svc := simpledb.New(session.New())

	params := &simpledb.ListDomainsInput{
		MaxNumberOfDomains: aws.Int64(1),
		NextToken:          aws.String("String"),
	}
	resp, err := svc.ListDomains(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SimpleDB) ListDomainsPages

func (c *SimpleDB) ListDomainsPages(input *ListDomainsInput, fn func(p *ListDomainsOutput, lastPage bool) (shouldContinue bool)) error

func (*SimpleDB) ListDomainsRequest

func (c *SimpleDB) ListDomainsRequest(input *ListDomainsInput) (req *request.Request, output *ListDomainsOutput)

ListDomainsRequest generates a request for the ListDomains operation.

func (*SimpleDB) PutAttributes

func (c *SimpleDB) PutAttributes(input *PutAttributesInput) (*PutAttributesOutput, error)

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
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/simpledb"
)

func main() {
	svc := simpledb.New(session.New())

	params := &simpledb.PutAttributesInput{
		Attributes: []*simpledb.ReplaceableAttribute{ // Required
			{ // Required
				Name:    aws.String("String"), // Required
				Value:   aws.String("String"), // Required
				Replace: aws.Bool(true),
			},
			// More values...
		},
		DomainName: aws.String("String"), // Required
		ItemName:   aws.String("String"), // Required
		Expected: &simpledb.UpdateCondition{
			Exists: aws.Bool(true),
			Name:   aws.String("String"),
			Value:  aws.String("String"),
		},
	}
	resp, err := svc.PutAttributes(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SimpleDB) PutAttributesRequest

func (c *SimpleDB) PutAttributesRequest(input *PutAttributesInput) (req *request.Request, output *PutAttributesOutput)

PutAttributesRequest generates a request for the PutAttributes operation.

func (*SimpleDB) Select

func (c *SimpleDB) Select(input *SelectInput) (*SelectOutput, error)

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
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/simpledb"
)

func main() {
	svc := simpledb.New(session.New())

	params := &simpledb.SelectInput{
		SelectExpression: aws.String("String"), // Required
		ConsistentRead:   aws.Bool(true),
		NextToken:        aws.String("String"),
	}
	resp, err := svc.Select(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SimpleDB) SelectPages

func (c *SimpleDB) SelectPages(input *SelectInput, fn func(p *SelectOutput, lastPage bool) (shouldContinue bool)) error

func (*SimpleDB) SelectRequest

func (c *SimpleDB) SelectRequest(input *SelectInput) (req *request.Request, output *SelectOutput)

SelectRequest generates a request for the Select operation.

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

Directories

Path Synopsis
Package simpledbiface provides an interface for the Amazon SimpleDB.
Package simpledbiface provides an interface for the Amazon SimpleDB.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL