NAME

Paws::CloudSearch - Perl Interface to AWS Amazon CloudSearch

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CloudSearch');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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.

METHODS

BuildSuggesters(DomainName => Str)

Each argument is described in detail in: Paws::CloudSearch::BuildSuggesters

Returns: a Paws::CloudSearch::BuildSuggestersResponse instance

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

CreateDomain(DomainName => Str)

Each argument is described in detail in: Paws::CloudSearch::CreateDomain

Returns: a Paws::CloudSearch::CreateDomainResponse instance

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

DefineAnalysisScheme(AnalysisScheme => Paws::CloudSearch::AnalysisScheme, DomainName => Str)

Each argument is described in detail in: Paws::CloudSearch::DefineAnalysisScheme

Returns: a Paws::CloudSearch::DefineAnalysisSchemeResponse instance

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

DefineExpression(DomainName => Str, Expression => Paws::CloudSearch::Expression)

Each argument is described in detail in: Paws::CloudSearch::DefineExpression

Returns: a Paws::CloudSearch::DefineExpressionResponse instance

  Configures an C<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 I<Amazon CloudSearch Developer Guide>.

DefineIndexField(DomainName => Str, IndexField => Paws::CloudSearch::IndexField)

Each argument is described in detail in: Paws::CloudSearch::DefineIndexField

Returns: a Paws::CloudSearch::DefineIndexFieldResponse instance

  Configures an C<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 C<IndexFieldType>. If the field exists, the new
configuration replaces the old one. For more information, see
Configuring Index Fields in the I<Amazon CloudSearch Developer Guide>.

DefineSuggester(DomainName => Str, Suggester => Paws::CloudSearch::Suggester)

Each argument is described in detail in: Paws::CloudSearch::DefineSuggester

Returns: a Paws::CloudSearch::DefineSuggesterResponse instance

  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
I<Amazon CloudSearch Developer Guide>.

DeleteAnalysisScheme(AnalysisSchemeName => Str, DomainName => Str)

Each argument is described in detail in: Paws::CloudSearch::DeleteAnalysisScheme

Returns: a Paws::CloudSearch::DeleteAnalysisSchemeResponse instance

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

DeleteDomain(DomainName => Str)

Each argument is described in detail in: Paws::CloudSearch::DeleteDomain

Returns: a Paws::CloudSearch::DeleteDomainResponse instance

  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 I<Amazon CloudSearch Developer Guide>.

DeleteExpression(DomainName => Str, ExpressionName => Str)

Each argument is described in detail in: Paws::CloudSearch::DeleteExpression

Returns: a Paws::CloudSearch::DeleteExpressionResponse instance

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

DeleteIndexField(DomainName => Str, IndexFieldName => Str)

Each argument is described in detail in: Paws::CloudSearch::DeleteIndexField

Returns: a Paws::CloudSearch::DeleteIndexFieldResponse instance

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

DeleteSuggester(DomainName => Str, SuggesterName => Str)

Each argument is described in detail in: Paws::CloudSearch::DeleteSuggester

Returns: a Paws::CloudSearch::DeleteSuggesterResponse instance

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

DescribeAnalysisSchemes(DomainName => Str, [AnalysisSchemeNames => ArrayRef[Str], Deployed => Bool])

Each argument is described in detail in: Paws::CloudSearch::DescribeAnalysisSchemes

Returns: a Paws::CloudSearch::DescribeAnalysisSchemesResponse instance

  Gets the analysis schemes configured for a domain. An analysis scheme
defines language-specific text processing options for a C<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 C<Deployed> option to C<true> to show the active
configuration and exclude pending changes. For more information, see
Configuring Analysis Schemes in the I<Amazon CloudSearch Developer
Guide>.

DescribeAvailabilityOptions(DomainName => Str, [Deployed => Bool])

Each argument is described in detail in: Paws::CloudSearch::DescribeAvailabilityOptions

Returns: a Paws::CloudSearch::DescribeAvailabilityOptionsResponse instance

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

