Skip to content

delete_index_field 

delete_index_field(
    domain_name: DomainName,
    index_field_name: DynamicFieldName,
    *,
    config_overrides: Optional[CloudSearchClientConfig] = None,
) -> DeleteIndexFieldResponse

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

Parameters:

  • index_field_name (DynamicFieldName) –

    The name of the index field your want to remove from the domain's indexing options.

Raises:

Source code in docs_src/capo_cloudsearch/_services/cloud_search.py 
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
def delete_index_field(
    self,
    domain_name: "capo_cloudsearch.types.domain_name.DomainName",
    index_field_name: "capo_cloudsearch.types.dynamic_field_name.DynamicFieldName",
    *,
    config_overrides: Optional[CloudSearchClientConfig] = None,
) -> "capo_cloudsearch.types.delete_index_field_response.DeleteIndexFieldResponse":
    """<p>Removes an <code><a>IndexField</a></code> from the search domain. 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>

    Args:
        index_field_name: <p>The name of the index field your want to remove from the domain's indexing options.</p>

    Raises:
        capo_cloudsearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_cloudsearch.errors.internal_exception.InternalException: <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>
        capo_cloudsearch.errors.invalid_type_exception.InvalidTypeException: <p>The request was rejected because it specified an invalid type definition.</p>
        capo_cloudsearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because it attempted to reference a resource that does not exist.</p>
        capo_cloudsearch.errors.validation_exception.ValidationException: <p>The request was rejected because it has invalid parameters.</p>
        capo_cloudsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudsearch.types.delete_index_field_request.DeleteIndexFieldRequest]",
    ) -> OperationResponse[
        "capo_cloudsearch.types.delete_index_field_response.DeleteIndexFieldResponse"
    ]:
        import capo_cloudsearch._operations.a9_search_cloud_config_service2013.delete_index_field

        output, http_response = (
            capo_cloudsearch._operations.a9_search_cloud_config_service2013.delete_index_field.delete_index_field(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIndexField")
    )
    input_: capo_cloudsearch.types.delete_index_field_request.DeleteIndexFieldRequest = {
        "domain_name": domain_name,
        "index_field_name": index_field_name,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output