create_workspace_page ¶

def create_workspace_page(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    workspace_id: "capo_connect.types.workspace_id.WorkspaceId",
    resource_arn: "capo_connect.types.arn.ARN",
    page: "capo_connect.types.page.Page",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    slug: Optional["capo_connect.types.slug.Slug"] = None,
    input_data: Optional["capo_connect.types.input_data.InputData"] = None,
) -> (
    "capo_connect.types.create_workspace_page_response.CreateWorkspacePageResponse"
):
    """<p>Associates a view with a page in a workspace, defining what users see when they navigate to that page.</p>

    Args:
        instance_id: <p>The identifier of the Amazon Connect 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>
        workspace_id: <p>The identifier of the workspace.</p>
        resource_arn: <p>The Amazon Resource Name (ARN) of the view to associate with the page.</p>
        page: <p>The page identifier. Valid system pages include <code>HOME</code> and <code>AGENT_EXPERIENCE</code>. Custom pages cannot use the <code>aws:</code> or <code>connect:</code> prefixes.</p>
        slug: <p>The URL-friendly identifier for the page.</p>
        input_data: <p>A JSON string containing input parameters for the view, validated against the view's input schema.</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.limit_exceeded_exception.LimitExceededException: <p>The allowed limit for the resource has been exceeded.</p>
        capo_connect.errors.resource_conflict_exception.ResourceConflictException: <p>A resource already has that name.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The service quota has been exceeded.</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.create_workspace_page_request.CreateWorkspacePageRequest]",
    ) -> OperationResponse[
        "capo_connect.types.create_workspace_page_response.CreateWorkspacePageResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.create_workspace_page

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateWorkspacePage")
    )
    input_: capo_connect.types.create_workspace_page_request.CreateWorkspacePageRequest = {
        "instance_id": instance_id,
        "workspace_id": workspace_id,
        "resource_arn": resource_arn,
        "page": page,
    }
    if slug is not None:
        input_["slug"] = slug
    if input_data is not None:
        input_["input_data"] = input_data

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