pause_contact `async` ¶

pause_contact(
    contact_id: ContactId,
    instance_id: InstanceId,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    contact_flow_id: Optional[ContactFlowId] = None,
) -> PauseContactResponse

Allows pausing an ongoing task contact.

Parameters:

contact_id (ContactId) –

The identifier of the contact.
instance_id (InstanceId) –

The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.
contact_flow_id (Optional[ContactFlowId], default: None ) –

The identifier of the flow.

Raises:

AccessDeniedException –

You do not have sufficient permissions to perform this action.
ConflictException –

Operation cannot be performed at this time as there is a conflict with another operation or contact state.
InternalServiceException –

Request processing failed because of an error or failure with the service.
InvalidParameterException –

One or more of the specified parameters are not valid.
InvalidRequestException –

The request is not valid.
LimitExceededException –

The allowed limit for the resource has been exceeded.
ResourceNotFoundException –

The specified resource was not found.
ThrottlingException –

The throttling limit has been exceeded.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_connect/_services/async_connect.py

async def pause_contact(
    self,
    contact_id: "capo_connect.types.contact_id.ContactId",
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    contact_flow_id: Optional[
        "capo_connect.types.contact_flow_id.ContactFlowId"
    ] = None,
) -> "capo_connect.types.pause_contact_response.PauseContactResponse":
    """<p>Allows pausing an ongoing task contact.</p>

    Args:
        contact_id: <p>The identifier of the contact.</p>
        instance_id: <p>The identifier of the Connect Customer instance. You can find the <code>instanceId</code> in the ARN of the instance.</p>
        contact_flow_id: <p>The identifier of the flow.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.conflict_exception.ConflictException: <p>Operation cannot be performed at this time as there is a conflict with another operation or contact state.</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.limit_exceeded_exception.LimitExceededException: <p>The allowed limit for the resource has been exceeded.</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.pause_contact_request.PauseContactRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.pause_contact_response.PauseContactResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.pause_contact

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PauseContact")
    )
    input_: capo_connect.types.pause_contact_request.PauseContactRequest = {
        "contact_id": contact_id,
        "instance_id": instance_id,
    }
    if contact_flow_id is not None:
        input_["contact_flow_id"] = contact_flow_id

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

pause_contact async ¶

pause_contact `async` ¶