DescribeDomains([DomainNames => ArrayRef[Str]])

Each argument is described in detail in: Paws::CloudSearch::DescribeDomains

Returns: a Paws::CloudSearch::DescribeDomainsResponse instance

  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
C<matchall> request to your domain's search endpoint:
C<q=matchall&amp;q.parser=structured&amp;size=0>. For more information,
see Getting Information about a Search Domain in the I<Amazon
CloudSearch Developer Guide>.

DescribeExpressions(DomainName => Str, [Deployed => Bool, ExpressionNames => ArrayRef[Str]])

Each argument is described in detail in: Paws::CloudSearch::DescribeExpressions

Returns: a Paws::CloudSearch::DescribeExpressionsResponse instance

  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 C<Deployed>
option to C<true> to show the active configuration and exclude pending
changes. For more information, see Configuring Expressions in the
I<Amazon CloudSearch Developer Guide>.

DescribeIndexFields(DomainName => Str, [Deployed => Bool, FieldNames => ArrayRef[Str]])

Each argument is described in detail in: Paws::CloudSearch::DescribeIndexFields

Returns: a Paws::CloudSearch::DescribeIndexFieldsResponse instance

  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 C<Deployed> option to C<true> to show the active configuration and
exclude pending changes. For more information, see Getting Domain
Information in the I<Amazon CloudSearch Developer Guide>.

DescribeScalingParameters(DomainName => Str)

Each argument is described in detail in: Paws::CloudSearch::DescribeScalingParameters

Returns: a Paws::CloudSearch::DescribeScalingParametersResponse instance

  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
I<Amazon CloudSearch Developer Guide>.

DescribeServiceAccessPolicies(DomainName => Str, [Deployed => Bool])

Each argument is described in detail in: Paws::CloudSearch::DescribeServiceAccessPolicies

Returns: a Paws::CloudSearch::DescribeServiceAccessPoliciesResponse instance

  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 C<Deployed> option to
C<true> to show the active configuration and exclude pending changes.
For more information, see Configuring Access for a Search Domain in the
I<Amazon CloudSearch Developer Guide>.

DescribeSuggesters(DomainName => Str, [Deployed => Bool, SuggesterNames => ArrayRef[Str]])

Each argument is described in detail in: Paws::CloudSearch::DescribeSuggesters

Returns: a Paws::CloudSearch::DescribeSuggestersResponse instance

  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 C<Deployed> option to C<true> to show the active configuration and
exclude pending changes. For more information, see Getting Search
Suggestions in the I<Amazon CloudSearch Developer Guide>.

IndexDocuments(DomainName => Str)

Each argument is described in detail in: Paws::CloudSearch::IndexDocuments

Returns: a Paws::CloudSearch::IndexDocumentsResponse instance

  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 C<RequiresIndexDocuments>.

ListDomainNames( => )

Each argument is described in detail in: Paws::CloudSearch::ListDomainNames

Returns: a Paws::CloudSearch::ListDomainNamesResponse instance

  Lists all search domains owned by an account.

UpdateAvailabilityOptions(DomainName => Str, MultiAZ => Bool)

Each argument is described in detail in: Paws::CloudSearch::UpdateAvailabilityOptions

Returns: a Paws::CloudSearch::UpdateAvailabilityOptionsResponse instance

  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 I<Amazon CloudSearch Developer
Guide>.

UpdateScalingParameters(DomainName => Str, ScalingParameters => Paws::CloudSearch::ScalingParameters)

Each argument is described in detail in: Paws::CloudSearch::UpdateScalingParameters

Returns: a Paws::CloudSearch::UpdateScalingParametersResponse instance

  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 I<Amazon
CloudSearch Developer Guide>.

UpdateServiceAccessPolicies(AccessPolicies => Str, DomainName => Str)

Each argument is described in detail in: Paws::CloudSearch::UpdateServiceAccessPolicies

Returns: a Paws::CloudSearch::UpdateServiceAccessPoliciesResponse instance

  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

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues