list_contact_references ¶

def list_contact_references(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    contact_id: "capo_connect.types.contact_id.ContactId",
    reference_types: "capo_connect.types.reference_types.ReferenceTypes",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    next_token: Optional["capo_connect.types.next_token.NextToken"] = None,
) -> "capo_connect.types.list_contact_references_response.ListContactReferencesResponse":
    """<p>This API is in preview release for Connect Customer and is subject to change.</p> <p>For the specified <code>referenceTypes</code>, returns a list of references associated with the contact. <i>References</i> are links to documents that are related to a contact, such as emails, attachments, or URLs.</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>
        contact_id: <p>The identifier of the initial contact.</p>
        reference_types: <p>The type of reference.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p> <important> <p>This is not expected to be set, because the value returned in the previous response is always null.</p> </important>

    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.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.list_contact_references_request.ListContactReferencesRequest]",
    ) -> OperationResponse[
        "capo_connect.types.list_contact_references_response.ListContactReferencesResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_contact_references

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListContactReferences")
    )
    input_: capo_connect.types.list_contact_references_request.ListContactReferencesRequest = {
        "instance_id": instance_id,
        "contact_id": contact_id,
        "reference_types": reference_types,
    }
    if next_token is not None:
        input_["next_token"] = next_token

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