Learn more  » Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Bower components Debian packages RPM packages NuGet packages

squarecapadmin / botocore   python

Repository URL to install this package:

/ botocore / data / cloudsearch / 2013-01-01 / service-2.json

{
  "version":"2.0",
  "metadata":{
    "apiVersion":"2013-01-01",
    "endpointPrefix":"cloudsearch",
    "serviceFullName":"Amazon CloudSearch",
    "signatureVersion":"v4",
    "xmlNamespace":"http://cloudsearch.amazonaws.com/doc/2013-01-01/",
    "protocol":"query",
    "uid":"cloudsearch-2013-01-01"
  },
  "documentation":"<fullname>Amazon CloudSearch Configuration Service</fullname> <p>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.</p> <p>The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region\" target=\"_blank\">Regions and Endpoints</a>.</p>",
  "operations":{
    "BuildSuggesters":{
      "name":"BuildSuggesters",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{
        "shape":"BuildSuggestersRequest",
        "documentation":"<p>Container for the parameters to the <code><a>BuildSuggester</a></code> operation. Specifies the name of the domain you want to update.</p>"
      },
      "output":{
        "shape":"BuildSuggestersResponse",
        "documentation":"<p>The result of a <code>BuildSuggester</code> request. Contains a list of the fields used for suggestions.</p>",
        "resultWrapper":"BuildSuggestersResult"
      },
      "errors":[
        {
          "shape":"BaseException",
          "exception":true,
          "documentation":"<p>An error occurred while processing the request.</p>"
        },
        {
          "shape":"InternalException",
          "error":{
            "code":"InternalException",
            "httpStatusCode":500
          },
          "exception":true,
          "documentation":"<p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href=\"http://status.aws.amazon.com/\" target=\"_blank\">Service Health Dashboard</a>.</p>"
        },
        {
          "shape":"ResourceNotFoundException",
          "error":{
            "code":"ResourceNotFound",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because it attempted to reference a resource that does not exist.</p>"
        }
      ],
      "documentation":"<p>Indexes the search suggestions. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters\">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
    },
    "CreateDomain":{
      "name":"CreateDomain",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{
        "shape":"CreateDomainRequest",
        "documentation":"<p>Container for the parameters to the <code><a>CreateDomain</a></code> operation. Specifies a name for the new search domain.</p>"
      },
      "output":{
        "shape":"CreateDomainResponse",
        "documentation":"<p>The result of a <code>CreateDomainRequest</code>. Contains the status of a newly created domain.</p>",
        "resultWrapper":"CreateDomainResult"
      },
      "errors":[
        {
          "shape":"BaseException",
          "exception":true,
          "documentation":"<p>An error occurred while processing the request.</p>"
        },
        {
          "shape":"InternalException",
          "error":{
            "code":"InternalException",
            "httpStatusCode":500
          },
          "exception":true,
          "documentation":"<p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href=\"http://status.aws.amazon.com/\" target=\"_blank\">Service Health Dashboard</a>.</p>"
        },
        {
          "shape":"LimitExceededException",
          "error":{
            "code":"LimitExceeded",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because a resource limit has already been met.</p>"
        }
      ],
      "documentation":"<p>Creates a new search domain. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html\" target=\"_blank\">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
    },
    "DefineAnalysisScheme":{
      "name":"DefineAnalysisScheme",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{
        "shape":"DefineAnalysisSchemeRequest",
        "documentation":"<p>Container for the parameters to the <code><a>DefineAnalysisScheme</a></code> operation. Specifies the name of the domain you want to update and the analysis scheme configuration.</p>"
      },
      "output":{
        "shape":"DefineAnalysisSchemeResponse",
        "documentation":"<p>The result of a <code><a>DefineAnalysisScheme</a></code> request. Contains the status of the newly-configured analysis scheme.</p>",
        "resultWrapper":"DefineAnalysisSchemeResult"
      },
      "errors":[
        {
          "shape":"BaseException",
          "exception":true,
          "documentation":"<p>An error occurred while processing the request.</p>"
        },
        {
          "shape":"InternalException",
          "error":{
            "code":"InternalException",
            "httpStatusCode":500
          },
          "exception":true,
          "documentation":"<p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href=\"http://status.aws.amazon.com/\" target=\"_blank\">Service Health Dashboard</a>.</p>"
        },
        {
          "shape":"LimitExceededException",
          "error":{
            "code":"LimitExceeded",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because a resource limit has already been met.</p>"
        },
        {
          "shape":"InvalidTypeException",
          "error":{
            "code":"InvalidType",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because it specified an invalid type definition.</p>"
        },
        {
          "shape":"ResourceNotFoundException",
          "error":{
            "code":"ResourceNotFound",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because it attempted to reference a resource that does not exist.</p>"
        }
      ],
      "documentation":"<p>Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html\" target=\"_blank\">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
    },
    "DefineExpression":{
      "name":"DefineExpression",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{
        "shape":"DefineExpressionRequest",
        "documentation":"<p>Container for the parameters to the <code><a>DefineExpression</a></code> operation. Specifies the name of the domain you want to update and the expression you want to configure.</p>"
      },
      "output":{
        "shape":"DefineExpressionResponse",
        "documentation":"<p>The result of a <code>DefineExpression</code> request. Contains the status of the newly-configured expression.</p>",
        "resultWrapper":"DefineExpressionResult"
      },
      "errors":[
        {
          "shape":"BaseException",
          "exception":true,
          "documentation":"<p>An error occurred while processing the request.</p>"
        },
        {
          "shape":"InternalException",
          "error":{
            "code":"InternalException",
            "httpStatusCode":500
          },
          "exception":true,
          "documentation":"<p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href=\"http://status.aws.amazon.com/\" target=\"_blank\">Service Health Dashboard</a>.</p>"
        },
        {
          "shape":"LimitExceededException",
          "error":{
            "code":"LimitExceeded",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because a resource limit has already been met.</p>"
        },
        {
          "shape":"InvalidTypeException",
          "error":{
            "code":"InvalidType",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because it specified an invalid type definition.</p>"
        },
        {
          "shape":"ResourceNotFoundException",
          "error":{
            "code":"ResourceNotFound",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because it attempted to reference a resource that does not exist.</p>"
        }
      ],
      "documentation":"<p>Configures an <code><a>Expression</a></code> 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 <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html\" target=\"_blank\">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
    },
    "DefineIndexField":{
      "name":"DefineIndexField",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{
        "shape":"DefineIndexFieldRequest",
        "documentation":"<p>Container for the parameters to the <code><a>DefineIndexField</a></code> operation. Specifies the name of the domain you want to update and the index field configuration.</p>"
      },
      "output":{
        "shape":"DefineIndexFieldResponse",
        "documentation":"<p>The result of a <code><a>DefineIndexField</a></code> request. Contains the status of the newly-configured index field.</p>",
        "resultWrapper":"DefineIndexFieldResult"
      },
      "errors":[
        {
          "shape":"BaseException",
          "exception":true,
          "documentation":"<p>An error occurred while processing the request.</p>"
        },
        {
          "shape":"InternalException",
          "error":{
            "code":"InternalException",
            "httpStatusCode":500
          },
          "exception":true,
          "documentation":"<p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href=\"http://status.aws.amazon.com/\" target=\"_blank\">Service Health Dashboard</a>.</p>"
        },
        {
          "shape":"LimitExceededException",
          "error":{
            "code":"LimitExceeded",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because a resource limit has already been met.</p>"
        },
        {
          "shape":"InvalidTypeException",
          "error":{
            "code":"InvalidType",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because it specified an invalid type definition.</p>"
        },
        {
          "shape":"ResourceNotFoundException",
          "error":{
            "code":"ResourceNotFound",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because it attempted to reference a resource that does not exist.</p>"
        }
      ],
      "documentation":"<p>Configures an <code><a>IndexField</a></code> 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 <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html\" target=\"_blank\">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>"
    },
    "DefineSuggester":{
      "name":"DefineSuggester",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{
        "shape":"DefineSuggesterRequest",
        "documentation":"<p>Container for the parameters to the <code><a>DefineSuggester</a></code> operation. Specifies the name of the domain you want to update and the suggester configuration.</p>"
      },
      "output":{
        "shape":"DefineSuggesterResponse",
        "documentation":"<p>The result of a <code>DefineSuggester</code> request. Contains the status of the newly-configured suggester.</p>",
        "resultWrapper":"DefineSuggesterResult"
      },
      "errors":[
        {
          "shape":"BaseException",
          "exception":true,
          "documentation":"<p>An error occurred while processing the request.</p>"
        },
        {
          "shape":"InternalException",
          "error":{
            "code":"InternalException",
            "httpStatusCode":500
          },
          "exception":true,
          "documentation":"<p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href=\"http://status.aws.amazon.com/\" target=\"_blank\">Service Health Dashboard</a>.</p>"
        },
        {
          "shape":"LimitExceededException",
          "error":{
            "code":"LimitExceeded",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because a resource limit has already been met.</p>"
        },
        {
          "shape":"InvalidTypeException",
          "error":{
            "code":"InvalidType",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"<p>The request was rejected because it specified an invalid type definition.</p>"
        },
        {
          "shape":"ResourceNotFoundException",
          "error":{
            "code":"ResourceNotFound",
            "httpStatusCode":409,
            "senderFault":true
          },
Loading ...