openapi: 3.0.0 info: version: '2009-04-15' x-release: v2 title: 'Amazon SimpleDB #Action=BatchDeleteAttributes #Action=BatchDeleteAttributes #Action=Select API' description: 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/ for more information.
x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: sdb x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/sdb-2009-04-15.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://sdb.amazonaws.com variables: {} description: The general Amazon SimpleDB endpoint for US East (N. Virginia) - url: https://sdb.amazonaws.com variables: {} description: The general Amazon SimpleDB endpoint for US East (N. Virginia) - url: http://sdb.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-2 description: The Amazon SimpleDB multi-region endpoint - url: https://sdb.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-2 description: The Amazon SimpleDB multi-region endpoint - url: http://sdb.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon SimpleDB endpoint for China (Beijing) and China (Ningxia) - url: https://sdb.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon SimpleDB endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#Action=Select' paths: /#Action=Select: parameters: - $ref: '#/components/parameters/AWSAccessKeyId' - $ref: '#/components/parameters/Action' - $ref: '#/components/parameters/SignatureMethod' - $ref: '#/components/parameters/SignatureVersion' - $ref: '#/components/parameters/Timestamp' - $ref: '#/components/parameters/Version' - $ref: '#/components/parameters/Signature' get: x-aws-operation-name: Select operationId: GET_Select description: 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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/SelectResult' '400': description: TooManyRequestedAttributes x-aws-exception: true content: text/xml: schema: $ref: '#/components/schemas/TooManyRequestedAttributes' '408': description: RequestTimeout x-aws-exception: true content: text/xml: schema: $ref: '#/components/schemas/RequestTimeout' parameters: - name: SelectExpression in: query required: true description: The expression used to query the domain. schema: type: string - name: NextToken in: query required: false description: A string informing Amazon SimpleDB where to start the next list ofItemNames.
schema:
type: string
- name: ConsistentRead
in: query
required: false
description: 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.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- Select
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2009-04-15'
summary: Amazon G E T_ Select
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=Select'
post:
x-aws-operation-name: Select
operationId: POST_Select
description: 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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/SelectResult' '400': description: TooManyRequestedAttributes x-aws-exception: true content: text/xml: schema: $ref: '#/components/schemas/TooManyRequestedAttributes' '408': description: RequestTimeout x-aws-exception: true content: text/xml: schema: $ref: '#/components/schemas/RequestTimeout' requestBody: content: text/xml: schema: $ref: '#/components/schemas/SelectRequest' parameters: - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - Select - name: Version in: query required: true schema: type: string enum: - '2009-04-15' summary: Amazon P O S T_ Select x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=Select' components: schemas: Attribute: type: object required: - Name - Value properties: Name: allOf: - $ref: '#/components/schemas/String' - description: The name of the attribute. AlternateNameEncoding: allOf: - $ref: '#/components/schemas/String' - description: '' Value: allOf: - $ref: '#/components/schemas/String' - description: The value of the attribute. AlternateValueEncoding: allOf: - $ref: '#/components/schemas/String' - description: '' description: '' TooManyRequestedAttributes: type: object properties: BoxUsage: $ref: '#/components/schemas/Float' description: Too many attributes requested. SelectRequest: type: object required: - SelectExpression title: SelectRequest properties: SelectExpression: allOf: - $ref: '#/components/schemas/String' - description: The expression used to query the domain. NextToken: allOf: - $ref: '#/components/schemas/String' - description: A string informing Amazon SimpleDB where to start the next list ofItemNames.
ConsistentRead:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 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.
RequestTimeout:
type: object
properties:
BoxUsage:
$ref: '#/components/schemas/Float'
description: A timeout occurred when attempting to query the specified domain with specified query expression.
String:
type: string
Boolean:
type: boolean
Item:
type: object
required:
- Name
- Attributes
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the item.
AlternateNameEncoding:
allOf:
- $ref: '#/components/schemas/String'
- description: ''
Attributes:
allOf:
- $ref: '#/components/schemas/AttributeList'
- description: A list of attributes.
description: ''
SelectResult:
type: object
properties:
Items:
allOf:
- $ref: '#/components/schemas/ItemList'
- description: A list of items that match the select expression.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.
ItemList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Item'
- xml:
name: Item
xml:
wrapped: false
Float:
type: number
format: float
AttributeList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Attribute'
- xml:
name: Attribute
xml:
wrapped: false
parameters:
AWSAccessKeyId:
name: AWSAccessKeyId
in: query
schema:
type: string
required: true
SignatureMethod:
name: SignatureMethod
in: query
schema:
type: string
required: true
SignatureVersion:
name: SignatureVersion
in: query
schema:
type: string
required: true
Signature:
name: Signature
in: query
schema:
type: string
required: true
Timestamp:
name: Timestamp
in: query
schema:
type: string
required: true
Action:
name: Action
in: query
schema:
type: string
required: true
Version:
name: Version
in: query
schema:
type: string
required: true
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v2
x-amazon-apigateway-authtype: awsSigv2
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/sdb/
x-hasEquivalentPaths: true