domains

Creates, updates, deletes, gets or lists a domains resource.

Overview

Name	domains
Type	Resource
Id	aws.sdb.domains

Fields

The following fields are returned by SELECT queries:

list_domains

Name	Datatype	Description
domain_name	string	A list of domain names that match the expression.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_domains	select	region	MaxNumberOfDomains, NextToken	The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A 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.
create_domain	insert	DomainName, region		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. 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/.
delete_domain	delete	DomainName, region		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.
domain_metadata	exec	DomainName, region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DomainName	string	The name of the domain for which to display the metadata of.
region	string	AWS region (default: us-east-1)
MaxNumberOfDomains	integer	The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.
NextToken	string	A string informing Amazon SimpleDB where to start the next list of domain names.

SELECT examples

list_domains

The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A 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.

SELECT
domain_name
FROM aws.sdb.domains
WHERE region = '{{ region }}' -- required
AND MaxNumberOfDomains = '{{ MaxNumberOfDomains }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_domain

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

INSERT INTO aws.sdb.domains (
DomainName,
region
)
SELECT 
'{{ DomainName }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: DomainName
    value: "{{ DomainName }}"
    description: Required parameter for the domains resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the domains resource.

DELETE examples

delete_domain

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.

DELETE FROM aws.sdb.domains
WHERE DomainName = '{{ DomainName }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

domain_metadata

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.

EXEC aws.sdb.domains.domain_metadata 
@DomainName='{{ DomainName }}' --required, 
@region='{{ region }}' --required
;