354 lines
24 KiB
JSON
354 lines
24 KiB
JSON
{
|
|
"version": "2.0",
|
|
"operations": {
|
|
"BatchDeleteAttributes": "<p> 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. </p> <note> <p> If you specify BatchDeleteAttributes without attributes or values, all the attributes for the item are deleted. </p> <p> BatchDeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute doesn't result in an error. </p> <p> 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. </p> <p> This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. </p> <p> This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists. </p> </note> <p> The following limitations are enforced for this operation: <ul> <li>1 MB request size</li> <li>25 item limit per BatchDeleteAttributes operation</li> </ul> </p>",
|
|
"BatchPutAttributes": "<p> The <code>BatchPutAttributes</code> operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple <a>PutAttribute</a> 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. </p> <p> The client may specify the item name with the <code>Item.X.ItemName</code> parameter. The client may specify new attributes using a combination of the <code>Item.X.Attribute.Y.Name</code> and <code>Item.X.Attribute.Y.Value</code> parameters. The client may specify the first attribute for the first item using the parameters <code>Item.0.Attribute.0.Name</code> and <code>Item.0.Attribute.0.Value</code>, and for the second attribute for the first item by the parameters <code>Item.0.Attribute.1.Name</code> and <code>Item.0.Attribute.1.Value</code>, and so on. </p> <p> Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes <code>{ \"first_name\", \"first_value\" }</code> and <code>{ \"first_name\", \"second_value\" }</code>. However, it cannot have two attribute instances where both the <code>Item.X.Attribute.Y.Name</code> and <code>Item.X.Attribute.Y.Value</code> are the same. </p> <p> Optionally, the requester can supply the <code>Replace</code> parameter for each individual value. Setting this value to <code>true</code> will cause the new attribute values to replace the existing attribute values. For example, if an item <code>I</code> has the attributes <code>{ 'a', '1' }, { 'b', '2'}</code> and <code>{ 'b', '3' }</code> and the requester does a BatchPutAttributes of <code>{'I', 'b', '4' }</code> with the Replace parameter set to true, the final attributes of the item will be <code>{ 'a', '1' }</code> and <code>{ 'b', '4' }</code>, replacing the previous values of the 'b' attribute with the new value. </p> <note> You cannot specify an empty string as an item or as an attribute name. The <code>BatchPutAttributes</code> operation succeeds or fails in its entirety. There are no partial puts. </note> <important> 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 <code>Expected.X.Name</code>, <code>Expected.X.Value</code>, or <code>Expected.X.Exists</code>. </important> <p> You can execute multiple <code>BatchPutAttributes</code> operations and other operations in parallel. However, large numbers of concurrent <code>BatchPutAttributes</code> calls can result in Service Unavailable (503) responses. </p> <p> The following limitations are enforced for this operation: <ul> <li>256 attribute name-value pairs per item</li> <li>1 MB request size</li> <li>1 billion attributes per domain</li> <li>10 GB of total user data storage per domain</li> <li>25 item limit per <code>BatchPutAttributes</code> operation</li> </ul> </p>",
|
|
"CreateDomain": "<p> The <code>CreateDomain</code> 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 <code>CreateDomain</code> operation may take 10 or more seconds to complete. </p> <note> CreateDomain is an idempotent operation; running it multiple times using the same domain name will not result in an error response. </note> <p> The client can create up to 100 domains per account. </p> <p> If the client requires additional domains, go to <a href=\"http://aws.amazon.com/contact-us/simpledb-limit-request/\"> http://aws.amazon.com/contact-us/simpledb-limit-request/</a>. </p>",
|
|
"DeleteAttributes": "<p> Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted. </p> <note> If <code>DeleteAttributes</code> is called without being passed any attributes or values specified, all the attributes for the item are deleted. </note> <p> <code>DeleteAttributes</code> is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response. </p> <p> Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a <a>GetAttributes</a> or <a>Select</a> operation (read) immediately after a <code>DeleteAttributes</code> or <a>PutAttributes</a> operation (write) might not return updated item data. </p>",
|
|
"DeleteDomain": "<p> The <code>DeleteDomain</code> operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The <code>DeleteDomain</code> operation might take 10 or more seconds to complete. </p> <note> Running <code>DeleteDomain</code> 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. </note>",
|
|
"DomainMetadata": "<p> 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. </p>",
|
|
"GetAttributes": "<p> 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. </p> <p> 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. </p> <note> If GetAttributes is called without being passed any attribute names, all the attributes for the item are returned. </note>",
|
|
"ListDomains": "<p> The <code>ListDomains</code> operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by <a href=\"#MaxNumberOfDomains\">MaxNumberOfDomains</a>. A <a href=\"#NextToken\">NextToken</a> is returned if there are more than <code>MaxNumberOfDomains</code> domains. Calling <code>ListDomains</code> successive times with the <code>NextToken</code> provided by the operation returns up to <code>MaxNumberOfDomains</code> more domain names with each successive operation call. </p>",
|
|
"PutAttributes": "<p> The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the <code>Attribute.X.Name</code> and <code>Attribute.X.Value</code> parameters. The client specifies the first attribute by the parameters <code>Attribute.0.Name</code> and <code>Attribute.0.Value</code>, the second attribute by the parameters <code>Attribute.1.Name</code> and <code>Attribute.1.Value</code>, and so on. </p> <p> Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes <code>{ \"first_name\", \"first_value\" }</code> and <code>{ \"first_name\", second_value\" }</code>. However, it cannot have two attribute instances where both the <code>Attribute.X.Name</code> and <code>Attribute.X.Value</code> are the same. </p> <p> Optionally, the requestor can supply the <code>Replace</code> parameter for each individual attribute. Setting this value to <code>true</code> causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes <code>{ 'a', '1' }</code>, <code>{ 'b', '2'}</code> and <code>{ 'b', '3' }</code> and the requestor calls <code>PutAttributes</code> using the attributes <code>{ 'b', '4' }</code> with the <code>Replace</code> parameter set to true, the final attributes of the item are changed to <code>{ 'a', '1' }</code> and <code>{ 'b', '4' }</code>, which replaces the previous values of the 'b' attribute with the new value. </p> <note> Using <code>PutAttributes</code> to replace attribute values that do not exist will not result in an error response. </note> <p> You cannot specify an empty string as an attribute name. </p> <p> Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate <a>GetAttributes</a> or <a>Select</a> operation (read) immediately after a <a>PutAttributes</a> or <a>DeleteAttributes</a> operation (write) might not return the updated data. </p> <p> The following limitations are enforced for this operation: <ul> <li>256 total attribute name-value pairs per item</li> <li>One billion attributes per domain</li> <li>10 GB of total user data storage per domain</li> </ul> </p>",
|
|
"Select": "<p> The <code>Select</code> operation returns a set of attributes for <code>ItemNames</code> that match the select expression. <code>Select</code> is similar to the standard SQL SELECT statement. </p> <p> 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 <code>NextToken</code> so the client can access the next page of results. </p> <p> For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide. </p>"
|
|
},
|
|
"service": "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. <p> 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. </p> <p> Visit <a href=\"http://aws.amazon.com/simpledb/\">http://aws.amazon.com/simpledb/</a> for more information. </p>",
|
|
"shapes": {
|
|
"Attribute": {
|
|
"base": "<p></p>",
|
|
"refs": {
|
|
"AttributeList$member": null
|
|
}
|
|
},
|
|
"AttributeDoesNotExist": {
|
|
"base": "<p>The specified attribute does not exist.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"AttributeList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetAttributesResult$Attributes": "The list of attributes returned by the operation.",
|
|
"Item$Attributes": "A list of attributes."
|
|
}
|
|
},
|
|
"AttributeNameList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetAttributesRequest$AttributeNames": "The names of the attributes."
|
|
}
|
|
},
|
|
"BatchDeleteAttributesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"BatchPutAttributesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"Boolean": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetAttributesRequest$ConsistentRead": "Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If <code>true</code>, 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.",
|
|
"ReplaceableAttribute$Replace": "A flag specifying whether or not to replace the attribute/value pair or to add a new attribute/value pair. The default setting is <code>false</code>.",
|
|
"SelectRequest$ConsistentRead": "Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If <code>true</code>, 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.",
|
|
"UpdateCondition$Exists": "<p>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 <code>true</code> if the attribute must exist for the update condition to be satisfied. Specify <code>false</code> if the attribute should not exist in order for the update condition to be satisfied.</p>"
|
|
}
|
|
},
|
|
"CreateDomainRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeletableAttribute": {
|
|
"base": "<p></p>",
|
|
"refs": {
|
|
"DeletableAttributeList$member": null
|
|
}
|
|
},
|
|
"DeletableAttributeList": {
|
|
"base": null,
|
|
"refs": {
|
|
"DeletableItem$Attributes": null,
|
|
"DeleteAttributesRequest$Attributes": "A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items."
|
|
}
|
|
},
|
|
"DeletableItem": {
|
|
"base": null,
|
|
"refs": {
|
|
"DeletableItemList$member": null
|
|
}
|
|
},
|
|
"DeletableItemList": {
|
|
"base": null,
|
|
"refs": {
|
|
"BatchDeleteAttributesRequest$Items": "A list of items on which to perform the operation."
|
|
}
|
|
},
|
|
"DeleteAttributesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteDomainRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DomainMetadataRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DomainMetadataResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DomainNameList": {
|
|
"base": null,
|
|
"refs": {
|
|
"ListDomainsResult$DomainNames": "A list of domain names that match the expression."
|
|
}
|
|
},
|
|
"DuplicateItemName": {
|
|
"base": "<p>The item name was specified more than once. </p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"Float": {
|
|
"base": null,
|
|
"refs": {
|
|
"AttributeDoesNotExist$BoxUsage": null,
|
|
"DuplicateItemName$BoxUsage": null,
|
|
"InvalidNextToken$BoxUsage": null,
|
|
"InvalidNumberPredicates$BoxUsage": null,
|
|
"InvalidNumberValueTests$BoxUsage": null,
|
|
"InvalidParameterValue$BoxUsage": null,
|
|
"InvalidQueryExpression$BoxUsage": null,
|
|
"MissingParameter$BoxUsage": null,
|
|
"NoSuchDomain$BoxUsage": null,
|
|
"NumberDomainAttributesExceeded$BoxUsage": null,
|
|
"NumberDomainBytesExceeded$BoxUsage": null,
|
|
"NumberDomainsExceeded$BoxUsage": null,
|
|
"NumberItemAttributesExceeded$BoxUsage": null,
|
|
"NumberSubmittedAttributesExceeded$BoxUsage": null,
|
|
"NumberSubmittedItemsExceeded$BoxUsage": null,
|
|
"RequestTimeout$BoxUsage": null,
|
|
"TooManyRequestedAttributes$BoxUsage": null
|
|
}
|
|
},
|
|
"GetAttributesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetAttributesResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"Integer": {
|
|
"base": null,
|
|
"refs": {
|
|
"DomainMetadataResult$ItemCount": "The number of all items in the domain.",
|
|
"DomainMetadataResult$AttributeNameCount": "The number of unique attribute names in the domain.",
|
|
"DomainMetadataResult$AttributeValueCount": "The number of all attribute name/value pairs in the domain.",
|
|
"DomainMetadataResult$Timestamp": "The data and time when metadata was calculated, in Epoch (UNIX) seconds.",
|
|
"ListDomainsRequest$MaxNumberOfDomains": "The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100."
|
|
}
|
|
},
|
|
"InvalidNextToken": {
|
|
"base": "<p>The specified NextToken is not valid. </p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"InvalidNumberPredicates": {
|
|
"base": "<p>Too many predicates exist in the query expression.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"InvalidNumberValueTests": {
|
|
"base": "<p>Too many predicates exist in the query expression.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"InvalidParameterValue": {
|
|
"base": "<p>The value for a parameter is invalid.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"InvalidQueryExpression": {
|
|
"base": "<p>The specified query expression syntax is not valid.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"Item": {
|
|
"base": "<p></p>",
|
|
"refs": {
|
|
"ItemList$member": null
|
|
}
|
|
},
|
|
"ItemList": {
|
|
"base": null,
|
|
"refs": {
|
|
"SelectResult$Items": "A list of items that match the select expression."
|
|
}
|
|
},
|
|
"ListDomainsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"ListDomainsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"Long": {
|
|
"base": null,
|
|
"refs": {
|
|
"DomainMetadataResult$ItemNamesSizeBytes": "The total size of all item names in the domain, in bytes.",
|
|
"DomainMetadataResult$AttributeNamesSizeBytes": "The total size of all unique attribute names in the domain, in bytes.",
|
|
"DomainMetadataResult$AttributeValuesSizeBytes": "The total size of all attribute values in the domain, in bytes."
|
|
}
|
|
},
|
|
"MissingParameter": {
|
|
"base": "<p>The request must contain the specified missing parameter.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"NoSuchDomain": {
|
|
"base": "<p>The specified domain does not exist.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"NumberDomainAttributesExceeded": {
|
|
"base": "<p>Too many attributes in this domain.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"NumberDomainBytesExceeded": {
|
|
"base": "<p>Too many bytes in this domain.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"NumberDomainsExceeded": {
|
|
"base": "<p>Too many domains exist per this account.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"NumberItemAttributesExceeded": {
|
|
"base": "<p>Too many attributes in this item.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"NumberSubmittedAttributesExceeded": {
|
|
"base": "<p>Too many attributes exist in a single call.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"NumberSubmittedItemsExceeded": {
|
|
"base": "<p>Too many items exist in a single call.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"PutAttributesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"ReplaceableAttribute": {
|
|
"base": "<p></p>",
|
|
"refs": {
|
|
"ReplaceableAttributeList$member": null
|
|
}
|
|
},
|
|
"ReplaceableAttributeList": {
|
|
"base": null,
|
|
"refs": {
|
|
"PutAttributesRequest$Attributes": "The list of attributes.",
|
|
"ReplaceableItem$Attributes": "The list of attributes for a replaceable item."
|
|
}
|
|
},
|
|
"ReplaceableItem": {
|
|
"base": "<p></p>",
|
|
"refs": {
|
|
"ReplaceableItemList$member": null
|
|
}
|
|
},
|
|
"ReplaceableItemList": {
|
|
"base": null,
|
|
"refs": {
|
|
"BatchPutAttributesRequest$Items": "A list of items on which to perform the operation."
|
|
}
|
|
},
|
|
"RequestTimeout": {
|
|
"base": "<p>A timeout occurred when attempting to query the specified domain with specified query expression.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"SelectRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"SelectResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"String": {
|
|
"base": null,
|
|
"refs": {
|
|
"Attribute$Name": "The name of the attribute.",
|
|
"Attribute$AlternateNameEncoding": "<p></p>",
|
|
"Attribute$Value": "The value of the attribute.",
|
|
"Attribute$AlternateValueEncoding": "<p></p>",
|
|
"AttributeNameList$member": null,
|
|
"BatchDeleteAttributesRequest$DomainName": "The name of the domain in which the attributes are being deleted.",
|
|
"BatchPutAttributesRequest$DomainName": "The name of the domain in which the attributes are being stored.",
|
|
"CreateDomainRequest$DomainName": "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 '.'.",
|
|
"DeletableAttribute$Name": "The name of the attribute.",
|
|
"DeletableAttribute$Value": "The value of the attribute.",
|
|
"DeletableItem$Name": null,
|
|
"DeleteAttributesRequest$DomainName": "The name of the domain in which to perform the operation.",
|
|
"DeleteAttributesRequest$ItemName": "The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.",
|
|
"DeleteDomainRequest$DomainName": "The name of the domain to delete.",
|
|
"DomainMetadataRequest$DomainName": "The name of the domain for which to display the metadata of.",
|
|
"DomainNameList$member": null,
|
|
"GetAttributesRequest$DomainName": "The name of the domain in which to perform the operation.",
|
|
"GetAttributesRequest$ItemName": "The name of the item.",
|
|
"Item$Name": "The name of the item.",
|
|
"Item$AlternateNameEncoding": "<p></p>",
|
|
"ListDomainsRequest$NextToken": "A string informing Amazon SimpleDB where to start the next list of domain names.",
|
|
"ListDomainsResult$NextToken": "An opaque token indicating that there are more domains than the specified <code>MaxNumberOfDomains</code> still available.",
|
|
"PutAttributesRequest$DomainName": "The name of the domain in which to perform the operation.",
|
|
"PutAttributesRequest$ItemName": "The name of the item.",
|
|
"ReplaceableAttribute$Name": "The name of the replaceable attribute.",
|
|
"ReplaceableAttribute$Value": "The value of the replaceable attribute.",
|
|
"ReplaceableItem$Name": "The name of the replaceable item.",
|
|
"SelectRequest$SelectExpression": "The expression used to query the domain.",
|
|
"SelectRequest$NextToken": "A string informing Amazon SimpleDB where to start the next list of <code>ItemNames</code>.",
|
|
"SelectResult$NextToken": "An opaque token indicating that more items than <code>MaxNumberOfItems</code> were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.",
|
|
"UpdateCondition$Name": "<p>The name of the attribute involved in the condition.</p>",
|
|
"UpdateCondition$Value": "<p>The value of an attribute. This value can only be specified when the <code>Exists</code> parameter is equal to <code>true</code>.</p>"
|
|
}
|
|
},
|
|
"TooManyRequestedAttributes": {
|
|
"base": "<p>Too many attributes requested.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"UpdateCondition": {
|
|
"base": "<p> 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. </p>",
|
|
"refs": {
|
|
"DeleteAttributesRequest$Expected": "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.",
|
|
"PutAttributesRequest$Expected": "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."
|
|
}
|
|
}
|
|
}
|
|
}
|