CloudSearch ¶

Table of Contents

CloudSearch
- Client
- Paginators

Client ¶

class CloudSearch.Client¶

A low-level client representing Amazon CloudSearch:

import boto3

client = boto3.client('cloudsearch')

These are the available methods:

build_suggesters(**kwargs)¶

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.build_suggesters(
    DomainName='string'
)

Parameters

DomainName (string) --

[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Return type

dict

Returns

Response Syntax

{
    'FieldNames': [
        'string',
    ]
}

Response Structure

(dict) --
The result of a BuildSuggester request. Contains a list of the fields used for suggestions.
- FieldNames (list) --
  A list of field names.
  - (string) --
    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 .

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

create_domain(**kwargs)¶

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_domain(
    DomainName='string'
)

Parameters

DomainName (string) --

[REQUIRED]

A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.

Return type

dict

Returns

Response Syntax

{
    'DomainStatus': {
        'DomainId': 'string',
        'DomainName': 'string',
        'ARN': 'string',
        'Created': True|False,
        'Deleted': True|False,
        'DocService': {
            'Endpoint': 'string'
        },
        'SearchService': {
            'Endpoint': 'string'
        },
        'RequiresIndexDocuments': True|False,
        'Processing': True|False,
        'SearchInstanceType': 'string',
        'SearchPartitionCount': 123,
        'SearchInstanceCount': 123,
        'Limits': {
            'MaximumReplicationCount': 123,
            'MaximumPartitionCount': 123
        }
    }
}

Response Structure

(dict) --
The result of a CreateDomainRequest . Contains the status of a newly created domain.
- DomainStatus (dict) --
  The current status of the search domain.
  - DomainId (string) --
    An internally generated unique identifier for a domain.
  - DomainName (string) --
    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  - ARN (string) --
    The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
  - Created (boolean) --
    True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
  - Deleted (boolean) --
    True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
  - DocService (dict) --
    The service endpoint for updating documents in a search domain.
    - Endpoint (string) --
      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 .
  - SearchService (dict) --
    The service endpoint for requesting search results from a search domain.
    - Endpoint (string) --
      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 .
  - RequiresIndexDocuments (boolean) --
    True if IndexDocuments needs to be called to activate the current domain configuration.
  - Processing (boolean) --
    True if processing is being done to activate the current domain configuration.
  - SearchInstanceType (string) --
    The instance type that is being used to process search requests.
  - SearchPartitionCount (integer) --
    The number of partitions across which the search index is spread.
  - SearchInstanceCount (integer) --
    The number of search instances that are available to process search requests.
  - Limits (dict) --
    - MaximumReplicationCount (integer) --
    - MaximumPartitionCount (integer) --

define_analysis_scheme(**kwargs)¶

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.define_analysis_scheme(
    DomainName='string',
    AnalysisScheme={
        'AnalysisSchemeName': 'string',
        'AnalysisSchemeLanguage': 'ar'|'bg'|'ca'|'cs'|'da'|'de'|'el'|'en'|'es'|'eu'|'fa'|'fi'|'fr'|'ga'|'gl'|'he'|'hi'|'hu'|'hy'|'id'|'it'|'ja'|'ko'|'lv'|'mul'|'nl'|'no'|'pt'|'ro'|'ru'|'sv'|'th'|'tr'|'zh-Hans'|'zh-Hant',
        'AnalysisOptions': {
            'Synonyms': 'string',
            'Stopwords': 'string',
            'StemmingDictionary': 'string',
            'JapaneseTokenizationDictionary': 'string',
            'AlgorithmicStemming': 'none'|'minimal'|'light'|'full'
        }
    }
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
AnalysisScheme (dict) --
[REQUIRED]

Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms , Stopwords , StemmingDictionary , JapaneseTokenizationDictionary and AlgorithmicStemming .
- AnalysisSchemeName (string) -- [REQUIRED]
  Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
- AnalysisSchemeLanguage (string) -- [REQUIRED]
  An IETF RFC 4646 language code or mul for multiple languages.
- AnalysisOptions (dict) --
  Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
  - Synonyms (string) --
    A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide .
  - Stopwords (string) --
    A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"] . The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
  - StemmingDictionary (string) --
    A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"} . The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
  - JapaneseTokenizationDictionary (string) --
    A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
  - AlgorithmicStemming (string) --
    The level of algorithmic stemming to perform: none , minimal , light , or full . The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

Return type

dict

Returns

Response Syntax

{
    'AnalysisScheme': {
        'Options': {
            'AnalysisSchemeName': 'string',
            'AnalysisSchemeLanguage': 'ar'|'bg'|'ca'|'cs'|'da'|'de'|'el'|'en'|'es'|'eu'|'fa'|'fi'|'fr'|'ga'|'gl'|'he'|'hi'|'hu'|'hy'|'id'|'it'|'ja'|'ko'|'lv'|'mul'|'nl'|'no'|'pt'|'ro'|'ru'|'sv'|'th'|'tr'|'zh-Hans'|'zh-Hant',
            'AnalysisOptions': {
                'Synonyms': 'string',
                'Stopwords': 'string',
                'StemmingDictionary': 'string',
                'JapaneseTokenizationDictionary': 'string',
                'AlgorithmicStemming': 'none'|'minimal'|'light'|'full'
            }
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a `` DefineAnalysisScheme`` request. Contains the status of the newly-configured analysis scheme.
- AnalysisScheme (dict) --
  
  The status and configuration of an AnalysisScheme .
  - Options (dict) --
    
    Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms , Stopwords , StemmingDictionary , JapaneseTokenizationDictionary and AlgorithmicStemming .
    - AnalysisSchemeName (string) --
      
      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
    - AnalysisSchemeLanguage (string) --
      
      An IETF RFC 4646 language code or mul for multiple languages.
    - AnalysisOptions (dict) --
      
      Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
      - Synonyms (string) --
        
        A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide .
      - Stopwords (string) --
        
        A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"] . The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
      - StemmingDictionary (string) --
        
        A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"} . The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
      - JapaneseTokenizationDictionary (string) --
        
        A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
      - AlgorithmicStemming (string) --
        
        The level of algorithmic stemming to perform: none , minimal , light , or full . The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

define_expression(**kwargs)¶

Configures an `` Expression`` for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.define_expression(
    DomainName='string',
    Expression={
        'ExpressionName': 'string',
        'ExpressionValue': 'string'
    }
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Expression (dict) --
[REQUIRED]

A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.
- ExpressionName (string) -- [REQUIRED]
  Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
- ExpressionValue (string) -- [REQUIRED]
  The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .

Return type

dict

Returns

Response Syntax

{
    'Expression': {
        'Options': {
            'ExpressionName': 'string',
            'ExpressionValue': 'string'
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a DefineExpression request. Contains the status of the newly-configured expression.
- Expression (dict) --
  
  The value of an Expression and its current status.
  - Options (dict) --
    
    The expression that is evaluated for sorting while processing a search request.
    - ExpressionName (string) --
      
      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
    - ExpressionValue (string) --
      
      The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

define_index_field(**kwargs)¶

Configures an `` IndexField`` for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the `` IndexFieldType`` . If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.define_index_field(
    DomainName='string',
    IndexField={
        'IndexFieldName': 'string',
        'IndexFieldType': 'int'|'double'|'literal'|'text'|'date'|'latlon'|'int-array'|'double-array'|'literal-array'|'text-array'|'date-array',
        'IntOptions': {
            'DefaultValue': 123,
            'SourceField': 'string',
            'FacetEnabled': True|False,
            'SearchEnabled': True|False,
            'ReturnEnabled': True|False,
            'SortEnabled': True|False
        },
        'DoubleOptions': {
            'DefaultValue': 123.0,
            'SourceField': 'string',
            'FacetEnabled': True|False,
            'SearchEnabled': True|False,
            'ReturnEnabled': True|False,
            'SortEnabled': True|False
        },
        'LiteralOptions': {
            'DefaultValue': 'string',
            'SourceField': 'string',
            'FacetEnabled': True|False,
            'SearchEnabled': True|False,
            'ReturnEnabled': True|False,
            'SortEnabled': True|False
        },
        'TextOptions': {
            'DefaultValue': 'string',
            'SourceField': 'string',
            'ReturnEnabled': True|False,
            'SortEnabled': True|False,
            'HighlightEnabled': True|False,
            'AnalysisScheme': 'string'
        },
        'DateOptions': {
            'DefaultValue': 'string',
            'SourceField': 'string',
            'FacetEnabled': True|False,
            'SearchEnabled': True|False,
            'ReturnEnabled': True|False,
            'SortEnabled': True|False
        },
        'LatLonOptions': {
            'DefaultValue': 'string',
            'SourceField': 'string',
            'FacetEnabled': True|False,
            'SearchEnabled': True|False,
            'ReturnEnabled': True|False,
            'SortEnabled': True|False
        },
        'IntArrayOptions': {
            'DefaultValue': 123,
            'SourceFields': 'string',
            'FacetEnabled': True|False,
            'SearchEnabled': True|False,
            'ReturnEnabled': True|False
        },
        'DoubleArrayOptions': {
            'DefaultValue': 123.0,
            'SourceFields': 'string',
            'FacetEnabled': True|False,
            'SearchEnabled': True|False,
            'ReturnEnabled': True|False
        },
        'LiteralArrayOptions': {
            'DefaultValue': 'string',
            'SourceFields': 'string',
            'FacetEnabled': True|False,
            'SearchEnabled': True|False,
            'ReturnEnabled': True|False
        },
        'TextArrayOptions': {
            'DefaultValue': 'string',
            'SourceFields': 'string',
            'ReturnEnabled': True|False,
            'HighlightEnabled': True|False,
            'AnalysisScheme': 'string'
        },
        'DateArrayOptions': {
            'DefaultValue': 'string',
            'SourceFields': 'string',
            'FacetEnabled': True|False,
            'SearchEnabled': True|False,
            'ReturnEnabled': True|False
        }
    }
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
IndexField (dict) --
[REQUIRED]

The index field and field options you want to configure.
- IndexFieldName (string) -- [REQUIRED]
  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 .
- IndexFieldType (string) -- [REQUIRED]
  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 .
- IntOptions (dict) --
  Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int . All options are enabled by default.
  - DefaultValue (integer) -- 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.
  - SourceField (string) --
    The name of the source field to map to the field.
  - FacetEnabled (boolean) --
    Whether facet information can be returned for the field.
  - SearchEnabled (boolean) --
    Whether the contents of the field are searchable.
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.
  - SortEnabled (boolean) --
    Whether the field can be used to sort the search results.
- DoubleOptions (dict) --
  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.
  - DefaultValue (float) --
    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.
  - SourceField (string) --
    The name of the source field to map to the field.
  - FacetEnabled (boolean) --
    Whether facet information can be returned for the field.
  - SearchEnabled (boolean) --
    Whether the contents of the field are searchable.
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.
  - SortEnabled (boolean) --
    Whether the field can be used to sort the search results.
- LiteralOptions (dict) --
  Options for literal field. Present if IndexFieldType specifies the field is of type literal . All options are enabled by default.
  - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
  - SourceField (string) --
    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 .
  - FacetEnabled (boolean) --
    Whether facet information can be returned for the field.
  - SearchEnabled (boolean) --
    Whether the contents of the field are searchable.
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.
  - SortEnabled (boolean) --
    Whether the field can be used to sort the search results.
- TextOptions (dict) --
  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.
  - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
  - SourceField (string) --
    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 .
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.
  - SortEnabled (boolean) --
    Whether the field can be used to sort the search results.
  - HighlightEnabled (boolean) --
    Whether highlights can be returned for the field.
  - AnalysisScheme (string) --
    The name of an analysis scheme for a text field.
- DateOptions (dict) --
  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.
  - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
  - SourceField (string) --
    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 .
  - FacetEnabled (boolean) --
    Whether facet information can be returned for the field.
  - SearchEnabled (boolean) --
    Whether the contents of the field are searchable.
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.
  - SortEnabled (boolean) --
    Whether the field can be used to sort the search results.
- LatLonOptions (dict) --
  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.
  - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
  - SourceField (string) --
    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 .
  - FacetEnabled (boolean) --
    Whether facet information can be returned for the field.
  - SearchEnabled (boolean) --
    Whether the contents of the field are searchable.
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.
  - SortEnabled (boolean) --
    Whether the field can be used to sort the search results.
- IntArrayOptions (dict) --
  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.
  - DefaultValue (integer) -- A value to use for the field if the field isn't specified for a document.
  - SourceFields (string) --
    A list of source fields to map to the field.
  - FacetEnabled (boolean) --
    Whether facet information can be returned for the field.
  - SearchEnabled (boolean) --
    Whether the contents of the field are searchable.
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.
- DoubleArrayOptions (dict) --
  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.
  - DefaultValue (float) -- A value to use for the field if the field isn't specified for a document.
  - SourceFields (string) --
    A list of source fields to map to the field.
  - FacetEnabled (boolean) --
    Whether facet information can be returned for the field.
  - SearchEnabled (boolean) --
    Whether the contents of the field are searchable.
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.
- LiteralArrayOptions (dict) --
  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.
  - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
  - SourceFields (string) --
    A list of source fields to map to the field.
  - FacetEnabled (boolean) --
    Whether facet information can be returned for the field.
  - SearchEnabled (boolean) --
    Whether the contents of the field are searchable.
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.
- TextArrayOptions (dict) --
  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.
  - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
  - SourceFields (string) --
    A list of source fields to map to the field.
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.
  - HighlightEnabled (boolean) --
    Whether highlights can be returned for the field.
  - AnalysisScheme (string) --
    The name of an analysis scheme for a text-array field.
- DateArrayOptions (dict) --
  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.
  - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
  - SourceFields (string) --
    A list of source fields to map to the field.
  - FacetEnabled (boolean) --
    Whether facet information can be returned for the field.
  - SearchEnabled (boolean) --
    Whether the contents of the field are searchable.
  - ReturnEnabled (boolean) --
    Whether the contents of the field can be returned in the search results.

Return type

dict

Returns

Response Syntax

{
    'IndexField': {
        'Options': {
            'IndexFieldName': 'string',
            'IndexFieldType': 'int'|'double'|'literal'|'text'|'date'|'latlon'|'int-array'|'double-array'|'literal-array'|'text-array'|'date-array',
            'IntOptions': {
                'DefaultValue': 123,
                'SourceField': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False,
                'SortEnabled': True|False
            },
            'DoubleOptions': {
                'DefaultValue': 123.0,
                'SourceField': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False,
                'SortEnabled': True|False
            },
            'LiteralOptions': {
                'DefaultValue': 'string',
                'SourceField': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False,
                'SortEnabled': True|False
            },
            'TextOptions': {
                'DefaultValue': 'string',
                'SourceField': 'string',
                'ReturnEnabled': True|False,
                'SortEnabled': True|False,
                'HighlightEnabled': True|False,
                'AnalysisScheme': 'string'
            },
            'DateOptions': {
                'DefaultValue': 'string',
                'SourceField': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False,
                'SortEnabled': True|False
            },
            'LatLonOptions': {
                'DefaultValue': 'string',
                'SourceField': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False,
                'SortEnabled': True|False
            },
            'IntArrayOptions': {
                'DefaultValue': 123,
                'SourceFields': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False
            },
            'DoubleArrayOptions': {
                'DefaultValue': 123.0,
                'SourceFields': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False
            },
            'LiteralArrayOptions': {
                'DefaultValue': 'string',
                'SourceFields': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False
            },
            'TextArrayOptions': {
                'DefaultValue': 'string',
                'SourceFields': 'string',
                'ReturnEnabled': True|False,
                'HighlightEnabled': True|False,
                'AnalysisScheme': 'string'
            },
            'DateArrayOptions': {
                'DefaultValue': 'string',
                'SourceFields': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False
            }
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a `` DefineIndexField`` request. Contains the status of the newly-configured index field.
- IndexField (dict) --
  
  The value of an IndexField and its current status.
  - Options (dict) --
    
    Configuration information for a field in the index, including its name, type, and options. The supported options depend on the `` IndexFieldType`` .
    - IndexFieldName (string) --
      
      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 .
    - IndexFieldType (string) --
      
      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 .
    - IntOptions (dict) --
      
      Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int . All options are enabled by default.
      - DefaultValue (integer) -- 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.
      - SourceField (string) --
        
        The name of the source field to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
    - DoubleOptions (dict) --
      
      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.
      - DefaultValue (float) --
        
        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.
      - SourceField (string) --
        
        The name of the source field to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
    - LiteralOptions (dict) --
      
      Options for literal field. Present if IndexFieldType specifies the field is of type literal . All options are enabled by default.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceField (string) --
        
        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 .
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
    - TextOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceField (string) --
        
        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 .
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
      - HighlightEnabled (boolean) --
        
        Whether highlights can be returned for the field.
      - AnalysisScheme (string) --
        
        The name of an analysis scheme for a text field.
    - DateOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceField (string) --
        
        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 .
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
    - LatLonOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceField (string) --
        
        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 .
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
    - IntArrayOptions (dict) --
      
      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.
      - DefaultValue (integer) -- A value to use for the field if the field isn't specified for a document.
      - SourceFields (string) --
        
        A list of source fields to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
    - DoubleArrayOptions (dict) --
      
      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.
      - DefaultValue (float) -- A value to use for the field if the field isn't specified for a document.
      - SourceFields (string) --
        
        A list of source fields to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
    - LiteralArrayOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceFields (string) --
        
        A list of source fields to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
    - TextArrayOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceFields (string) --
        
        A list of source fields to map to the field.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - HighlightEnabled (boolean) --
        
        Whether highlights can be returned for the field.
      - AnalysisScheme (string) --
        
        The name of an analysis scheme for a text-array field.
    - DateArrayOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceFields (string) --
        
        A list of source fields to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

define_suggester(**kwargs)¶

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.define_suggester(
    DomainName='string',
    Suggester={
        'SuggesterName': 'string',
        'DocumentSuggesterOptions': {
            'SourceField': 'string',
            'FuzzyMatching': 'none'|'low'|'high',
            'SortExpression': 'string'
        }
    }
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Suggester (dict) --
[REQUIRED]

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: FuzzyMatching , SortExpression .
- SuggesterName (string) -- [REQUIRED]
  Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
- DocumentSuggesterOptions (dict) -- [REQUIRED]
  Options for a search suggester.
  - SourceField (string) -- [REQUIRED]
    The name of the index field you want to use for suggestions.
  - FuzzyMatching (string) --
    The level of fuzziness allowed when suggesting matches for a string: none , low , or high . With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.
  - SortExpression (string) --
    An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Return type

dict

Returns

Response Syntax

{
    'Suggester': {
        'Options': {
            'SuggesterName': 'string',
            'DocumentSuggesterOptions': {
                'SourceField': 'string',
                'FuzzyMatching': 'none'|'low'|'high',
                'SortExpression': 'string'
            }
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.
- Suggester (dict) --
  
  The value of a Suggester and its current status.
  - Options (dict) --
    
    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: FuzzyMatching , SortExpression .
    - SuggesterName (string) --
      
      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
    - DocumentSuggesterOptions (dict) --
      
      Options for a search suggester.
      - SourceField (string) --
        
        The name of the index field you want to use for suggestions.
      - FuzzyMatching (string) --
        
        The level of fuzziness allowed when suggesting matches for a string: none , low , or high . With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.
      - SortExpression (string) --
        
        An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

delete_analysis_scheme(**kwargs)¶

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_analysis_scheme(
    DomainName='string',
    AnalysisSchemeName='string'
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
AnalysisSchemeName (string) --
[REQUIRED]

The name of the analysis scheme you want to delete.

Return type

dict

Returns

Response Syntax

{
    'AnalysisScheme': {
        'Options': {
            'AnalysisSchemeName': 'string',
            'AnalysisSchemeLanguage': 'ar'|'bg'|'ca'|'cs'|'da'|'de'|'el'|'en'|'es'|'eu'|'fa'|'fi'|'fr'|'ga'|'gl'|'he'|'hi'|'hu'|'hy'|'id'|'it'|'ja'|'ko'|'lv'|'mul'|'nl'|'no'|'pt'|'ro'|'ru'|'sv'|'th'|'tr'|'zh-Hans'|'zh-Hant',
            'AnalysisOptions': {
                'Synonyms': 'string',
                'Stopwords': 'string',
                'StemmingDictionary': 'string',
                'JapaneseTokenizationDictionary': 'string',
                'AlgorithmicStemming': 'none'|'minimal'|'light'|'full'
            }
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.
- AnalysisScheme (dict) --
  
  The status of the analysis scheme being deleted.
  - Options (dict) --
    
    Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms , Stopwords , StemmingDictionary , JapaneseTokenizationDictionary and AlgorithmicStemming .
    - AnalysisSchemeName (string) --
      
      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
    - AnalysisSchemeLanguage (string) --
      
      An IETF RFC 4646 language code or mul for multiple languages.
    - AnalysisOptions (dict) --
      
      Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
      - Synonyms (string) --
        
        A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide .
      - Stopwords (string) --
        
        A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"] . The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
      - StemmingDictionary (string) --
        
        A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"} . The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
      - JapaneseTokenizationDictionary (string) --
        
        A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
      - AlgorithmicStemming (string) --
        
        The level of algorithmic stemming to perform: none , minimal , light , or full . The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

delete_domain(**kwargs)¶

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_domain(
    DomainName='string'
)

Parameters

DomainName (string) --

[REQUIRED]

The name of the domain you want to permanently delete.

Return type

dict

Returns

Response Syntax

{
    'DomainStatus': {
        'DomainId': 'string',
        'DomainName': 'string',
        'ARN': 'string',
        'Created': True|False,
        'Deleted': True|False,
        'DocService': {
            'Endpoint': 'string'
        },
        'SearchService': {
            'Endpoint': 'string'
        },
        'RequiresIndexDocuments': True|False,
        'Processing': True|False,
        'SearchInstanceType': 'string',
        'SearchPartitionCount': 123,
        'SearchInstanceCount': 123,
        'Limits': {
            'MaximumReplicationCount': 123,
            'MaximumPartitionCount': 123
        }
    }
}

Response Structure

(dict) --
The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.
- DomainStatus (dict) --
  The current status of the search domain.
  - DomainId (string) --
    An internally generated unique identifier for a domain.
  - DomainName (string) --
    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  - ARN (string) --
    The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
  - Created (boolean) --
    True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
  - Deleted (boolean) --
    True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
  - DocService (dict) --
    The service endpoint for updating documents in a search domain.
    - Endpoint (string) --
      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 .
  - SearchService (dict) --
    The service endpoint for requesting search results from a search domain.
    - Endpoint (string) --
      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 .
  - RequiresIndexDocuments (boolean) --
    True if IndexDocuments needs to be called to activate the current domain configuration.
  - Processing (boolean) --
    True if processing is being done to activate the current domain configuration.
  - SearchInstanceType (string) --
    The instance type that is being used to process search requests.
  - SearchPartitionCount (integer) --
    The number of partitions across which the search index is spread.
  - SearchInstanceCount (integer) --
    The number of search instances that are available to process search requests.
  - Limits (dict) --
    - MaximumReplicationCount (integer) --
    - MaximumPartitionCount (integer) --

delete_expression(**kwargs)¶

Removes an `` Expression`` from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_expression(
    DomainName='string',
    ExpressionName='string'
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
ExpressionName (string) --
[REQUIRED]

The name of the `` Expression`` to delete.

Return type

dict

Returns

Response Syntax

{
    'Expression': {
        'Options': {
            'ExpressionName': 'string',
            'ExpressionValue': 'string'
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a `` DeleteExpression`` request. Specifies the expression being deleted.
- Expression (dict) --
  
  The status of the expression being deleted.
  - Options (dict) --
    
    The expression that is evaluated for sorting while processing a search request.
    - ExpressionName (string) --
      
      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
    - ExpressionValue (string) --
      
      The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

delete_index_field(**kwargs)¶

Removes an `` IndexField`` from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_index_field(
    DomainName='string',
    IndexFieldName='string'
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
IndexFieldName (string) --
[REQUIRED]

The name of the index field your want to remove from the domain's indexing options.

Return type

dict

Returns

Response Syntax

{
    'IndexField': {
        'Options': {
            'IndexFieldName': 'string',
            'IndexFieldType': 'int'|'double'|'literal'|'text'|'date'|'latlon'|'int-array'|'double-array'|'literal-array'|'text-array'|'date-array',
            'IntOptions': {
                'DefaultValue': 123,
                'SourceField': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False,
                'SortEnabled': True|False
            },
            'DoubleOptions': {
                'DefaultValue': 123.0,
                'SourceField': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False,
                'SortEnabled': True|False
            },
            'LiteralOptions': {
                'DefaultValue': 'string',
                'SourceField': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False,
                'SortEnabled': True|False
            },
            'TextOptions': {
                'DefaultValue': 'string',
                'SourceField': 'string',
                'ReturnEnabled': True|False,
                'SortEnabled': True|False,
                'HighlightEnabled': True|False,
                'AnalysisScheme': 'string'
            },
            'DateOptions': {
                'DefaultValue': 'string',
                'SourceField': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False,
                'SortEnabled': True|False
            },
            'LatLonOptions': {
                'DefaultValue': 'string',
                'SourceField': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False,
                'SortEnabled': True|False
            },
            'IntArrayOptions': {
                'DefaultValue': 123,
                'SourceFields': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False
            },
            'DoubleArrayOptions': {
                'DefaultValue': 123.0,
                'SourceFields': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False
            },
            'LiteralArrayOptions': {
                'DefaultValue': 'string',
                'SourceFields': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False
            },
            'TextArrayOptions': {
                'DefaultValue': 'string',
                'SourceFields': 'string',
                'ReturnEnabled': True|False,
                'HighlightEnabled': True|False,
                'AnalysisScheme': 'string'
            },
            'DateArrayOptions': {
                'DefaultValue': 'string',
                'SourceFields': 'string',
                'FacetEnabled': True|False,
                'SearchEnabled': True|False,
                'ReturnEnabled': True|False
            }
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a `` DeleteIndexField`` request.
- IndexField (dict) --
  
  The status of the index field being deleted.
  - Options (dict) --
    
    Configuration information for a field in the index, including its name, type, and options. The supported options depend on the `` IndexFieldType`` .
    - IndexFieldName (string) --
      
      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 .
    - IndexFieldType (string) --
      
      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 .
    - IntOptions (dict) --
      
      Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int . All options are enabled by default.
      - DefaultValue (integer) -- 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.
      - SourceField (string) --
        
        The name of the source field to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
    - DoubleOptions (dict) --
      
      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.
      - DefaultValue (float) --
        
        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.
      - SourceField (string) --
        
        The name of the source field to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
    - LiteralOptions (dict) --
      
      Options for literal field. Present if IndexFieldType specifies the field is of type literal . All options are enabled by default.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceField (string) --
        
        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 .
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
    - TextOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceField (string) --
        
        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 .
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
      - HighlightEnabled (boolean) --
        
        Whether highlights can be returned for the field.
      - AnalysisScheme (string) --
        
        The name of an analysis scheme for a text field.
    - DateOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceField (string) --
        
        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 .
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
    - LatLonOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceField (string) --
        
        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 .
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
    - IntArrayOptions (dict) --
      
      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.
      - DefaultValue (integer) -- A value to use for the field if the field isn't specified for a document.
      - SourceFields (string) --
        
        A list of source fields to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
    - DoubleArrayOptions (dict) --
      
      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.
      - DefaultValue (float) -- A value to use for the field if the field isn't specified for a document.
      - SourceFields (string) --
        
        A list of source fields to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
    - LiteralArrayOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceFields (string) --
        
        A list of source fields to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
    - TextArrayOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceFields (string) --
        
        A list of source fields to map to the field.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - HighlightEnabled (boolean) --
        
        Whether highlights can be returned for the field.
      - AnalysisScheme (string) --
        
        The name of an analysis scheme for a text-array field.
    - DateArrayOptions (dict) --
      
      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.
      - DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
      - SourceFields (string) --
        
        A list of source fields to map to the field.
      - FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
      - SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
      - ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

delete_suggester(**kwargs)¶

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_suggester(
    DomainName='string',
    SuggesterName='string'
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
SuggesterName (string) --
[REQUIRED]

Specifies the name of the suggester you want to delete.

Return type

dict

Returns

Response Syntax

{
    'Suggester': {
        'Options': {
            'SuggesterName': 'string',
            'DocumentSuggesterOptions': {
                'SourceField': 'string',
                'FuzzyMatching': 'none'|'low'|'high',
                'SortExpression': 'string'
            }
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a DeleteSuggester request. Contains the status of the deleted suggester.
- Suggester (dict) --
  
  The status of the suggester being deleted.
  - Options (dict) --
    
    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: FuzzyMatching , SortExpression .
    - SuggesterName (string) --
      
      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
    - DocumentSuggesterOptions (dict) --
      
      Options for a search suggester.
      - SourceField (string) --
        
        The name of the index field you want to use for suggestions.
      - FuzzyMatching (string) --
        
        The level of fuzziness allowed when suggesting matches for a string: none , low , or high . With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.
      - SortExpression (string) --
        
        An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

describe_analysis_schemes(**kwargs)¶

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_analysis_schemes(
    DomainName='string',
    AnalysisSchemeNames=[
        'string',
    ],
    Deployed=True|False
)

Parameters

DomainName (string) --
[REQUIRED]

The name of the domain you want to describe.
AnalysisSchemeNames (list) --
The analysis schemes you want to describe.
- (string) --
  Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
Deployed (boolean) -- Whether to display the deployed configuration (true ) or include any pending changes (false ). Defaults to false .

Return type

dict

Returns

Response Syntax

{
    'AnalysisSchemes': [
        {
            'Options': {
                'AnalysisSchemeName': 'string',
                'AnalysisSchemeLanguage': 'ar'|'bg'|'ca'|'cs'|'da'|'de'|'el'|'en'|'es'|'eu'|'fa'|'fi'|'fr'|'ga'|'gl'|'he'|'hi'|'hu'|'hy'|'id'|'it'|'ja'|'ko'|'lv'|'mul'|'nl'|'no'|'pt'|'ro'|'ru'|'sv'|'th'|'tr'|'zh-Hans'|'zh-Hant',
                'AnalysisOptions': {
                    'Synonyms': 'string',
                    'Stopwords': 'string',
                    'StemmingDictionary': 'string',
                    'JapaneseTokenizationDictionary': 'string',
                    'AlgorithmicStemming': 'none'|'minimal'|'light'|'full'
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
                'PendingDeletion': True|False
            }
        },
    ]
}

Response Structure

(dict) --

The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.
- AnalysisSchemes (list) --
  
  The analysis scheme descriptions.
  - (dict) --
    
    The status and configuration of an AnalysisScheme .
    - Options (dict) --
      
      Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms , Stopwords , StemmingDictionary , JapaneseTokenizationDictionary and AlgorithmicStemming .
      - AnalysisSchemeName (string) --
        
        Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
      - AnalysisSchemeLanguage (string) --
        
        An IETF RFC 4646 language code or mul for multiple languages.
      - AnalysisOptions (dict) --
        
        Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
        
        Synonyms (string) --
        
        A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide .
        
        Stopwords (string) --
        
        A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"] . The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
        
        StemmingDictionary (string) --
        
        A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"} . The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
        
        JapaneseTokenizationDictionary (string) --
        
        A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
        
        AlgorithmicStemming (string) --
        
        The level of algorithmic stemming to perform: none , minimal , light , or full . The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
    - Status (dict) --
      
      The status of domain configuration option.
      - CreationDate (datetime) --
        
        A timestamp for when this option was created.
      - UpdateDate (datetime) --
        
        A timestamp for when this option was last updated.
      - UpdateVersion (integer) --
        
        A unique integer that indicates when this option was last updated.
      - State (string) --
        
        The state of processing a change to an option. Possible values:
        
        RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
        
        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.
      - PendingDeletion (boolean) --
        
        Indicates that the option will be deleted once processing is complete.

describe_availability_options(**kwargs)¶

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_availability_options(
    DomainName='string',
    Deployed=True|False
)

Parameters

DomainName (string) --
[REQUIRED]

The name of the domain you want to describe.
Deployed (boolean) -- Whether to display the deployed configuration (true ) or include any pending changes (false ). Defaults to false .

Return type

dict

Returns

Response Syntax

{
    'AvailabilityOptions': {
        'Options': True|False,
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.
- AvailabilityOptions (dict) --
  
  The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
  - Options (boolean) --
    
    The availability options configured for the domain.
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

describe_domains(**kwargs)¶

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0 . For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_domains(
    DomainNames=[
        'string',
    ]
)

Parameters

DomainNames (list) --

The names of the domains you want to include in the response.

(string) --
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Return type

dict

Returns

Response Syntax

{
    'DomainStatusList': [
        {
            'DomainId': 'string',
            'DomainName': 'string',
            'ARN': 'string',
            'Created': True|False,
            'Deleted': True|False,
            'DocService': {
                'Endpoint': 'string'
            },
            'SearchService': {
                'Endpoint': 'string'
            },
            'RequiresIndexDocuments': True|False,
            'Processing': True|False,
            'SearchInstanceType': 'string',
            'SearchPartitionCount': 123,
            'SearchInstanceCount': 123,
            'Limits': {
                'MaximumReplicationCount': 123,
                'MaximumPartitionCount': 123
            }
        },
    ]
}

Response Structure

(dict) --
The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.
- DomainStatusList (list) --
  A list that contains the status of each requested domain.
  - (dict) --
    The current status of the search domain.
    - DomainId (string) --
      An internally generated unique identifier for a domain.
    - DomainName (string) --
      A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    - ARN (string) --
      The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
    - Created (boolean) --
      True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
    - Deleted (boolean) --
      True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
    - DocService (dict) --
      The service endpoint for updating documents in a search domain.
      - Endpoint (string) --
        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 .
    - SearchService (dict) --
      The service endpoint for requesting search results from a search domain.
      - Endpoint (string) --
        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 .
    - RequiresIndexDocuments (boolean) --
      True if IndexDocuments needs to be called to activate the current domain configuration.
    - Processing (boolean) --
      True if processing is being done to activate the current domain configuration.
    - SearchInstanceType (string) --
      The instance type that is being used to process search requests.
    - SearchPartitionCount (integer) --
      The number of partitions across which the search index is spread.
    - SearchInstanceCount (integer) --
      The number of search instances that are available to process search requests.
    - Limits (dict) --
      - MaximumReplicationCount (integer) --
      - MaximumPartitionCount (integer) --

describe_expressions(**kwargs)¶

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_expressions(
    DomainName='string',
    ExpressionNames=[
        'string',
    ],
    Deployed=True|False
)

Parameters

DomainName (string) --
[REQUIRED]

The name of the domain you want to describe.
ExpressionNames (list) --
Limits the `` DescribeExpressions`` response to the specified expressions. If not specified, all expressions are shown.
- (string) --
  Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
Deployed (boolean) -- Whether to display the deployed configuration (true ) or include any pending changes (false ). Defaults to false .

Return type

dict

Returns

Response Syntax

{
    'Expressions': [
        {
            'Options': {
                'ExpressionName': 'string',
                'ExpressionValue': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
                'PendingDeletion': True|False
            }
        },
    ]
}

Response Structure

(dict) --

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.
- Expressions (list) --
  
  The expressions configured for the domain.
  - (dict) --
    
    The value of an Expression and its current status.
    - Options (dict) --
      
      The expression that is evaluated for sorting while processing a search request.
      - ExpressionName (string) --
        
        Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
      - ExpressionValue (string) --
        
        The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .
    - Status (dict) --
      
      The status of domain configuration option.
      - CreationDate (datetime) --
        
        A timestamp for when this option was created.
      - UpdateDate (datetime) --
        
        A timestamp for when this option was last updated.
      - UpdateVersion (integer) --
        
        A unique integer that indicates when this option was last updated.
      - State (string) --
        
        The state of processing a change to an option. Possible values:
        
        RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
        
        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.
      - PendingDeletion (boolean) --
        
        Indicates that the option will be deleted once processing is complete.

describe_index_fields(**kwargs)¶

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_index_fields(
    DomainName='string',
    FieldNames=[
        'string',
    ],
    Deployed=True|False
)

Parameters

DomainName (string) --
[REQUIRED]

The name of the domain you want to describe.
FieldNames (list) --
A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
- (string) --
Deployed (boolean) -- Whether to display the deployed configuration (true ) or include any pending changes (false ). Defaults to false .

Return type

dict

Returns

Response Syntax

{
    'IndexFields': [
        {
            'Options': {
                'IndexFieldName': 'string',
                'IndexFieldType': 'int'|'double'|'literal'|'text'|'date'|'latlon'|'int-array'|'double-array'|'literal-array'|'text-array'|'date-array',
                'IntOptions': {
                    'DefaultValue': 123,
                    'SourceField': 'string',
                    'FacetEnabled': True|False,
                    'SearchEnabled': True|False,
                    'ReturnEnabled': True|False,
                    'SortEnabled': True|False
                },
                'DoubleOptions': {
                    'DefaultValue': 123.0,
                    'SourceField': 'string',
                    'FacetEnabled': True|False,
                    'SearchEnabled': True|False,
                    'ReturnEnabled': True|False,
                    'SortEnabled': True|False
                },
                'LiteralOptions': {
                    'DefaultValue': 'string',
                    'SourceField': 'string',
                    'FacetEnabled': True|False,
                    'SearchEnabled': True|False,
                    'ReturnEnabled': True|False,
                    'SortEnabled': True|False
                },
                'TextOptions': {
                    'DefaultValue': 'string',
                    'SourceField': 'string',
                    'ReturnEnabled': True|False,
                    'SortEnabled': True|False,
                    'HighlightEnabled': True|False,
                    'AnalysisScheme': 'string'
                },
                'DateOptions': {
                    'DefaultValue': 'string',
                    'SourceField': 'string',
                    'FacetEnabled': True|False,
                    'SearchEnabled': True|False,
                    'ReturnEnabled': True|False,
                    'SortEnabled': True|False
                },
                'LatLonOptions': {
                    'DefaultValue': 'string',
                    'SourceField': 'string',
                    'FacetEnabled': True|False,
                    'SearchEnabled': True|False,
                    'ReturnEnabled': True|False,
                    'SortEnabled': True|False
                },
                'IntArrayOptions': {
                    'DefaultValue': 123,
                    'SourceFields': 'string',
                    'FacetEnabled': True|False,
                    'SearchEnabled': True|False,
                    'ReturnEnabled': True|False
                },
                'DoubleArrayOptions': {
                    'DefaultValue': 123.0,
                    'SourceFields': 'string',
                    'FacetEnabled': True|False,
                    'SearchEnabled': True|False,
                    'ReturnEnabled': True|False
                },
                'LiteralArrayOptions': {
                    'DefaultValue': 'string',
                    'SourceFields': 'string',
                    'FacetEnabled': True|False,
                    'SearchEnabled': True|False,
                    'ReturnEnabled': True|False
                },
                'TextArrayOptions': {
                    'DefaultValue': 'string',
                    'SourceFields': 'string',
                    'ReturnEnabled': True|False,
                    'HighlightEnabled': True|False,
                    'AnalysisScheme': 'string'
                },
                'DateArrayOptions': {
                    'DefaultValue': 'string',
                    'SourceFields': 'string',
                    'FacetEnabled': True|False,
                    'SearchEnabled': True|False,
                    'ReturnEnabled': True|False
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
                'PendingDeletion': True|False
            }
        },
    ]
}

Response Structure

(dict) --

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.
- IndexFields (list) --
  
  The index fields configured for the domain.
  - (dict) --
    
    The value of an IndexField and its current status.
    - Options (dict) --
      
      Configuration information for a field in the index, including its name, type, and options. The supported options depend on the `` IndexFieldType`` .
      - IndexFieldName (string) --
        
        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 .
      - IndexFieldType (string) --
        
        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 .
      - IntOptions (dict) --
        
        Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int . All options are enabled by default.
        
        DefaultValue (integer) -- 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.
        
        SourceField (string) --
        
        The name of the source field to map to the field.
        
        FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
        
        SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
        
        SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
      - DoubleOptions (dict) --
        
        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.
        
        DefaultValue (float) --
        
        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.
        
        SourceField (string) --
        
        The name of the source field to map to the field.
        
        FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
        
        SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
        
        SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
      - LiteralOptions (dict) --
        
        Options for literal field. Present if IndexFieldType specifies the field is of type literal . All options are enabled by default.
        
        DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
        
        SourceField (string) --
        
        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 .
        
        FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
        
        SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
        
        SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
      - TextOptions (dict) --
        
        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.
        
        DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
        
        SourceField (string) --
        
        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 .
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
        
        SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
        
        HighlightEnabled (boolean) --
        
        Whether highlights can be returned for the field.
        
        AnalysisScheme (string) --
        
        The name of an analysis scheme for a text field.
      - DateOptions (dict) --
        
        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.
        
        DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
        
        SourceField (string) --
        
        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 .
        
        FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
        
        SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
        
        SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
      - LatLonOptions (dict) --
        
        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.
        
        DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
        
        SourceField (string) --
        
        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 .
        
        FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
        
        SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
        
        SortEnabled (boolean) --
        
        Whether the field can be used to sort the search results.
      - IntArrayOptions (dict) --
        
        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.
        
        DefaultValue (integer) -- A value to use for the field if the field isn't specified for a document.
        
        SourceFields (string) --
        
        A list of source fields to map to the field.
        
        FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
        
        SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - DoubleArrayOptions (dict) --
        
        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.
        
        DefaultValue (float) -- A value to use for the field if the field isn't specified for a document.
        
        SourceFields (string) --
        
        A list of source fields to map to the field.
        
        FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
        
        SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - LiteralArrayOptions (dict) --
        
        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.
        
        DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
        
        SourceFields (string) --
        
        A list of source fields to map to the field.
        
        FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
        
        SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
      - TextArrayOptions (dict) --
        
        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.
        
        DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
        
        SourceFields (string) --
        
        A list of source fields to map to the field.
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
        
        HighlightEnabled (boolean) --
        
        Whether highlights can be returned for the field.
        
        AnalysisScheme (string) --
        
        The name of an analysis scheme for a text-array field.
      - DateArrayOptions (dict) --
        
        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.
        
        DefaultValue (string) -- A value to use for the field if the field isn't specified for a document.
        
        SourceFields (string) --
        
        A list of source fields to map to the field.
        
        FacetEnabled (boolean) --
        
        Whether facet information can be returned for the field.
        
        SearchEnabled (boolean) --
        
        Whether the contents of the field are searchable.
        
        ReturnEnabled (boolean) --
        
        Whether the contents of the field can be returned in the search results.
    - Status (dict) --
      
      The status of domain configuration option.
      - CreationDate (datetime) --
        
        A timestamp for when this option was created.
      - UpdateDate (datetime) --
        
        A timestamp for when this option was last updated.
      - UpdateVersion (integer) --
        
        A unique integer that indicates when this option was last updated.
      - State (string) --
        
        The state of processing a change to an option. Possible values:
        
        RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
        
        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.
      - PendingDeletion (boolean) --
        
        Indicates that the option will be deleted once processing is complete.

describe_scaling_parameters(**kwargs)¶

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_scaling_parameters(
    DomainName='string'
)

Parameters

DomainName (string) --

[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Return type

dict

Returns

Response Syntax

{
    'ScalingParameters': {
        'Options': {
            'DesiredInstanceType': 'search.m1.small'|'search.m1.large'|'search.m2.xlarge'|'search.m2.2xlarge'|'search.m3.medium'|'search.m3.large'|'search.m3.xlarge'|'search.m3.2xlarge',
            'DesiredReplicationCount': 123,
            'DesiredPartitionCount': 123
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --
The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.
- ScalingParameters (dict) --
  The status and configuration of a search domain's scaling parameters.
  - Options (dict) --
    The desired instance type and desired number of replicas of each index partition.
    - DesiredInstanceType (string) --
      The instance type that you want to preconfigure for your domain. For example, search.m1.small .
    - DesiredReplicationCount (integer) --
      The number of replicas you want to preconfigure for each index partition.
    - DesiredPartitionCount (integer) --
      The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.
  - Status (dict) --
    The status of domain configuration option.
    - CreationDate (datetime) --
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      A unique integer that indicates when this option was last updated.
    - State (string) --
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      Indicates that the option will be deleted once processing is complete.

describe_service_access_policies(**kwargs)¶

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_service_access_policies(
    DomainName='string',
    Deployed=True|False
)

Parameters

DomainName (string) --
[REQUIRED]

The name of the domain you want to describe.
Deployed (boolean) -- Whether to display the deployed configuration (true ) or include any pending changes (false ). Defaults to false .

Return type

dict

Returns

Response Syntax

{
    'AccessPolicies': {
        'Options': 'string',
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a DescribeServiceAccessPolicies request.
- AccessPolicies (dict) --
  
  The access rules configured for the domain specified in the request.
  - Options (string) --
    
    Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide . The maximum size of a policy document is 100 KB.
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

describe_suggesters(**kwargs)¶

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_suggesters(
    DomainName='string',
    SuggesterNames=[
        'string',
    ],
    Deployed=True|False
)

Parameters

DomainName (string) --
[REQUIRED]

The name of the domain you want to describe.
SuggesterNames (list) --
The suggesters you want to describe.
- (string) --
  Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
Deployed (boolean) -- Whether to display the deployed configuration (true ) or include any pending changes (false ). Defaults to false .

Return type

dict

Returns

Response Syntax

{
    'Suggesters': [
        {
            'Options': {
                'SuggesterName': 'string',
                'DocumentSuggesterOptions': {
                    'SourceField': 'string',
                    'FuzzyMatching': 'none'|'low'|'high',
                    'SortExpression': 'string'
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
                'PendingDeletion': True|False
            }
        },
    ]
}

Response Structure

(dict) --

The result of a DescribeSuggesters request.
- Suggesters (list) --
  
  The suggesters configured for the domain specified in the request.
  - (dict) --
    
    The value of a Suggester and its current status.
    - Options (dict) --
      
      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: FuzzyMatching , SortExpression .
      - SuggesterName (string) --
        
        Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
      - DocumentSuggesterOptions (dict) --
        
        Options for a search suggester.
        
        SourceField (string) --
        
        The name of the index field you want to use for suggestions.
        
        FuzzyMatching (string) --
        
        The level of fuzziness allowed when suggesting matches for a string: none , low , or high . With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.
        
        SortExpression (string) --
        
        An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.
    - Status (dict) --
      
      The status of domain configuration option.
      - CreationDate (datetime) --
        
        A timestamp for when this option was created.
      - UpdateDate (datetime) --
        
        A timestamp for when this option was last updated.
      - UpdateVersion (integer) --
        
        A unique integer that indicates when this option was last updated.
      - State (string) --
        
        The state of processing a change to an option. Possible values:
        
        RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
        
        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.
      - PendingDeletion (boolean) --
        
        Indicates that the option will be deleted once processing is complete.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters

ClientMethod (string) -- The client method to presign for
Params (dict) -- The parameters normally passed to ClientMethod.
ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

index_documents(**kwargs)¶

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments .

See also: AWS API Documentation

Request Syntax

response = client.index_documents(
    DomainName='string'
)

Parameters

DomainName (string) --

[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Return type

dict

Returns

Response Syntax

{
    'FieldNames': [
        'string',
    ]
}

Response Structure

(dict) --
The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.
- FieldNames (list) --
  The names of the fields that are currently being indexed.
  - (string) --
    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 .

list_domain_names()¶

Lists all search domains owned by an account.

See also: AWS API Documentation

Request Syntax

response = client.list_domain_names()

Return type

dict

Returns

Response Syntax

{
    'DomainNames': {
        'string': 'string'
    }
}

Response Structure

(dict) --
The result of a ListDomainNames request. Contains a list of the domains owned by an account.
- DomainNames (dict) --
  The names of the search domains owned by an account.
  - (string) --
    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    - (string) --
      The Amazon CloudSearch API version for a domain: 2011-02-01 or 2013-01-01.

update_availability_options(**kwargs)¶

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.update_availability_options(
    DomainName='string',
    MultiAZ=True|False
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
MultiAZ (boolean) --
[REQUIRED]

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false .

Return type

dict

Returns

Response Syntax

{
    'AvailabilityOptions': {
        'Options': True|False,
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.
- AvailabilityOptions (dict) --
  
  The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.
  - Options (boolean) --
    
    The availability options configured for the domain.
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

update_scaling_parameters(**kwargs)¶

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.update_scaling_parameters(
    DomainName='string',
    ScalingParameters={
        'DesiredInstanceType': 'search.m1.small'|'search.m1.large'|'search.m2.xlarge'|'search.m2.2xlarge'|'search.m3.medium'|'search.m3.large'|'search.m3.xlarge'|'search.m3.2xlarge',
        'DesiredReplicationCount': 123,
        'DesiredPartitionCount': 123
    }
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
ScalingParameters (dict) --
[REQUIRED]

The desired instance type and desired number of replicas of each index partition.
- DesiredInstanceType (string) --
  The instance type that you want to preconfigure for your domain. For example, search.m1.small .
- DesiredReplicationCount (integer) --
  The number of replicas you want to preconfigure for each index partition.
- DesiredPartitionCount (integer) --
  The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

Return type

dict

Returns

Response Syntax

{
    'ScalingParameters': {
        'Options': {
            'DesiredInstanceType': 'search.m1.small'|'search.m1.large'|'search.m2.xlarge'|'search.m2.2xlarge'|'search.m3.medium'|'search.m3.large'|'search.m3.xlarge'|'search.m3.2xlarge',
            'DesiredReplicationCount': 123,
            'DesiredPartitionCount': 123
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.
- ScalingParameters (dict) --
  
  The status and configuration of a search domain's scaling parameters.
  - Options (dict) --
    
    The desired instance type and desired number of replicas of each index partition.
    - DesiredInstanceType (string) --
      
      The instance type that you want to preconfigure for your domain. For example, search.m1.small .
    - DesiredReplicationCount (integer) --
      
      The number of replicas you want to preconfigure for each index partition.
    - DesiredPartitionCount (integer) --
      
      The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

update_service_access_policies(**kwargs)¶

Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain .

See also: AWS API Documentation

Request Syntax

response = client.update_service_access_policies(
    DomainName='string',
    AccessPolicies='string'
)

Parameters

DomainName (string) --
[REQUIRED]

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
AccessPolicies (string) --
[REQUIRED]

The access rules you want to configure. These rules replace any existing rules.

Return type

dict

Returns

Response Syntax

{
    'AccessPolicies': {
        'Options': 'string',
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

(dict) --

The result of an UpdateServiceAccessPolicies request. Contains the new access policies.
- AccessPolicies (dict) --
  
  The access rules configured for the domain.
  - Options (string) --
    
    Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide . The maximum size of a policy document is 100 KB.
  - Status (dict) --
    
    The status of domain configuration option.
    - CreationDate (datetime) --
      
      A timestamp for when this option was created.
    - UpdateDate (datetime) --
      
      A timestamp for when this option was last updated.
    - UpdateVersion (integer) --
      
      A unique integer that indicates when this option was last updated.
    - State (string) --
      
      The state of processing a change to an option. Possible values:
      - RequiresIndexDocuments : the option's latest value will not be deployed until IndexDocuments 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.
      - 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.
    - PendingDeletion (boolean) --
      
      Indicates that the option will be deleted once processing is complete.

Paginators ¶

The available paginators are:

Navigation

Table Of Contents

CloudSearch¶

Client¶

Paginators¶

Navigation

CloudSearch ¶

Client ¶

Paginators ¶