AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

SimpleDB

import "github.com/aws/aws-sdk-go/service/simpledb"

type SimpleDB struct { *client.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.

Client

Type: *client.Client

Method

BatchDeleteAttributes

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

BatchDeleteAttributes 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

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 SimpleDB's API operation BatchDeleteAttributes for usage and error information.

See Also

For more information about using this API, see AWS API Documentation.

BatchDeleteAttributesRequest

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

BatchDeleteAttributesRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 BatchDeleteAttributes for more information on using the BatchDeleteAttributes 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 BatchDeleteAttributesRequest method. req, resp := client.BatchDeleteAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See Also

For more information about using this API, see AWS API Documentation.

BatchDeleteAttributesWithContext

func (c *SimpleDB) BatchDeleteAttributesWithContext(ctx aws.Context, input *BatchDeleteAttributesInput, opts ...request.Option) (*BatchDeleteAttributesOutput, error)

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

See BatchDeleteAttributes 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.

See Also

For more information about using this API, see AWS API Documentation.

BatchPutAttributes

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

BatchPutAttributes 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

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 SimpleDB's API operation BatchPutAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeDuplicateItemName "DuplicateItemName" The item name was specified more than once.

  • ErrCodeInvalidParameterValue "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeMissingParameter "MissingParameter" The request must contain the specified missing parameter.

  • ErrCodeNoSuchDomain "NoSuchDomain" The specified domain does not exist.

  • ErrCodeNumberItemAttributesExceeded "NumberItemAttributesExceeded" Too many attributes in this item.

  • ErrCodeNumberDomainAttributesExceeded "NumberDomainAttributesExceeded" Too many attributes in this domain.

  • ErrCodeNumberDomainBytesExceeded "NumberDomainBytesExceeded" Too many bytes in this domain.

  • ErrCodeNumberSubmittedItemsExceeded "NumberSubmittedItemsExceeded" Too many items exist in a single call.

  • ErrCodeNumberSubmittedAttributesExceeded "NumberSubmittedAttributesExceeded" Too many attributes exist in a single call.

See Also

For more information about using this API, see AWS API Documentation.

BatchPutAttributesRequest

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

BatchPutAttributesRequest generates a "aws/request.Request" representing the client's request for the BatchPutAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 BatchPutAttributes for more information on using the BatchPutAttributes 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 BatchPutAttributesRequest method. req, resp := client.BatchPutAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See Also

For more information about using this API, see AWS API Documentation.

BatchPutAttributesWithContext

func (c *SimpleDB) BatchPutAttributesWithContext(ctx aws.Context, input *BatchPutAttributesInput, opts ...request.Option) (*BatchPutAttributesOutput, error)

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

See BatchPutAttributes 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.

See Also

For more information about using this API, see AWS API Documentation.

CreateDomain

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

CreateDomain 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 https://aws.amazon.com/contact-us/simpledb-limit-request/ (https://aws.amazon.com/contact-us/simpledb-limit-request/).

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 SimpleDB's API operation CreateDomain for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValue "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeMissingParameter "MissingParameter" The request must contain the specified missing parameter.

  • ErrCodeNumberDomainsExceeded "NumberDomainsExceeded" Too many domains exist per this account.

See Also

For more information about using this API, see AWS API Documentation.

CreateDomainRequest

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

CreateDomainRequest generates a "aws/request.Request" representing the client's request for the CreateDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 CreateDomain for more information on using the CreateDomain 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 CreateDomainRequest method. req, resp := client.CreateDomainRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See Also

For more information about using this API, see AWS API Documentation.

CreateDomainWithContext

func (c *SimpleDB) CreateDomainWithContext(ctx aws.Context, input *CreateDomainInput, opts ...request.Option) (*CreateDomainOutput, error)

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

See CreateDomain 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.

See Also

For more information about using this API, see AWS API Documentation.

DeleteAttributes

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

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

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 SimpleDB's API operation DeleteAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValue "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeMissingParameter "MissingParameter" The request must contain the specified missing parameter.

  • ErrCodeNoSuchDomain "NoSuchDomain" The specified domain does not exist.

  • ErrCodeAttributeDoesNotExist "AttributeDoesNotExist" The specified attribute does not exist.

See Also

For more information about using this API, see AWS API Documentation.

DeleteAttributesRequest

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

DeleteAttributesRequest generates a "aws/request.Request" representing the client's request for the DeleteAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 DeleteAttributes for more information on using the DeleteAttributes 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 DeleteAttributesRequest method. req, resp := client.DeleteAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See Also

For more information about using this API, see AWS API Documentation.

DeleteAttributesWithContext

func (c *SimpleDB) DeleteAttributesWithContext(ctx aws.Context, input *DeleteAttributesInput, opts ...request.Option) (*DeleteAttributesOutput, error)

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

See DeleteAttributes 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.

See Also

For more information about using this API, see AWS API Documentation.

DeleteDomain

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

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

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 SimpleDB's API operation DeleteDomain for usage and error information.

Returned Error Codes:

  • ErrCodeMissingParameter "MissingParameter" The request must contain the specified missing parameter.

See Also

For more information about using this API, see AWS API Documentation.

DeleteDomainRequest

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

DeleteDomainRequest generates a "aws/request.Request" representing the client's request for the DeleteDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 DeleteDomain for more information on using the DeleteDomain 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 DeleteDomainRequest method. req, resp := client.DeleteDomainRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See Also

For more information about using this API, see AWS API Documentation.

DeleteDomainWithContext

func (c *SimpleDB) DeleteDomainWithContext(ctx aws.Context, input *DeleteDomainInput, opts ...request.Option) (*DeleteDomainOutput, error)

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

See DeleteDomain 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.

See Also

For more information about using this API, see AWS API Documentation.

DomainMetadata

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

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

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 SimpleDB's API operation DomainMetadata for usage and error information.

Returned Error Codes:

  • ErrCodeMissingParameter "MissingParameter" The request must contain the specified missing parameter.

  • ErrCodeNoSuchDomain "NoSuchDomain" The specified domain does not exist.

See Also

For more information about using this API, see AWS API Documentation.

DomainMetadataRequest

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

DomainMetadataRequest generates a "aws/request.Request" representing the client's request for the DomainMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 DomainMetadata for more information on using the DomainMetadata 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 DomainMetadataRequest method. req, resp := client.DomainMetadataRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See Also

For more information about using this API, see AWS API Documentation.

DomainMetadataWithContext

func (c *SimpleDB) DomainMetadataWithContext(ctx aws.Context, input *DomainMetadataInput, opts ...request.Option) (*DomainMetadataOutput, error)

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

See DomainMetadata 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.

See Also

For more information about using this API, see AWS API Documentation.

GetAttributes

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

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

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 SimpleDB's API operation GetAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValue "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeMissingParameter "MissingParameter" The request must contain the specified missing parameter.

  • ErrCodeNoSuchDomain "NoSuchDomain" The specified domain does not exist.

See Also

For more information about using this API, see AWS API Documentation.

GetAttributesRequest

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

GetAttributesRequest generates a "aws/request.Request" representing the client's request for the GetAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 GetAttributes for more information on using the GetAttributes 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 GetAttributesRequest method. req, resp := client.GetAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See Also

For more information about using this API, see AWS API Documentation.

GetAttributesWithContext

func (c *SimpleDB) GetAttributesWithContext(ctx aws.Context, input *GetAttributesInput, opts ...request.Option) (*GetAttributesOutput, error)

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

See GetAttributes 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.

See Also

For more information about using this API, see AWS API Documentation.

ListDomains

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

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

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 SimpleDB's API operation ListDomains for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValue "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified NextToken is not valid.

See Also

For more information about using this API, see AWS API Documentation.

ListDomainsPages

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

ListDomainsPages iterates over the pages of a ListDomains operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDomains method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListDomains operation. pageNum := 0 err := client.ListDomainsPages(params, func(page *ListDomainsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

ListDomainsPagesWithContext

func (c *SimpleDB) ListDomainsPagesWithContext(ctx aws.Context, input *ListDomainsInput, fn func(*ListDomainsOutput, bool) bool, opts ...request.Option) error

ListDomainsPagesWithContext same as ListDomainsPages except it takes a Context and allows setting request options on the pages.

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.

See Also

For more information about using this API, see AWS API Documentation.

ListDomainsRequest

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

ListDomainsRequest generates a "aws/request.Request" representing the client's request for the ListDomains operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListDomains for more information on using the ListDomains 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 ListDomainsRequest method. req, resp := client.ListDomainsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See Also

For more information about using this API, see AWS API Documentation.

ListDomainsWithContext

func (c *SimpleDB) ListDomainsWithContext(ctx aws.Context, input *ListDomainsInput, opts ...request.Option) (*ListDomainsOutput, error)

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

See ListDomains 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.

See Also

For more information about using this API, see AWS API Documentation.

PutAttributes

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

PutAttributes 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

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 SimpleDB's API operation PutAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValue "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeMissingParameter "MissingParameter" The request must contain the specified missing parameter.

  • ErrCodeNoSuchDomain "NoSuchDomain" The specified domain does not exist.

  • ErrCodeNumberDomainAttributesExceeded "NumberDomainAttributesExceeded" Too many attributes in this domain.

  • ErrCodeNumberDomainBytesExceeded "NumberDomainBytesExceeded" Too many bytes in this domain.

  • ErrCodeNumberItemAttributesExceeded "NumberItemAttributesExceeded" Too many attributes in this item.

  • ErrCodeAttributeDoesNotExist "AttributeDoesNotExist" The specified attribute does not exist.

See Also

For more information about using this API, see AWS API Documentation.

PutAttributesRequest

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

PutAttributesRequest generates a "aws/request.Request" representing the client's request for the PutAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 PutAttributes for more information on using the PutAttributes 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 PutAttributesRequest method. req, resp := client.PutAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See Also

For more information about using this API, see AWS API Documentation.

PutAttributesWithContext

func (c *SimpleDB) PutAttributesWithContext(ctx aws.Context, input *PutAttributesInput, opts ...request.Option) (*PutAttributesOutput, error)

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

See PutAttributes 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.

See Also

For more information about using this API, see AWS API Documentation.

Select

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

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

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 SimpleDB's API operation Select for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValue "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified NextToken is not valid.

  • ErrCodeInvalidNumberPredicates "InvalidNumberPredicates" Too many predicates exist in the query expression.

  • ErrCodeInvalidNumberValueTests "InvalidNumberValueTests" Too many predicates exist in the query expression.

  • ErrCodeInvalidQueryExpression "InvalidQueryExpression" The specified query expression syntax is not valid.

  • ErrCodeMissingParameter "MissingParameter" The request must contain the specified missing parameter.

  • ErrCodeNoSuchDomain "NoSuchDomain" The specified domain does not exist.

  • ErrCodeRequestTimeout "RequestTimeout" A timeout occurred when attempting to query the specified domain with specified query expression.

  • ErrCodeTooManyRequestedAttributes "TooManyRequestedAttributes" Too many attributes requested.

See Also

For more information about using this API, see AWS API Documentation.

SelectPages

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

SelectPages iterates over the pages of a Select operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See Select method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a Select operation. pageNum := 0 err := client.SelectPages(params, func(page *SelectOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

SelectPagesWithContext

func (c *SimpleDB) SelectPagesWithContext(ctx aws.Context, input *SelectInput, fn func(*SelectOutput, bool) bool, opts ...request.Option) error

SelectPagesWithContext same as SelectPages except it takes a Context and allows setting request options on the pages.

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.

See Also

For more information about using this API, see AWS API Documentation.

SelectRequest

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

SelectRequest generates a "aws/request.Request" representing the client's request for the Select operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 Select for more information on using the Select 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 SelectRequest method. req, resp := client.SelectRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See Also

For more information about using this API, see AWS API Documentation.

SelectWithContext

func (c *SimpleDB) SelectWithContext(ctx aws.Context, input *SelectInput, opts ...request.Option) (*SelectOutput, error)

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

See Select 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.

See Also

For more information about using this API, see AWS API Documentation.

On this page: