Table of Contents
CloudSearch.
Client
¶A low-level client representing Amazon CloudSearch:
import boto3
client = boto3.client('cloudsearch')
These are the available methods:
build_suggesters()
can_paginate()
create_domain()
define_analysis_scheme()
define_expression()
define_index_field()
define_suggester()
delete_analysis_scheme()
delete_domain()
delete_expression()
delete_index_field()
delete_suggester()
describe_analysis_schemes()
describe_availability_options()
describe_domains()
describe_expressions()
describe_index_fields()
describe_scaling_parameters()
describe_service_access_policies()
describe_suggesters()
generate_presigned_url()
get_paginator()
get_waiter()
index_documents()
list_domain_names()
update_availability_options()
update_scaling_parameters()
update_service_access_policies()
build_suggesters
(**kwargs)¶Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide .
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
|
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 .
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
|
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 .
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: |
|
---|---|
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
|
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 .
Request Syntax
response = client.define_expression(
DomainName='string',
Expression={
'ExpressionName': 'string',
'ExpressionValue': 'string'
}
)
Parameters: |
|
---|---|
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
|
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 .
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: |
|
---|---|
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
|
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 .
Request Syntax
response = client.define_suggester(
DomainName='string',
Suggester={
'SuggesterName': 'string',
'DocumentSuggesterOptions': {
'SourceField': 'string',
'FuzzyMatching': 'none'|'low'|'high',
'SortExpression': 'string'
}
}
)
Parameters: |
|
---|---|
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
|
delete_analysis_scheme
(**kwargs)¶Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .
Request Syntax
response = client.delete_analysis_scheme(
DomainName='string',
AnalysisSchemeName='string'
)
Parameters: |
|
---|---|
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
|
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 .
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
|
delete_expression
(**kwargs)¶Removes an `` Expression`` from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .
Request Syntax
response = client.delete_expression(
DomainName='string',
ExpressionName='string'
)
Parameters: |
|
---|---|
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
|
delete_index_field
(**kwargs)¶Removes an `` IndexField`` from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide .
Request Syntax
response = client.delete_index_field(
DomainName='string',
IndexFieldName='string'
)
Parameters: |
|
---|---|
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
|
delete_suggester
(**kwargs)¶Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide .
Request Syntax
response = client.delete_suggester(
DomainName='string',
SuggesterName='string'
)
Parameters: |
|
---|---|
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
|
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 .
Request Syntax
response = client.describe_analysis_schemes(
DomainName='string',
AnalysisSchemeNames=[
'string',
],
Deployed=True|False
)
Parameters: |
|
---|---|
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
|
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 .
Request Syntax
response = client.describe_availability_options(
DomainName='string',
Deployed=True|False
)
Parameters: |
|
---|---|
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
|
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=matchallamp;q.parser=structuredamp;size=0
. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide .
Request Syntax
response = client.describe_domains(
DomainNames=[
'string',
]
)
Parameters: | DomainNames (list) -- The names of the domains you want to include in the response.
|
---|---|
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
|
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 .
Request Syntax
response = client.describe_expressions(
DomainName='string',
ExpressionNames=[
'string',
],
Deployed=True|False
)
Parameters: |
|
---|---|
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
|
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 .
Request Syntax
response = client.describe_index_fields(
DomainName='string',
FieldNames=[
'string',
],
Deployed=True|False
)
Parameters: |
|
---|---|
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
|
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 .
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
|
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 .
Request Syntax
response = client.describe_service_access_policies(
DomainName='string',
Deployed=True|False
)
Parameters: |
|
---|---|
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
|
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 .
Request Syntax
response = client.describe_suggesters(
DomainName='string',
SuggesterNames=[
'string',
],
Deployed=True|False
)
Parameters: |
|
---|---|
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
|
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
Parameters: |
|
---|---|
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)¶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
.
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
|
list_domain_names
()¶Lists all search domains owned by an account.
Request Syntax
response = client.list_domain_names()
Return type: | dict |
---|---|
Returns: | Response Syntax{
'DomainNames': {
'string': 'string'
}
}
Response Structure
|
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 .
Request Syntax
response = client.update_availability_options(
DomainName='string',
MultiAZ=True|False
)
Parameters: |
|
---|---|
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
|
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 .
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: |
|
---|---|
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
|
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 .
Request Syntax
response = client.update_service_access_policies(
DomainName='string',
AccessPolicies='string'
)
Parameters: |
|
---|---|
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
|