update_view_metadata ¶

def update_view_metadata(
    self,
    instance_id: "capo_connect.types.views_instance_id.ViewsInstanceId",
    view_id: "capo_connect.types.view_id.ViewId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    name: Optional["capo_connect.types.view_name.ViewName"] = None,
    description: Optional[
        "capo_connect.types.view_description.ViewDescription"
    ] = None,
) -> "capo_connect.types.update_view_metadata_response.UpdateViewMetadataResponse":
    """<p>Updates the view metadata. Note that either <code>Name</code> or <code>Description</code> must be provided.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.</p>
        view_id: <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>
        name: <p>The name of the view.</p>
        description: <p>The description of the view.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.duplicate_resource_exception.DuplicateResourceException: <p>A resource with the specified name already exists.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_in_use_exception.ResourceInUseException: <p>That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.too_many_requests_exception.TooManyRequestsException: <p>Displayed when rate-related API limits are exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.update_view_metadata_request.UpdateViewMetadataRequest]",
    ) -> OperationResponse[
        "capo_connect.types.update_view_metadata_response.UpdateViewMetadataResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.update_view_metadata

        output, http_response = (
            capo_connect._operations.amazon_connect_service.update_view_metadata.update_view_metadata(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_connect.types.update_view_metadata_request.UpdateViewMetadataRequest",
    ) -> dict[str, Any]:
        import capo_connect.types.update_view_metadata_request

        return capo_connect.types.update_view_metadata_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateViewMetadata", redact_input=_redact_input),
    )
    input_: capo_connect.types.update_view_metadata_request.UpdateViewMetadataRequest = {
        "instance_id": instance_id,
        "view_id": view_id,
    }
    if name is not None:
        input_["name"] = name
    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