update_field ¶

def update_field(
    self,
    domain_id: "capo_connectcases.types.domain_id.DomainId",
    field_id: "capo_connectcases.types.field_id.FieldId",
    *,
    config_overrides: Optional[ConnectCasesClientConfig] = None,
    name: Optional["capo_connectcases.types.field_name.FieldName"] = None,
    description: Optional[
        "capo_connectcases.types.field_description.FieldDescription"
    ] = None,
    attributes: Optional[
        "capo_connectcases.types.field_attributes.FieldAttributes"
    ] = None,
) -> "capo_connectcases.types.update_field_response.UpdateFieldResponse":
    """<p>Updates the properties of an existing field. </p>

    Args:
        domain_id: <p>The unique identifier of the Cases domain. </p>
        field_id: <p>The unique identifier of a field.</p>
        name: <p>The name of the field.</p>
        description: <p>The description of a field.</p>
        attributes: <p>Union of field attributes.</p>

    Raises:
        capo_connectcases.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_connectcases.errors.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
        capo_connectcases.errors.internal_server_exception.InternalServerException: <p>We couldn't process your request because of an issue with the server. Try again later.</p>
        capo_connectcases.errors.resource_not_found_exception.ResourceNotFoundException: <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
        capo_connectcases.errors.throttling_exception.ThrottlingException: <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
        capo_connectcases.errors.validation_exception.ValidationException: <p>The request isn't valid. Check the syntax and try again.</p>
        capo_connectcases.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connectcases.types.update_field_request.UpdateFieldRequest]",
    ) -> OperationResponse[
        "capo_connectcases.types.update_field_response.UpdateFieldResponse"
    ]:
        import capo_connectcases._operations.amazon_connect_cases.update_field

        output, http_response = (
            capo_connectcases._operations.amazon_connect_cases.update_field.update_field(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateField")
    )
    input_: capo_connectcases.types.update_field_request.UpdateFieldRequest = {
        "domain_id": domain_id,
        "field_id": field_id,
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if attributes is not None:
        input_["attributes"] = attributes

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