Skip to content

update_quick_connect_name async

update_quick_connect_name(
    instance_id: InstanceId,
    quick_connect_id: QuickConnectId,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    name: Optional[QuickConnectName] = None,
    description: Optional[UpdateQuickConnectDescription] = None,
) -> None

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

Parameters:

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def update_quick_connect_name(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    quick_connect_id: "capo_connect.types.quick_connect_id.QuickConnectId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    name: Optional["capo_connect.types.quick_connect_name.QuickConnectName"] = None,
    description: Optional[
        "capo_connect.types.update_quick_connect_description.UpdateQuickConnectDescription"
    ] = None,
) -> None:
    """<p>Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least <code>Name</code> or <code>Description</code> must be provided.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        quick_connect_id: <p>The identifier for the quick connect.</p>
        name: <p>The name of the quick connect.</p>
        description: <p>The description of the quick connect.</p>

    Raises:
        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_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.update_quick_connect_name_request.UpdateQuickConnectNameRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_connect._operations.amazon_connect_service.update_quick_connect_name

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.update_quick_connect_name.async_update_quick_connect_name(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateQuickConnectName")
    )
    input_: capo_connect.types.update_quick_connect_name_request.UpdateQuickConnectNameRequest = {
        "instance_id": instance_id,
        "quick_connect_id": quick_connect_id,
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output