|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/boto/cloudsearch2/__pycache__/ |
Upload File : |
o
ckF[5 � @ sX d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
G dd� de�Z dS ) � N)�json)�AWSQueryConnection)�
RegionInfo)�JSONResponseError)�
exceptionsc sB e Zd ZdZdZdZdZeZe j
e j e j e j
e je jd�Z� fdd�Zdd � Zd
d � Zd d
� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zd d � Z d d � Z d?d!d"�Z d@d#d$�Z d@d%d&�Z d?d'd(�Z! d?d)d*�Z"d+d,� Z#d@d-d.�Z$ d?d/d0�Z%d1d2� Z&d3d4� Z'd5d6� Z(d7d8� Z)d9d:� Z*d;d<� Z+d=d>� Z,� Z-S )A�CloudSearchConnectionaj
Amazon CloudSearch Configuration Service
You use the Amazon CloudSearch configuration service to create,
configure, and manage search domains. Configuration service
requests are submitted using the AWS Query protocol. AWS Query
requests are HTTP or HTTPS requests submitted via HTTP GET or POST
with a query parameter named Action.
The endpoint for configuration service requests is region-
specific: cloudsearch. region .amazonaws.com. For example,
cloudsearch.us-east-1.amazonaws.com. For a current list of
supported regions and endpoints, see `Regions and Endpoints`_.
z
2013-01-01z us-east-1z#cloudsearch.us-east-1.amazonaws.com)�InvalidTypeException�LimitExceededException�InternalException�DisabledOperationException�ResourceNotFoundException�
BaseExceptionc sp |� dd �}|st| | j| j�}d|vs|d d u r |j|d< |� dd�}|| _tt| �jdi |�� || _ d S )N�region�host� sign_requestF� )
�popr �DefaultRegionName�DefaultRegionEndpoint�endpointr �superr �__init__r )�self�kwargsr r �� __class__r �:/usr/lib/python3/dist-packages/boto/cloudsearch2/layer1.pyr ; s �
z CloudSearchConnection.__init__c C s dgS )Nzhmac-v4r )r r r r �_required_auth_capabilityJ s z/CloudSearchConnection._required_auth_capabilityc C � d|i}| j ddd|d�S )a�
Indexes the search suggestions.
:type domain_name: string
:param domain_name: 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).
�
DomainName�BuildSuggesters�POST�/��action�verb�path�params��
_make_request�r � domain_namer' r r r �build_suggestersM � �z&CloudSearchConnection.build_suggestersc C r )a�
Creates a new search domain. For more information, see
`Creating a Search Domain`_ in the Amazon CloudSearch
Developer Guide .
:type domain_name: string
:param domain_name: 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.
r � CreateDomainr! r" r# r( r* r r r �
create_domain_ s
�z#CloudSearchConnection.create_domainc C �( d|i}| � |d|� | jddd|d�S )a
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 .
:type domain_name: string
:param domain_name: 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).
:type analysis_scheme: dict
:param analysis_scheme: 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`, and `AlgorithmicStemming`.
r �AnalysisScheme�DefineAnalysisSchemer! r" r# ��build_complex_paramr) )r r+ �analysis_schemer' r r r �define_analysis_schemer s ��z,CloudSearchConnection.define_analysis_schemec C r0 )a�
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 .
:type domain_name: string
:param domain_name: 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).
:type expression: dict
:param expression: 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.
r �
Expression�DefineExpressionr! r" r# r3 )r r+ �
expressionr' r r r �define_expression� s ��z'CloudSearchConnection.define_expressionc C r0 )ao
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 .
:type domain_name: string
:param domain_name: 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).
:type index_field: dict
:param index_field: The index field and field options you want to
configure.
r �
IndexField�DefineIndexFieldr! r" r# r3 )r r+ � index_fieldr' r r r �define_index_field� s ��z(CloudSearchConnection.define_index_fieldc C r0 )az
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 .
:type domain_name: string
:param domain_name: 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).
:type suggester: dict
:param suggester: 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`.
r � Suggester�DefineSuggesterr! r" r# r3 )r r+ � suggesterr' r r r �define_suggester� � ��z&CloudSearchConnection.define_suggesterc C � ||d�}| j ddd|d�S )a�
Deletes an analysis scheme. For more information, see
`Configuring Analysis Schemes`_ in the Amazon CloudSearch
Developer Guide .
:type domain_name: string
:param domain_name: 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).
:type analysis_scheme_name: string
:param analysis_scheme_name: The name of the analysis scheme you want
to delete.
)r �AnalysisSchemeName�DeleteAnalysisSchemer! r" r# r( )r r+ �analysis_scheme_namer' r r r �delete_analysis_scheme� � ��z,CloudSearchConnection.delete_analysis_schemec C r )a
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 .
:type domain_name: string
:param domain_name: The name of the domain you want to permanently
delete.
r � DeleteDomainr! r" r# r( r* r r r �
delete_domain r- z#CloudSearchConnection.delete_domainc C rD )a�
Removes an `Expression` from the search domain. For more
information, see `Configuring Expressions`_ in the Amazon
CloudSearch Developer Guide .
:type domain_name: string
:param domain_name: 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).
:type expression_name: string
:param expression_name: The name of the `Expression` to delete.
)r �ExpressionName�DeleteExpressionr! r" r# r( )r r+ �expression_namer' r r r �delete_expression � ��z'CloudSearchConnection.delete_expressionc C rD )a�
Removes an `IndexField` from the search domain. For more
information, see `Configuring Index Fields`_ in the Amazon
CloudSearch Developer Guide .
:type domain_name: string
:param domain_name: 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).
:type index_field_name: string
:param index_field_name: The name of the index field your want to
remove from the domain's indexing options.
)r �IndexFieldName�DeleteIndexFieldr! r" r# r( )r r+ �index_field_namer' r r r �delete_index_field5 rI z(CloudSearchConnection.delete_index_fieldc C rD )a�
Deletes a suggester. For more information, see `Getting Search
Suggestions`_ in the Amazon CloudSearch Developer Guide .
:type domain_name: string
:param domain_name: 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).
:type suggester_name: string
:param suggester_name: Specifies the name of the suggester you want to
delete.
)r �
SuggesterName�DeleteSuggesterr! r" r# r( )r r+ �suggester_namer' r r r �delete_suggesterP rP z&CloudSearchConnection.delete_suggesterNc C �H d|i}|dur| � ||d� |durt|��� |d< | jddd|d�S ) a�
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 .
:type domain_name: string
:param domain_name: The name of the domain you want to describe.
:type analysis_scheme_names: list
:param analysis_scheme_names: The analysis schemes you want to
describe.
:type deployed: boolean
:param deployed: Whether to display the deployed configuration (
`True`) or include any pending changes ( `False`). Defaults to
`False`.
r NzAnalysisSchemeNames.member�Deployed�DescribeAnalysisSchemesr! r" r# ��build_list_params�str�lowerr) )r r+ �analysis_scheme_names�deployedr' r r r �describe_analysis_schemesj �" ����z/CloudSearchConnection.describe_analysis_schemesc C �2 d|i}|durt |��� |d< | jddd|d�S )a�
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 .
:type domain_name: string
:param domain_name: The name of the domain you want to describe.
:type deployed: boolean
:param deployed: Whether to display the deployed configuration (
`True`) or include any pending changes ( `False`). Defaults to
`False`.
r NrZ �DescribeAvailabilityOptionsr! r" r# �r^ r_ r) �r r+ ra r' r r r � describe_availability_options� s ���z3CloudSearchConnection.describe_availability_optionsc C s, i }|dur
| � ||d� | jddd|d�S )az
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 .
:type domain_names: list
:param domain_names: The names of the domains you want to include in
the response.
NzDomainNames.member�DescribeDomainsr! r" r# )r] r) )r � domain_namesr' r r r �describe_domains� s ��z&CloudSearchConnection.describe_domainsc C rY ) a�
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 .
:type domain_name: string
:param domain_name: The name of the domain you want to describe.
:type expression_names: list
:param expression_names: Limits the `DescribeExpressions` response to
the specified expressions. If not specified, all expressions are
shown.
:type deployed: boolean
:param deployed: Whether to display the deployed configuration (
`True`) or include any pending changes ( `False`). Defaults to
`False`.
r NzExpressionNames.memberrZ �DescribeExpressionsr! r" r# r\ )r r+ �expression_namesra r' r r r �describe_expressions� rc z*CloudSearchConnection.describe_expressionsc C rY ) a�
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 .
:type domain_name: string
:param domain_name: The name of the domain you want to describe.
:type field_names: list
:param field_names: A list of the index fields you want to describe. If
not specified, information is returned for all configured index
fields.
:type deployed: boolean
:param deployed: Whether to display the deployed configuration (
`True`) or include any pending changes ( `False`). Defaults to
`False`.
r NzFieldNames.memberrZ �DescribeIndexFieldsr! r" r# r\ )r r+ � field_namesra r' r r r �describe_index_fields� rc z+CloudSearchConnection.describe_index_fieldsc C r )a�
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 .
:type domain_name: string
:param domain_name: 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).
r �DescribeScalingParametersr! r" r# r( r* r r r �describe_scaling_parameters s �z1CloudSearchConnection.describe_scaling_parametersc C rd )a�
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 .
:type domain_name: string
:param domain_name: The name of the domain you want to describe.
:type deployed: boolean
:param deployed: Whether to display the deployed configuration (
`True`) or include any pending changes ( `False`). Defaults to
`False`.
r NrZ � DescribeServiceAccessPoliciesr! r" r# rf rg r r r � describe_service_access_policies' s ���z6CloudSearchConnection.describe_service_access_policiesc C rY ) a�
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 .
:type domain_name: string
:param domain_name: The name of the domain you want to describe.
:type suggester_names: list
:param suggester_names: The suggesters you want to describe.
:type deployed: boolean
:param deployed: Whether to display the deployed configuration (
`True`) or include any pending changes ( `False`). Defaults to
`False`.
r NzSuggesterNames.memberrZ �DescribeSuggestersr! r" r# r\ )r r+ �suggester_namesra r' r r r �describe_suggestersC s" ����z)CloudSearchConnection.describe_suggestersc C r )aV
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`.
:type domain_name: string
:param domain_name: 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).
r �IndexDocumentsr! r" r# r( r* r r r �index_documentsh s �z%CloudSearchConnection.index_documentsc C s i }| j ddd|d�S )z?
Lists all search domains owned by an account.
�ListDomainNamesr! r" r# r( )r r' r r r �list_domain_names} s �z'CloudSearchConnection.list_domain_namesc C rD )a�
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 .
:type domain_name: string
:param domain_name: 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).
:type multi_az: boolean
:param multi_az: 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`.
)r �MultiAZ�UpdateAvailabilityOptionsr! r" r# r( )r r+ �multi_azr' r r r �update_availability_options� s
�z1CloudSearchConnection.update_availability_optionsc C r0 )a`
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 .
:type domain_name: string
:param domain_name: 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).
:type scaling_parameters: dict
:param scaling_parameters: The desired instance type and desired number
of replicas of each index partition.
r �ScalingParameters�UpdateScalingParametersr! r" r# r3 )r r+ �scaling_parametersr' r r r �update_scaling_parameters� rC z/CloudSearchConnection.update_scaling_parametersc C rD )a�
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`_.
:type domain_name: string
:param domain_name: 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).
:type access_policies: string
:param access_policies: The access rules you want to configure. These
rules replace any existing rules.
)r �AccessPolicies�UpdateServiceAccessPoliciesr! r" r# r( )r r+ �access_policiesr' r r r � update_service_access_policies� rI z4CloudSearchConnection.update_service_access_policiesc C s~ |� � D ]8\}}t|t�r"|� � D ]\}}| �||d | |� qqt|t�r4|r+dp,d|d||f < q||d||f < qdS )a� Serialize a structure.
For example::
param_type = 'structure'
label = 'IndexField'
value = {'IndexFieldName': 'a', 'IntOptions': {'DefaultValue': 5}}
would result in the params dict being updated with these params::
IndexField.IndexFieldName = a
IndexField.IntOptions.DefaultValue = 5
:type params: dict
:param params: The params dict. The complex list params
will be added to this dict.
:type label: str
:param label: String label for param key
:type value: any
:param value: The value to serialize
�.�true�falsez%s.%sN)�items�
isinstance�dictr4 �bool)r r' �label�value�k�v�k2�v2r r r r4 � s
�
�z)CloudSearchConnection.build_complex_paramc
C s� d|d< | j |dd|d�}|�� �d�}tj�|� |jdkr$t�|�S t�|�}|� di �� d d �}| j
� || j �} | |j|j |d
��) N�JSON� ContentTyper! r" r# zutf-8�� �Error�Code)�body)
� make_request�read�decode�boto�log�debug�statusr �loads�get�_faults�
ResponseError�reason)
r r$ r% r& r' �responser� � json_body�
fault_name�exception_classr r r r) s �
�z#CloudSearchConnection._make_request)NN)N).�__name__�
__module__� __qualname__�__doc__�
APIVersionr r r r� r r r r
r r r
r� r r r, r/ r6 r: r> rB rH rK rO rT rX rb rh rk rn rq rs ru rx rz r| r� r� r� r4 r) �
__classcell__r r r r r s`
� !
�
&
�&
�&
�%
!r ) r� � boto.compatr �boto.connectionr �boto.regioninfor �boto.exceptionr �boto.cloudsearch2r r r r r r �<module> s