update_experience ¶

def update_experience(
    self,
    id: "capo_kendra.types.experience_id.ExperienceId",
    index_id: "capo_kendra.types.index_id.IndexId",
    *,
    config_overrides: Optional[kendraClientConfig] = None,
    name: Optional["capo_kendra.types.experience_name.ExperienceName"] = None,
    role_arn: Optional["capo_kendra.types.role_arn.RoleArn"] = None,
    configuration: Optional[
        "capo_kendra.types.experience_configuration.ExperienceConfiguration"
    ] = None,
    description: Optional["capo_kendra.types.description.Description"] = None,
) -> None:
    """<p>Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>.</p>

    Args:
        id: <p>The identifier of your Amazon Kendra experience you want to update.</p>
        name: <p>A new name for your Amazon Kendra experience.</p>
        index_id: <p>The identifier of the index for your Amazon Kendra experience.</p>
        role_arn: <p>The Amazon Resource Name (ARN) of an IAM role with permission to access the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code> API, and IAM Identity Center that stores your users and groups information. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
        configuration: <p>Configuration information you want to update for your Amazon Kendra experience.</p>
        description: <p>A new description for your Amazon Kendra experience.</p>

    Raises:
        capo_kendra.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
        capo_kendra.errors.conflict_exception.ConflictException: <p>A conflict occurred with the request. Please fix any inconsistences with your resources and try again.</p>
        capo_kendra.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_kendra.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.</p>
        capo_kendra.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
        capo_kendra.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.</p>
        capo_kendra.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kendra.types.update_experience_request.UpdateExperienceRequest]",
    ) -> OperationResponse[None]:
        import capo_kendra._operations.aws_kendra_frontend_service.update_experience

        output, http_response = (
            capo_kendra._operations.aws_kendra_frontend_service.update_experience.update_experience(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateExperience")
    )
    input_: capo_kendra.types.update_experience_request.UpdateExperienceRequest = {
        "id": id,
        "index_id": index_id,
    }
    if name is not None:
        input_["name"] = name
    if role_arn is not None:
        input_["role_arn"] = role_arn
    if configuration is not None:
        input_["configuration"] = configuration
    if description is not None:
        input_["description"] = description

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