Skip to content

describe_view

describe_view(
    view_token: ViewToken,
    connection_token: ParticipantToken,
    *,
    config_overrides: Optional[ConnectParticipantClientConfig] = None,
) -> DescribeViewResponse

Retrieves the view for the specified view token.

For security recommendations, see Connect Customer Chat security best practices.

Parameters:

  • view_token (ViewToken) –

    An encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.

  • connection_token (ParticipantToken) –

    The connection token.

Raises:

Source code in docs_src/capo_connectparticipant/_services/connect_participant.py
def describe_view(
    self,
    view_token: "capo_connectparticipant.types.view_token.ViewToken",
    connection_token: "capo_connectparticipant.types.participant_token.ParticipantToken",
    *,
    config_overrides: Optional[ConnectParticipantClientConfig] = None,
) -> "capo_connectparticipant.types.describe_view_response.DescribeViewResponse":
    """<p>Retrieves the view for the specified view token.</p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Connect Customer Chat security best practices</a>. </p>

    Args:
        view_token: <p>An encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.</p>
        connection_token: <p>The connection token.</p>

    Raises:
        capo_connectparticipant.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_connectparticipant.errors.internal_server_exception.InternalServerException: <p>This exception occurs when there is an internal failure in the Amazon Connect service.</p>
        capo_connectparticipant.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource was not found.</p>
        capo_connectparticipant.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_connectparticipant.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by Amazon Connect.</p>
        capo_connectparticipant.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connectparticipant.types.describe_view_request.DescribeViewRequest]",
    ) -> OperationResponse[
        "capo_connectparticipant.types.describe_view_response.DescribeViewResponse"
    ]:
        import capo_connectparticipant._operations.amazon_connect_participant_service_lambda.describe_view

        output, http_response = (
            capo_connectparticipant._operations.amazon_connect_participant_service_lambda.describe_view.describe_view(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_connectparticipant.types.describe_view_response.DescribeViewResponse",
    ) -> dict[str, Any]:
        import capo_connectparticipant.types.describe_view_response

        return (
            capo_connectparticipant.types.describe_view_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeView", redact_output=_redact_output),
    )
    input_: capo_connectparticipant.types.describe_view_request.DescribeViewRequest = {
        "view_token": view_token,
        "connection_token": connection_token,
    }

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