AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 

Classes

NameDescription
Class AccessPoliciesStatus A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.
Class AvailabilityOptionsStatus The status and configuration of the domain's availability options.
Class BaseException CloudSearch exception
Class CreateDomainRequest Container for the parameters to the CreateDomain operation. Creates a new search domain.
Class CreateDomainResponse Configuration for accessing Amazon CreateDomain service
Class CreateDomainResult A response message that contains the status of a newly created domain.
Class DefaultSearchFieldStatus The value of the DefaultSearchField configured for this search domain and its current status.
Class DefineIndexFieldRequest Container for the parameters to the DefineIndexField operation. Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.
Class DefineIndexFieldResponse Configuration for accessing Amazon DefineIndexField service
Class DefineIndexFieldResult A response message that contains the status of an updated index field.
Class DefineRankExpressionRequest Container for the parameters to the DefineRankExpression operation. Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.
Class DefineRankExpressionResponse Configuration for accessing Amazon DefineRankExpression service
Class DefineRankExpressionResult A response message that contains the status of an updated RankExpression.
Class DeleteDomainRequest Container for the parameters to the DeleteDomain operation. Permanently deletes a search domain and all of its data.
Class DeleteDomainResponse Configuration for accessing Amazon DeleteDomain service
Class DeleteDomainResult A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.
Class DeleteIndexFieldRequest Container for the parameters to the DeleteIndexField operation. Removes an IndexField from the search domain.
Class DeleteIndexFieldResponse Configuration for accessing Amazon DeleteIndexField service
Class DeleteIndexFieldResult A response message that contains the status of a deleted index field.
Class DeleteRankExpressionRequest Container for the parameters to the DeleteRankExpression operation. Removes a RankExpression from the search domain.
Class DeleteRankExpressionResponse Configuration for accessing Amazon DeleteRankExpression service
Class DeleteRankExpressionResult A response message that contains the status of a deleted RankExpression.
Class DescribeAvailabilityOptionsRequest Container for the parameters to the DescribeAvailabilityOptions operation. 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.
Class DescribeAvailabilityOptionsResponse Configuration for accessing Amazon DescribeAvailabilityOptions service
Class DescribeAvailabilityOptionsResult The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.
Class DescribeDefaultSearchFieldRequest Container for the parameters to the DescribeDefaultSearchField operation. Gets the default search field configured for the search domain.
Class DescribeDefaultSearchFieldResponse Configuration for accessing Amazon DescribeDefaultSearchField service
Class DescribeDefaultSearchFieldResult A response message that contains the default search field for a search domain.
Class DescribeDomainsRequest Container for the parameters to the DescribeDomains operation. Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.
Class DescribeDomainsResponse Configuration for accessing Amazon DescribeDomains service
Class DescribeDomainsResult A response message that contains the status of one or more domains.
Class DescribeIndexFieldsRequest Container for the parameters to the DescribeIndexFields operation. Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.
Class DescribeIndexFieldsResponse Configuration for accessing Amazon DescribeIndexFields service
Class DescribeIndexFieldsResult A response message that contains the index fields for a search domain.
Class DescribeRankExpressionsRequest Container for the parameters to the DescribeRankExpressions operation. Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.
Class DescribeRankExpressionsResponse Configuration for accessing Amazon DescribeRankExpressions service
Class DescribeRankExpressionsResult A response message that contains the rank expressions for a search domain.
Class DescribeServiceAccessPoliciesRequest Container for the parameters to the DescribeServiceAccessPolicies operation. Gets information about the resource-based policies that control access to the domain's document and search services.
Class DescribeServiceAccessPoliciesResponse Configuration for accessing Amazon DescribeServiceAccessPolicies service
Class DescribeServiceAccessPoliciesResult A response message that contains the access policies for a domain.
Class DescribeStemmingOptionsRequest Container for the parameters to the DescribeStemmingOptions operation. Gets the stemming dictionary configured for the search domain.
Class DescribeStemmingOptionsResponse Configuration for accessing Amazon DescribeStemmingOptions service
Class DescribeStemmingOptionsResult A response message that contains the stemming options for a search domain.
Class DescribeStopwordOptionsRequest Container for the parameters to the DescribeStopwordOptions operation. Gets the stopwords configured for the search domain.
Class DescribeStopwordOptionsResponse Configuration for accessing Amazon DescribeStopwordOptions service
Class DescribeStopwordOptionsResult A response message that contains the stopword options for a search domain.
Class DescribeSynonymOptionsRequest Container for the parameters to the DescribeSynonymOptions operation. Gets the synonym dictionary configured for the search domain.
Class DescribeSynonymOptionsResponse Configuration for accessing Amazon DescribeSynonymOptions service
Class DescribeSynonymOptionsResult A response message that contains the synonym options for a search domain.
Class DisabledOperationException CloudSearch exception
Class DomainStatus The current status of the search domain.
Class IndexDocumentsRequest Container for the parameters to the IndexDocuments operation. Tells the search domain to start indexing its documents using the latest text processing options and IndexFields. This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.
Class IndexDocumentsResponse Configuration for accessing Amazon IndexDocuments service
Class IndexDocumentsResult The result of an IndexDocuments action.
Class IndexField Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.
Class IndexFieldStatus The value of an IndexField and its current status.
Class InternalException CloudSearch exception
Class InvalidTypeException CloudSearch exception
Class LimitExceededException CloudSearch exception
Class LiteralOptions Options that define a literal field in the search index.
Class NamedRankExpression A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.
Class OptionStatus The status of an option, including when it was last updated and whether it is actively in use for searches.
Class RankExpressionStatus The value of a RankExpression and its current status.
Class ResourceNotFoundException CloudSearch exception
Class ServiceEndpoint The endpoint to which service requests can be submitted, including the actual URL prefix for sending requests and the Amazon Resource Name (ARN) so the endpoint can be referenced in other API calls such as UpdateServiceAccessPolicies.
Class SourceAttribute Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.
Class SourceData The source attribute name and an optional default value to use if a document doesn't have an attribute of that name.
Class SourceDataMap Specifies how to map source attribute values to custom values when populating an IndexField.
Class SourceDataTrimTitle Specifies how to trim common words from the beginning of a field to enable title sorting by that field.
Class StemmingOptionsStatus The stemming options configured for this search domain and the current status of those options.
Class StopwordOptionsStatus The stopword options configured for this search domain and the current status of those options.
Class SynonymOptionsStatus The synonym options configured for this search domain and the current status of those options.
Class TextOptions Options that define a text field in the search index.
Class UIntOptions Options that define a uint field in the search index.
Class UpdateAvailabilityOptionsRequest Container for the parameters to the UpdateAvailabilityOptions operation. 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.
Class UpdateAvailabilityOptionsResponse Configuration for accessing Amazon UpdateAvailabilityOptions service
Class UpdateAvailabilityOptionsResult The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.
Class UpdateDefaultSearchFieldRequest Container for the parameters to the UpdateDefaultSearchField operation. Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.
Class UpdateDefaultSearchFieldResponse Configuration for accessing Amazon UpdateDefaultSearchField service
Class UpdateDefaultSearchFieldResult A response message that contains the status of an updated default search field.
Class UpdateServiceAccessPoliciesRequest Container for the parameters to the UpdateServiceAccessPolicies operation. Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB.
Class UpdateServiceAccessPoliciesResponse Configuration for accessing Amazon UpdateServiceAccessPolicies service
Class UpdateServiceAccessPoliciesResult A response message that contains the status of updated access policies.
Class UpdateStemmingOptionsRequest Container for the parameters to the UpdateStemmingOptions operation. Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB.
Class UpdateStemmingOptionsResponse Configuration for accessing Amazon UpdateStemmingOptions service
Class UpdateStemmingOptionsResult A response message that contains the status of updated stemming options.
Class UpdateStopwordOptionsRequest Container for the parameters to the UpdateStopwordOptions operation. Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB.
Class UpdateStopwordOptionsResponse Configuration for accessing Amazon UpdateStopwordOptions service
Class UpdateStopwordOptionsResult A response message that contains the status of updated stopword options.
Class UpdateSynonymOptionsRequest Container for the parameters to the UpdateSynonymOptions operation. Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB.
Class UpdateSynonymOptionsResponse Configuration for accessing Amazon UpdateSynonymOptions service
Class UpdateSynonymOptionsResult A response message that contains the status of updated synonym options.