Length constraints: Minimum length of 1. Maximum length of 64.
Required: No
IndexField
Description
Configuration information for a field in the index, including its name, type, and options.The supported
options depend on the  IndexFieldType .
Contents
DateArrayOptions
Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is
of type date-array. All options are enabled by default.
Type:DateArrayOptions (p.203)
Required: No
DateOptions
Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according
to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type
date. All options are enabled by default.
Type:DateOptions (p.203)
Required: No
DoubleArrayOptions
Options for a field that contains an array of double-precision 64-bit floating point values. Present if
IndexFieldType specifies the field is of type double-array. All options are enabled by default.
Type:DoubleArrayOptions (p.212)
Required: No
DoubleOptions
Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the
field is of type double. All options are enabled by default.
Type:DoubleOptions (p.213)
Required: No
IndexFieldName
A string that represents the name of an index field. CloudSearch supports regular index fields as well
as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any
document fields that don't map to a regular index field but do match a dynamic field's pattern are
configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase),
0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*).The wildcard
can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded
within a string are not supported.
The name score is reserved and cannot be used as a field name.To reference a document's ID,
you can use the name _id.
Type: String
API Version 2013-01-01
215
Amazon CloudSearch Developer Guide
Data Types
Pdf reader with bookmarks - add, remove, update PDF bookmarks in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your C# Project with Rapid PDF Internal Navigation Via Bookmark and Outline
creating bookmarks in pdf from word; create bookmarks pdf file
Pdf reader with bookmarks - VB.NET PDF bookmark library: add, remove, update PDF bookmarks in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your VB.NET Project with Rapid PDF Internal Navigation Via Bookmark and Outline
add bookmark to pdf reader; auto bookmark pdf
Length constraints: Minimum length of 1. Maximum length of 64.
Required:Yes
IndexFieldType
The type of field.The valid options for a field depend on the field type. For more information about
the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
Type: String
Valid Values:int | double | literal | text | date | latlon | int-array |
double-array | literal-array | text-array | date-array
Required:Yes
IntArrayOptions
Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType
specifies the field is of type int-array. All options are enabled by default.
Type:IntArrayOptions (p.217)
Required: No
IntOptions
Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type
int. All options are enabled by default.
Type:IntOptions (p.218)
Required: No
LatLonOptions
Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value
pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by
default.
Type:LatLonOptions (p.219)
Required: No
LiteralArrayOptions
Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the
field is of type literal-array. All options are enabled by default.
Type:LiteralArrayOptions (p.220)
Required: No
LiteralOptions
Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options
are enabled by default.
Type:LiteralOptions (p.221)
Required: No
TextArrayOptions
Options for a field that contains an array of text strings. Present if IndexFieldType specifies the
field is of type text-array. A text-array field is always searchable. All options are enabled by
default.
Type:TextArrayOptions (p.225)
Required: No
API Version 2013-01-01
216
Amazon CloudSearch Developer Guide
Data Types
VB.NET PDF File Compress Library: Compress reduce PDF size in vb.
document file. Remove bookmarks, annotations, watermark, page labels and article threads from PDF while compressing. Also a preview
export pdf bookmarks to excel; delete bookmarks pdf
C# PDF File Split Library: Split, seperate PDF into multiple files
Split PDF file by top level bookmarks. The following C# codes explain how to split a PDF file into multiple ones by PDF bookmarks or outlines.
pdf bookmark; convert excel to pdf with bookmarks
TextOptions
Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is
always searchable. All options are enabled by default.
Type:TextOptions (p.226)
Required: No
IndexFieldStatus
Description
The value of an IndexField and its current status.
Contents
Options
Configuration information for a field in the index, including its name, type, and options.The supported
options depend on the  IndexFieldType .
Type:IndexField (p.215)
Required:Yes
Status
The status of domain configuration option.
Type:OptionStatus (p.222)
Required:Yes
IntArrayOptions
Description
Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies
the field is of type int-array. All options are enabled by default.
Contents
DefaultValue
A value to use for the field if the field isn't specified for a document.
Type: Long
Required: No
FacetEnabled
Whether facet information can be returned for the field.
Type: Boolean
Required: No
ReturnEnabled
Whether the contents of the field can be returned in the search results.
Type: Boolean
API Version 2013-01-01
217
Amazon CloudSearch Developer Guide
Data Types
VB.NET PDF File Split Library: Split, seperate PDF into multiple
Demo Code in VB.NET. The following VB.NET codes explain how to split a PDF file into multiple ones by PDF bookmarks or outlines.
copy bookmarks from one pdf to another; add bookmark pdf file
C# PDF File Compress Library: Compress reduce PDF size in C#.net
NET framework. Remove bookmarks, annotations, watermark, page labels and article threads from PDF while compressing. C# class demo
how to add a bookmark in pdf; export pdf bookmarks
Required: No
SearchEnabled
Whether the contents of the field are searchable.
Type: Boolean
Required: No
SourceFields
A list of source fields to map to the field.
Type: String
Required: No
IntOptions
Description
Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int.
All options are enabled by default.
Contents
DefaultValue
A value to use for the field if the field isn't specified for a document.This can be important if you are
using the field in an expression and that field is not present in every document.
Type: Long
Required: No
FacetEnabled
Whether facet information can be returned for the field.
Type: Boolean
Required: No
ReturnEnabled
Whether the contents of the field can be returned in the search results.
Type: Boolean
Required: No
SearchEnabled
Whether the contents of the field are searchable.
Type: Boolean
Required: No
SortEnabled
Whether the field can be used to sort the search results.
Type: Boolean
Required: No
SourceField
The name of the source field to map to the field.
API Version 2013-01-01
218
Amazon CloudSearch Developer Guide
Data Types
.NET PDF SDK | Read & Processing PDF files
Include extraction of text, hyperlinks, bookmarks and metadata; Advanced document and Pricing. RasterEdge provides royalty-free .NET Imaging PDF Reader SDK of
bookmarks in pdf from word; pdf export bookmarks
.NET PDF SDK - Description of All PDF Processing Control Feastures
Fully featured PDF Viewer in HTML5; Outstanding rendering of PDF documents; Full page navigation, zooming & rotation; Outlines, bookmarks, & thumbnail display;
pdf bookmark editor; add bookmark pdf
Type: String
Length constraints: Minimum length of 1. Maximum length of 64.
Required: No
LatLonOptions
Description
Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair.
Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.
Contents
DefaultValue
A value to use for the field if the field isn't specified for a document.
Type: String
Length constraints: Minimum length of 0. Maximum length of 1024.
Required: No
FacetEnabled
Whether facet information can be returned for the field.
Type: Boolean
Required: No
ReturnEnabled
Whether the contents of the field can be returned in the search results.
Type: Boolean
Required: No
SearchEnabled
Whether the contents of the field are searchable.
Type: Boolean
Required: No
SortEnabled
Whether the field can be used to sort the search results.
Type: Boolean
Required: No
SourceField
A string that represents the name of an index field. CloudSearch supports regular index fields as well
as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any
document fields that don't map to a regular index field but do match a dynamic field's pattern are
configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase),
0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*).The wildcard
can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded
within a string are not supported.
API Version 2013-01-01
219
Amazon CloudSearch Developer Guide
Data Types
XDoc.Word for .NET, Advanced .NET Word Processing Features
& rotation; Outlines, bookmarks, & thumbnail display; Integrated annotation; More about Web Viewer ▶. Conversion. Word Create. Create Word from PDF; Create Word
how to create bookmark in pdf automatically; how to create bookmarks in pdf file
XDoc.PowerPoint for .NET, All Mature Features Introductions
& rotation; Outlines, bookmarks, & thumbnail display; Integrated annotation; More about Web Viewer ▶. PowerPoint Convert. Convert PowerPoint to PDF; Convert
bookmark a pdf file; creating bookmarks in pdf files
The name score is reserved and cannot be used as a field name.To reference a document's ID,
you can use the name _id.
Type: String
Length constraints: Minimum length of 1. Maximum length of 64.
Required: No
Limits
Description
No action documentation available.
Contents
MaximumPartitionCount
Type: Integer
Required:Yes
MaximumReplicationCount
Type: Integer
Required:Yes
ListDomainNamesResult
Description
The result of a ListDomainNames request. Contains a list of the domains owned by an account.
Contents
DomainNames
The names of the search domains owned by an account.
Type: String to String map
Required: No
LiteralArrayOptions
Description
Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field
is of type literal-array. All options are enabled by default.
Contents
DefaultValue
A value to use for the field if the field isn't specified for a document.
Type: String
Length constraints: Minimum length of 0. Maximum length of 1024.
API Version 2013-01-01
220
Amazon CloudSearch Developer Guide
Data Types
Required: No
FacetEnabled
Whether facet information can be returned for the field.
Type: Boolean
Required: No
ReturnEnabled
Whether the contents of the field can be returned in the search results.
Type: Boolean
Required: No
SearchEnabled
Whether the contents of the field are searchable.
Type: Boolean
Required: No
SourceFields
A list of source fields to map to the field.
Type: String
Required: No
LiteralOptions
Description
Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options
are enabled by default.
Contents
DefaultValue
A value to use for the field if the field isn't specified for a document.
Type: String
Length constraints: Minimum length of 0. Maximum length of 1024.
Required: No
FacetEnabled
Whether facet information can be returned for the field.
Type: Boolean
Required: No
ReturnEnabled
Whether the contents of the field can be returned in the search results.
Type: Boolean
Required: No
SearchEnabled
Whether the contents of the field are searchable.
API Version 2013-01-01
221
Amazon CloudSearch Developer Guide
Data Types
Type: Boolean
Required: No
SortEnabled
Whether the field can be used to sort the search results.
Type: Boolean
Required: No
SourceField
A string that represents the name of an index field. CloudSearch supports regular index fields as well
as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any
document fields that don't map to a regular index field but do match a dynamic field's pattern are
configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase),
0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*).The wildcard
can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded
within a string are not supported.
The name score is reserved and cannot be used as a field name.To reference a document's ID,
you can use the name _id.
Type: String
Length constraints: Minimum length of 1. Maximum length of 64.
Required: No
OptionStatus
Description
The status of domain configuration option.
Contents
CreationDate
A timestamp for when this option was created.
Type: DateTime
Required:Yes
PendingDeletion
Indicates that the option will be deleted once processing is complete.
Type: Boolean
Required: No
State
The state of processing a change to an option. Possible values:
• RequiresIndexDocuments: the option's latest value will not be deployed until
IndexDocuments (p.187) has been called and indexing is complete.
• Processing: the option's latest value is in the process of being activated.
• Active: the option's latest value is completely deployed.
API Version 2013-01-01
222
Amazon CloudSearch Developer Guide
Data Types
• FailedToValidate: the option value is not compatible with the domain's data and cannot be
used to index the data.You must either modify the option value or update or remove the incompatible
documents.
Type: String
Valid Values:RequiresIndexDocuments | Processing | Active | FailedToValidate
Required:Yes
UpdateDate
A timestamp for when this option was last updated.
Type: DateTime
Required:Yes
UpdateVersion
A unique integer that indicates when this option was last updated.
Type: Integer
Required: No
ScalingParameters
Description
The desired instance type and desired number of replicas of each index partition.
Contents
DesiredInstanceType
The instance type that you want to preconfigure for your domain. For example, search.m1.small.
Type: String
Valid Values:search.m1.small | search.m3.medium | search.m3.large |
search.m3.xlarge | search.m3.2xlarge
Note
For domains created prior to February, 2015, valid values may also include
search.m1.largesearch.m2.xlarge, and search.m2.2xlarge.
Required: No
DesiredPartitionCount
The number of partitions you want to preconfigure for your domain. Only valid when you select
m3.2xlarge as the instance type.
Type: Integer
Required: No
DesiredReplicationCount
The number of replicas you want to preconfigure for each index partition.
Type: Integer
Required: No
API Version 2013-01-01
223
Amazon CloudSearch Developer Guide
Data Types
ScalingParametersStatus
Description
The status and configuration of a search domain's scaling parameters.
Contents
Options
The desired instance type and desired number of replicas of each index partition.
Type:ScalingParameters (p.223)
Required:Yes
Status
The status of domain configuration option.
Type:OptionStatus (p.222)
Required:Yes
ServiceEndpoint
Description
The endpoint to which service requests can be submitted.
Contents
Endpoint
The endpoint to which service requests can be submitted. For example,
search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
or
doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.
Type: String
Required: No
Suggester
Description
Configuration information for a search suggester. Each suggester has a unique name and specifies the
text field you want to use for suggestions.The following options can be configured for a suggester:
FuzzyMatchingSortExpression.
Contents
DocumentSuggesterOptions
Options for a search suggester.
Type:DocumentSuggesterOptions (p.209)
Required:Yes
API Version 2013-01-01
224
Amazon CloudSearch Developer Guide
Data Types
Documents you may be interested
Documents you may be interested